Sign in

v44

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

Get capacity transfer

⚠️ This endpoint is in public preview.

Retrieve a capacity transfer by ID.

get/preview/v2/capacity_transfers/{id}

Path parameters

idstring required
Example:cxfr_k3R-nX9vLm7Qp2Yw5Jd8F

Capacity transfer ID

Response

Capacity transfer details.

object'capacity_transfer' required
idstring required
status'pending' | 'executed' | 'rejected' required
created_atinteger required

Unix timestamp.

from_capacitystring required
to_capacitystring required
rejected_reasonstring nullable

Reason a capacity transfer was rejected.

Example response

{
  "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
    }
  ]
}