PUT
/
deployments
/
{deployment}
{
  "id": "<string>",
  "uri": "<string>",
  "protocol_type": "RequestResponse",
  "http_version": "<string>",
  "additional_headers": {},
  "created_at": "<string>",
  "min_protocol_version": 123,
  "max_protocol_version": 123,
  "sdk_version": "<string>",
  "services": [
    {
      "name": "<string>",
      "ty": "Service",
      "handlers": [
        {
          "name": "<string>",
          "ty": "Exclusive",
          "documentation": "<string>",
          "metadata": {},
          "idempotency_retention": "<string>",
          "journal_retention": "<string>",
          "inactivity_timeout": "<string>",
          "abort_timeout": "<string>",
          "enable_lazy_state": true,
          "public": true,
          "input_description": "<string>",
          "output_description": "<string>",
          "input_json_schema": "<any>",
          "output_json_schema": "<any>",
          "retry_policy": {
            "initial_interval": "<string>",
            "exponentiation_factor": 123,
            "max_attempts": 2,
            "max_interval": "<string>",
            "on_max_attempts": "Pause"
          }
        }
      ],
      "documentation": "<string>",
      "metadata": {},
      "deployment_id": "<string>",
      "revision": 1,
      "public": true,
      "idempotency_retention": "<string>",
      "workflow_completion_retention": "<string>",
      "journal_retention": "<string>",
      "inactivity_timeout": "<string>",
      "abort_timeout": "<string>",
      "enable_lazy_state": true,
      "retry_policy": {
        "initial_interval": "<string>",
        "exponentiation_factor": 123,
        "max_attempts": 2,
        "max_interval": "<string>",
        "on_max_attempts": "Pause"
      }
    }
  ]
}

Path Parameters

​
deployment
string
required

Deployment identifier

Body

application/json
​
uri
string
required

Uri to use to discover/invoke the http deployment.

​
additional_headers
object | null

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

​
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

Detailed deployment response for HTTP deployments

​
id
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
required

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

​
max_protocol_version
integer
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.

​
additional_headers
object

Additional headers used to invoke this service deployment.

​
sdk_version
string | null

SDK library and version declared during registration.