Sign in

v1

latestOpenAPI 3.1.02026-07-2665179189.7 KB
Pools

Create pool transfer

⚠️ This endpoint is in public preview.

Transfer some or all of one pool into another

post/preview/v2/pool_transfers

Headers

Idempotency-Keystring nullable

Unique key for idempotent transfer creation.

Request body

from_poolstring required

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

to_poolstring required

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

{
  "from_pool": "pool_k3R-nX9vLm7Qp2Yw5Jd8F",
  "to_pool": "pool_k3R-nX9vLm7Qp2Yw5Jd8F",
  "allocation_schedule_delta": [
    {
      "start_at": 1738972800,
      "end_at": 1738972800
    }
  ],
  "instance_sku": "isku_k3R-nX9vLm7Qp2Yw5Jd8F"
}

Response

Pool transfer accepted.

object'pool_transfer' required

Discriminator for /pool_transfers responses.

status'pending' | 'executed' | 'rejected' required

Lifecycle status of a pool transfer.

created_atinteger required

Unix timestamp.

from_poolstring required
to_poolstring required
rejected_reasonstring nullable

Reason a pool transfer was rejected.

Example response

{
  "id": "pxfr_k3R-nX9vLm7Qp2Yw5Jd8F",
  "created_at": 1738972800,
  "from_pool": "pool_k3R-nX9vLm7Qp2Yw5Jd8F",
  "to_pool": "pool_k3R-nX9vLm7Qp2Yw5Jd8F",
  "instance_sku": {
    "id": "isku_k3R-nX9vLm7Qp2Yw5Jd8F",
    "alias": "my-resource-name"
  },
  "allocation_schedule_delta": [
    {
      "start_at": 1738972800,
      "end_at": 1738972800
    }
  ]
}