Skip to main content
PATCH
/
deployments
/
{deployment}
Update deployment
curl --request PATCH \
  --url https://api.example.com/deployments/{deployment} \
  --header 'Content-Type: application/json' \
  --data '
{
  "additional_headers": {},
  "dry_run": true,
  "overwrite": true,
  "uri": "<string>",
  "use_http_11": true
}
'
{
  "created_at": "<string>",
  "http_version": "<string>",
  "id": "<string>",
  "max_protocol_version": 123,
  "min_protocol_version": 123,
  "services": [
    {
      "deployment_id": "<string>",
      "handlers": [
        {
          "input_description": "<string>",
          "name": "<string>",
          "output_description": "<string>",
          "abort_timeout": "<string>",
          "documentation": "<string>",
          "enable_lazy_state": true,
          "idempotency_retention": "<string>",
          "inactivity_timeout": "<string>",
          "info": [
            {
              "message": "<string>",
              "code": "<string>"
            }
          ],
          "input_json_schema": "<unknown>",
          "journal_retention": "<string>",
          "metadata": {},
          "output_json_schema": "<unknown>",
          "public": true,
          "retry_policy": {
            "exponentiation_factor": 123,
            "initial_interval": "<string>",
            "max_attempts": 2,
            "max_interval": "<string>"
          }
        }
      ],
      "name": "<string>",
      "revision": 1,
      "abort_timeout": "<string>",
      "documentation": "<string>",
      "enable_lazy_state": true,
      "idempotency_retention": "<string>",
      "inactivity_timeout": "<string>",
      "info": [
        {
          "message": "<string>",
          "code": "<string>"
        }
      ],
      "journal_retention": "<string>",
      "metadata": {},
      "public": true,
      "retry_policy": {
        "exponentiation_factor": 123,
        "initial_interval": "<string>",
        "max_attempts": 2,
        "max_interval": "<string>"
      },
      "workflow_completion_retention": "<string>"
    }
  ],
  "uri": "<string>",
  "additional_headers": {},
  "info": [
    {
      "message": "<string>",
      "code": "<string>"
    }
  ],
  "metadata": {},
  "sdk_version": "<string>"
}

Path Parameters

​
deployment
string
required

Deployment identifier

Body

application/json

Update HTTP deployment request

​
additional_headers
object

Additional headers

Additional headers added to the discover/invoke requests to the deployment. When provided, this will overwrite all the headers previously configured for this deployment.

​
dry_run
boolean

Dry-run mode

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.

​
overwrite
boolean

Overwrite

If true, the update will overwrite the schema information, including the exposed service and handlers and service configuration, allowing breaking changes too. Use with caution.

​
uri
string<uri> | null

Uri

Uri to use to discover/invoke the http deployment.

​
use_http_11
boolean | null

Use http1.1

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.

Response

Deployment updated successfully. Address and invocation options are updated. Service schemas are only updated if overwrite was set to true.

Detailed information about Restate deployments

​
created_at
string
required
​
http_version
string
required

HTTP Version

HTTP Version used to invoke this service deployment.

​
id
string
required

Deployment ID

​
max_protocol_version
integer<int32>
required

Maximum Service Protocol version

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

​
min_protocol_version
integer<int32>
required

Minimum Service Protocol version

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

​
protocol_type
enum<string>
required

Protocol Type

Protocol type used to invoke this service deployment.

Available options:
RequestResponse,
BidiStream
​
services
object[]
required

Services

List of services exposed by this deployment.

​
uri
string<uri>
required

Deployment URI

URI used to invoke this service deployment.

​
additional_headers
object

Additional headers

Additional headers used to invoke this service deployment.

​
info
object[]

Info

List of configuration/deprecation information related to this deployment.

​
metadata
object

Metadata

Deployment metadata.

​
sdk_version
string | null

SDK version

SDK library and version declared during registration.