Sign in

v1

latestOpenAPI 3.1.02026-07-2665179189.7 KB
Pools

List pool transfers

⚠️ This endpoint is in public preview.

List pool transfers for the caller's organization.

get/preview/v2/pool_transfers

Query parameters

poolResourcePathOrIdPoolId[]

Filter by source or destination pool (repeatable). Returns transfers where the source or destination pool is any of the supplied pools.

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

Lifecycle status of a pool transfer.

Filter by transfer status.

limitinteger
starting_afterstring
Example:ptfrc_gqXR7s0Kj5mHvE2wNpLc4Q

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

ending_beforestring
Example:ptfrc_gqXR7s0Kj5mHvE2wNpLc4Q

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

Response

Paginated list of pool transfers.

object'list' required
cursorstring
has_moreboolean required

Example response

{
  "cursor": "ptfrc_gqXR7s0Kj5mHvE2wNpLc4Q",
  "data": [
    {
      "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
        }
      ]
    }
  ]
}