Update deployment

Path Parameters

deployment

string

required

Deployment identifier

Body

application/json

Option 1
Option 2

uri

string

required

Uri to use to discover/invoke the http deployment.

additional_headers

Additional headers · object

Additional headers added to the discover/invoke requests to the deployment.

Show child attributes

additional_headers.{key}

string

use_http_11

boolean

default:false

If true, discovery will be attempted using a client that defaults to HTTP1.1 instead of a prior-knowledge HTTP2 client. HTTP2 may still be used for TLS servers that advertise HTTP2 support via ALPN. HTTP1.1 deployments will only work in request-response mode.

dry_run

boolean

default:false

If true, discovery will run but the deployment will not be registered. This is useful to see the impact of a new deployment before registering it.

Response

HttpDetailedDeploymentResponse
LambdaDetailedDeploymentResponse

Detailed deployment response for HTTP deployments

string

required

uri

string

required

URI used to invoke this service deployment.

protocol_type

enum<string>

required

Protocol type used to invoke this service deployment.

Available options:

RequestResponse,

BidiStream

http_version

string

required

HTTP Version used to invoke this service deployment.

created_at

string

required

min_protocol_version

integer<int32>

required

During registration, the SDKs declare a range from minimum (included) to maximum (included) Service Protocol supported version.

max_protocol_version

integer<int32>

required

During registration, the SDKs declare a range from minimum (included) to maximum (included) Service Protocol supported version.

services

Services · object[]

required

List of services exposed by this deployment.

Show child attributes

services.name

string

required

Fully qualified name of the service

services.ty

enum<string>

required

Service type

Available options:

Service,

VirtualObject,

Workflow

services.handlers

Handlers · object[]

required

Handlers for this service.

Show child attributes

services.handlers.name

string

required

The handler name.

services.handlers.input_description

string

required

If empty, no schema was provided by the user at discovery time.

services.handlers.output_description

string

required

If empty, no schema was provided by the user at discovery time.

services.handlers.ty

enum<string>

The handler type.

Available options:

Exclusive,

Shared,

Workflow

services.handlers.documentation

string | null

Documentation of the handler, as propagated by the SDKs.

services.handlers.metadata

Metadata · object

Additional handler metadata, as propagated by the SDKs.

Show child attributes

services.handlers.metadata.{key}

string

services.handlers.idempotency_retention

string | null

The retention duration of idempotent requests for this handler. If set, it overrides the value set in the service.

Can be configured using the jiff::fmt::friendly format or ISO8601, for example 5 hours.

services.handlers.journal_retention

string | null

The journal retention. When set, this applies to all requests to this handler.

In case the invocation has an idempotency key, the idempotency_retention caps the maximum journal_retention time. In case this handler is a workflow handler, the workflow_completion_retention caps the maximum journal_retention time.

Can be configured using the jiff::fmt::friendly format or ISO8601, for example 5 hours.

If set, it overrides the value set in the service.

services.handlers.inactivity_timeout

string | null

This timer guards against stalled service/handler invocations. Once it expires, Restate triggers a graceful termination by asking the service invocation to suspend (which preserves intermediate progress).

The 'abort timeout' is used to abort the invocation, in case it doesn't react to the request to suspend.

Can be configured using the jiff::fmt::friendly format or ISO8601, for example 5 hours.

If set, it overrides the value set in the service.

services.handlers.abort_timeout

string | null

This timer guards against stalled service/handler invocations that are supposed to terminate. The abort timeout is started after the 'inactivity timeout' has expired and the service/handler invocation has been asked to gracefully terminate. Once the timer expires, it will abort the service/handler invocation.

This timer potentially interrupts user code. If the user code needs longer to gracefully terminate, then this value needs to be set accordingly.

Can be configured using the jiff::fmt::friendly format or ISO8601, for example 5 hours.

If set, it overrides the value set in the service.

services.handlers.enable_lazy_state

boolean | null

If true, lazy state will be enabled for all invocations to this service. This is relevant only for Workflows and Virtual Objects.

If set, it overrides the value set in the service.

services.handlers.public

boolean

default:true

If true, this handler can be invoked through the ingress. If false, this handler can be invoked only from another Restate service.

services.handlers.input_json_schema

