Skip to main content
POST
/
preview
/
v2
/
deployments
Create deployment
curl --request POST \
  --url https://api.sfcompute.com/preview/v2/deployments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "capacity": "<string>",
  "instance_template": "<string>",
  "target_instance_count": 123,
  "name": "my-resource-name",
  "instance_name_template": "<string>"
}
'
{
  "id": "<string>",
  "resource_path": "<string>",
  "owner": "<string>",
  "workspace": "<string>",
  "workspace_id": "<string>",
  "name": "<string>",
  "object": "deployment",
  "capacity": {
    "id": "<string>",
    "name": "<string>"
  },
  "instance_template": {
    "id": "itmpl_k3R-nX9vLm7Qp2Yw5Jd8F",
    "name": "<string>"
  },
  "target_instance_count": 123,
  "instance_name_template": "<string>",
  "status": {
    "message": "<string>"
  },
  "created_at": 1738972800,
  "updated_at": 1738972800
}

Authorizations

​
Authorization
string
header
required

Create an API token using sf tokens create or at https://sfcompute.com/account/api-keys.

Body

application/json
​
capacity
string
required

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

Pattern: (cap_[0-9a-zA-Z_-]{1,21})|(sfc:capacity:[a-zA-Z0-9._-]+(:[a-zA-Z0-9._-]+){2,2})
Example:

"cap_k3R-nX9vLm7Qp2Yw5Jd8F"

​
instance_template
string
required

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.

Pattern: (itmpl_[0-9a-zA-Z_-]{1,21}|ntmpl_[0-9a-zA-Z_-]{1,21})|(sfc:instance_template:[a-zA-Z0-9._-]+(:[a-zA-Z0-9._-]+){2,2})
Example:

"itmpl_k3R-nX9vLm7Qp2Yw5Jd8F"

​
target_instance_count
integer<int32>
required
​
name
null | string
Required string length: 1 - 255
Pattern: [a-zA-Z0-9][a-zA-Z0-9._-]{0,254}
Example:

"my-resource-name"

​
instance_name_template
string

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.

Maximum string length: 512
Example:

"my-fleet-{{nanoid(9)}}"

Response

Deployment created.

​
id
string
required
Pattern: depl_[0-9a-zA-Z_-]{1,21}
Example:

"depl_k3R-nX9vLm7Qp2Yw5Jd8F"

​
resource_path
string
required

A resource path for a deployment resource. Format: sfc:deployment:::.

Pattern: sfc:deployment:([a-zA-Z0-9._-]+:){2}[a-zA-Z0-9._-]+
Example:

"sfc:deployment:<account_id>:<workspace>:<name>"

​
owner
string
required
Required string length: 1 - 255
Pattern: [a-zA-Z0-9][a-zA-Z0-9._-]{0,254}
Example:

"my-resource-name"

​
workspace
string
required
Required string length: 1 - 255
Pattern: [a-zA-Z0-9][a-zA-Z0-9._-]{0,254}
Example:

"my-resource-name"

​
workspace_id
string
required
Pattern: wksp_[0-9a-zA-Z_-]{1,21}
Example:

"wksp_k3R-nX9vLm7Qp2Yw5Jd8F"

​
name
string
required
Required string length: 1 - 255
Pattern: [a-zA-Z0-9][a-zA-Z0-9._-]{0,254}
Example:

"my-resource-name"

​
object
string
default:deployment
required
read-only
Allowed value: "deployment"
​
capacity
object
required
​
instance_template
object
required
​
target_instance_count
integer<int32>
required
​
instance_name_template
string
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.

Maximum string length: 512
Example:

"my-fleet-{{nanoid(9)}}"

​
status
object
required
​
created_at
integer<int64>
required

Unix timestamp.

Example:

1738972800

​
updated_at
integer<int64>
required

Unix timestamp.

Example:

1738972800