Sign in

v1

latestOpenAPI 3.1.02026-07-2665179189.7 KB
Deployments

Get deployment

⚠️ This endpoint is in public preview.

Retrieve a deployment or spot deployment by ID or resource path.

get/preview/v2/deployments/{id}

Path parameters

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

OR
string required

A resource path like 'sfc:spot_deployment:acme:prod:my-spot_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

Response

Deployment details.

OR

Example response

{
  "id": "depl_k3R-nX9vLm7Qp2Yw5Jd8F",
  "resource_path": "sfc:deployment:<account_id>:<workspace>:<name>",
  "owner": "my-resource-name",
  "workspace": "my-resource-name",
  "workspace_id": "wksp_k3R-nX9vLm7Qp2Yw5Jd8F",
  "name": "my-resource-name",
  "capacity": {
    "id": "cap_k3R-nX9vLm7Qp2Yw5Jd8F",
    "name": "my-resource-name"
  },
  "pool": {
    "id": "pool_k3R-nX9vLm7Qp2Yw5Jd8F",
    "name": "my-resource-name"
  },
  "instance_sku": {
    "id": "isku_k3R-nX9vLm7Qp2Yw5Jd8F",
    "alias": "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
}