Skip to main content
POST
/
deployments
Register deployment
curl --request POST \
  --url https://api.example.com/deployments \
  --header 'Content-Type: application/json' \
  --data '
{
  "uri": "<string>",
  "additional_headers": {},
  "breaking": true,
  "dry_run": true,
  "force": true,
  "metadata": {},
  "use_http_11": true
}
'
{
  "id": "<string>",
  "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>"
    }
  ],
  "info": [
    {
      "message": "<string>",
      "code": "<string>"
    }
  ],
  "max_protocol_version": 123,
  "min_protocol_version": 123,
  "sdk_version": "<string>"
}

Body

application/json

Register HTTP deployment request

​
uri
string<uri>
required

Uri

Uri to use to discover/invoke the http deployment.

​
additional_headers
object

Additional headers

Additional headers added to every discover/invoke request to the deployment.

You typically want to include here API keys and other tokens required to send requests to deployments.

​
breaking
boolean

Breaking

If true, it allows registering new service revisions with schemas incompatible with previous service revisions, such as changing service type, removing a handler, etc.

See the versioning documentation for more information.

​
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. force and breaking will be respected.

​
force
boolean | null
default:true

Force

If true, it overrides, if existing, any deployment using the same uri. Beware that this can lead inflight invocations to an unrecoverable error state.

When set to true, it implies breaking = true.

See the versioning documentation for more information.

​
metadata
object

Metadata

Deployment metadata.

​
use_http_11
boolean

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 already exists. No change if force = false, services overwritten if force = true

​
id
string
required
​
services
object[]
required
​
info
object[]

Info

List of configuration/deprecation information related to this deployment.

​
max_protocol_version
integer<int32>

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>

Minimum Service Protocol version

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

​
sdk_version
string | null

SDK version

SDK library and version declared during registration.