any | null

JSON Schema of the handler input

services.handlers.output_json_schema

any | null

JSON Schema of the handler output

services.handlers.retry_policy

Retry policy · object

Retry policy overrides applied for this handler.

Show child attributes

services.handlers.retry_policy.initial_interval

string | null

Initial interval for the first retry attempt.

Can be configured using the jiff::fmt::friendly format or ISO8601, for example 5 hours.

services.handlers.retry_policy.exponentiation_factor

number<float> | null

The factor to use to compute the next retry attempt.

services.handlers.retry_policy.max_attempts

integer<uint> | null

Number of maximum attempts (including the initial) before giving up. Infinite retries if unset. No retries if set to 1.

Required range: x >= 1

services.handlers.retry_policy.max_interval

string | null

Maximum interval between retries.

Can be configured using the jiff::fmt::friendly format or ISO8601, for example 5 hours.

services.handlers.retry_policy.on_max_attempts

Behavior when max attempts are reached.

Available options:

Pause

services.deployment_id

string

required

Deployment exposing the latest revision of the service.

services.revision

integer<uint32>

required

Latest revision of the service.

Required range: x >= 0

services.documentation

string | null

Documentation of the service, as propagated by the SDKs.

services.metadata

Metadata · object

Additional service metadata, as propagated by the SDKs.

Show child attributes

services.metadata.{key}

string

services.public

boolean

default:true

If true, the service can be invoked through the ingress. If false, the service can be invoked only from another Restate service.

services.idempotency_retention

string

default:1d

The retention duration of idempotent requests for this service.

If not configured, this returns the default idempotency retention.

Can be configured using the jiff::fmt::friendly format or ISO8601, for example 5 hours.

services.workflow_completion_retention

string | null

The retention duration of workflows. Only available on workflow services.

Can be configured using the jiff::fmt::friendly format or ISO8601, for example 5 hours.

services.journal_retention

string | null

The journal retention. When set, this applies to all requests to all handlers of this service.

In case the invocation has an idempotency key, the idempotency_retention caps the maximum journal_retention time. In case the invocation targets a workflow handler, the workflow_completion_retention caps the maximum journal_retention time.

Can be configured using the jiff::fmt::friendly format or ISO8601, for example 5 hours.

services.inactivity_timeout

string

default:1m

The 'abort timeout' is used to abort the invocation, in case it doesn't react to the request to suspend.

Can be configured using the jiff::fmt::friendly format or ISO8601, for example 5 hours.

If unset, this returns the default inactivity timeout configured in invoker options.

services.abort_timeout

string

default:1m

This timer potentially interrupts user code. If the user code needs longer to gracefully terminate, then this value needs to be set accordingly.

Can be configured using the jiff::fmt::friendly format or ISO8601, for example 5 hours.

If unset, this returns the default abort timeout configured in invoker options.

services.enable_lazy_state

boolean

default:false

If true, lazy state will be enabled for all invocations to this service. This is relevant only for Workflows and Virtual Objects.

services.retry_policy

Retry policy · object

Retry policy applied to invocations of this service.

If unset, it returns the default values configured in the Restate configuration.

Show child attributes

services.retry_policy.initial_interval

string

default:100ms

Initial interval for the first retry attempt.

Can be configured using the jiff::fmt::friendly format or ISO8601, for example 5 hours.

services.retry_policy.exponentiation_factor

number<float>

default:2

The factor to use to compute the next retry attempt. Default: 2.0.

services.retry_policy.max_attempts

integer<uint> | null

Number of maximum attempts (including the initial) before giving up. Infinite retries if unset. No retries if set to 1.

Required range: x >= 1

services.retry_policy.max_interval

string | null

Maximum interval between retries.

Can be configured using the jiff::fmt::friendly format or ISO8601, for example 5 hours.

services.retry_policy.on_max_attempts

default:Pause

Behavior when max attempts are reached.

Available options:

Pause

additional_headers

Additional headers · object

Additional headers used to invoke this service deployment.

Show child attributes

additional_headers.{key}

string

sdk_version

string | null

SDK library and version declared during registration.

SDKs

Services

Restate Cloud

Self-hosted Restate

References

Update deployment

Path Parameters

Body

Response