Sign in

v44

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-20129390589.6 KB
Deployments

Update deployment

⚠️ This endpoint is in public preview.

Update a deployment's configuration.

patch/preview/v2/deployments/{id}

Path parameters

idstring required

A resource path like 'sfc:deployment:acme:prod:my-deployment' or an ID. Resource paths are human-readable but not stable - they change when resources are renamed or moved. IDs are stable and permanent.

Example:depl_k3R-nX9vLm7Qp2Yw5Jd8F

Request body

namestring
instance_templatestring

A resource path like 'sfc:instance_template:acme:prod:my-instance_template' or an ID. Resource paths are human-readable but not stable - they change when resources are renamed or moved. IDs are stable and permanent.

target_instance_countinteger nullable
instance_name_templatestring

A name template using {{variable}} syntax. Available variables: {{adjective}} (~128 random adjectives), {{noun}} (~128 random nouns), {{nanoid(N)}} (N-character alphanumeric identifier, 1 ≤ N ≤ 21). The template must produce enough unique combinations to avoid collisions — equivalent to at least the default template {{adjective}}-{{noun}}-{{nanoid(6)}} (~1 quadrillion possibilities). Must start with an alphanumeric character. Resolved names are limited to 255 characters.

Example request

{
  "name": "my-resource-name",
  "instance_template": "itmpl_k3R-nX9vLm7Qp2Yw5Jd8F",
  "instance_name_template": "my-fleet-{{nanoid(9)}}"
}

Response

Deployment updated.

idstring required
resource_pathstring required

A resource path for a deployment resource. Format: sfc:deployment:<account>:<workspace>:<name>.

ownerstring required
workspacestring required
namestring required
object'deployment' required
target_instance_countinteger required
instance_name_templatestring required

A name template using {{variable}} syntax. Available variables: {{adjective}} (~128 random adjectives), {{noun}} (~128 random nouns), {{nanoid(N)}} (N-character alphanumeric identifier, 1 ≤ N ≤ 21). The template must produce enough unique combinations to avoid collisions — equivalent to at least the default template {{adjective}}-{{noun}}-{{nanoid(6)}} (~1 quadrillion possibilities). Must start with an alphanumeric character. Resolved names are limited to 255 characters.

created_atinteger required

Unix timestamp.

updated_atinteger required

Unix timestamp.

Example response

{
  "id": "depl_k3R-nX9vLm7Qp2Yw5Jd8F",
  "resource_path": "sfc:deployment:<account_id>:<workspace>:<name>",
  "owner": "my-resource-name",
  "workspace": "my-resource-name",
  "name": "my-resource-name",
  "object": "deployment",
  "capacity": {
    "id": "cap_k3R-nX9vLm7Qp2Yw5Jd8F",
    "name": "my-resource-name"
  },
  "instance_template": {
    "id": "itmpl_k3R-nX9vLm7Qp2Yw5Jd8F",
    "name": "my-resource-name"
  },
  "instance_name_template": "my-fleet-{{nanoid(9)}}",
  "created_at": 1738972800,
  "updated_at": 1738972800
}