v44

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

Update multiple instances

⚠️ This endpoint is in public preview.

Update one or more instances atomically. All listed instances must be in the same workspace; mixed-workspace batches are rejected with 422.

patch/preview/v2/instances

Request body

Example request

{
  "data": [
    {
      "id": "inst_k3R-nX9vLm7Qp2Yw5Jd8F"
    }
  ]
}

Response

Instances updated.

object'list' required

Example response

{
  "object": "list",
  "data": [
    {
      "id": "inst_k3R-nX9vLm7Qp2Yw5Jd8F",
      "resource_path": "sfc:instance:<account_id>:<workspace>:<name>",
      "owner": "my-resource-name",
      "workspace": "my-resource-name",
      "name": "my-resource-name",
      "object": "instance",
      "instance_sku": {
        "id": "isku_k3R-nX9vLm7Qp2Yw5Jd8F",
        "name": "my-resource-name"
      },
      "capacity": {
        "id": "cap_k3R-nX9vLm7Qp2Yw5Jd8F",
        "name": "my-resource-name"
      },
      "created_at": 1738972800,
      "image": {
        "id": "image_k3R-nX9vLm7Qp2Yw5Jd8F",
        "name": "my-resource-name"
      },
      "deployment": {
        "id": "depl_k3R-nX9vLm7Qp2Yw5Jd8F",
        "name": "my-resource-name"
      },
      "cloud_init_user_data": "IyEvYmluL2Jhc2gKZWNobyBoZWxsbyB3b3JsZAo=",
      "tags": {
        "env": "prod",
        "team": "infra"
      },
      "expected_shutdown_at": 1738972800
    }
  ]
}