POST
/
deployments
{
  "id": "<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": "1d",
      "workflow_completion_retention": "<string>",
      "journal_retention": "<string>",
      "inactivity_timeout": "1m",
      "abort_timeout": "1m",
      "enable_lazy_state": false,
      "retry_policy": {
        "initial_interval": "100ms",
        "exponentiation_factor": 2,
        "max_attempts": null,
        "max_interval": null,
        "on_max_attempts": "Pause"
      }
    }
  ],
  "min_protocol_version": 0,
  "max_protocol_version": 0,
  "sdk_version": "<string>"
}

Body

application/json

Register HTTP deployment request

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

​
force
boolean
default:true

If true, it will override, if existing, any deployment using the same uri. Beware that this can lead in-flight invocations to an unrecoverable error state.

By default, this is true but it might change in future to false.

See the versioning documentation for more information.

​
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

Created

​
id
string
required
​
services
object[]
required
​
min_protocol_version
integer
default:0

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

​
max_protocol_version
integer
default:0

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

​
sdk_version
string | null

SDK library and version declared during registration.