v44

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

List capacity transfers

⚠️ This endpoint is in public preview.

List capacity transfers for the caller's organization.

get/preview/v2/capacity_transfers

Query parameters

capacitySfcApiResourcePathOrIdCapacityId[]

Filter by source or destination capacity (repeatable). Returns transfers where from_capacity_id or to_capacity_id is any of the supplied capacities.

[
  "cap_k3R-nX9vLm7Qp2Yw5Jd8F"
]
status'pending' | 'executed' | 'rejected'

Filter by transfer status.

limitinteger
starting_afterstring
Example:ctfrc_gqXR7s0Kj5mHvE2wNpLc4Q

Set to the response's cursor to fetch the next page.

ending_beforestring
Example:ctfrc_gqXR7s0Kj5mHvE2wNpLc4Q

Set to the response's cursor to fetch the previous page.

Response

Paginated list of capacity transfers.

object'list' required
cursorstring
has_moreboolean required

Example response

{
  "object": "list",
  "cursor": "ctfrc_gqXR7s0Kj5mHvE2wNpLc4Q",
  "data": [
    {
      "object": "capacity_transfer",
      "id": "cxfr_k3R-nX9vLm7Qp2Yw5Jd8F",
      "created_at": 1738972800,
      "from_capacity": "cap_k3R-nX9vLm7Qp2Yw5Jd8F",
      "to_capacity": "cap_k3R-nX9vLm7Qp2Yw5Jd8F",
      "instance_sku": {
        "id": "isku_k3R-nX9vLm7Qp2Yw5Jd8F",
        "name": "my-resource-name"
      },
      "allocation_schedule_delta": [
        {
          "start_at": 1738972800,
          "end_at": 1738972800
        }
      ]
    }
  ]
}