Skip to main content
POST
/
preview
/
v2
/
pool_transfers
Create pool transfer
curl --request POST \
  --url https://api.sfcompute.com/preview/v2/pool_transfers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "from_pool": "<string>",
  "to_pool": "<string>",
  "allocation_schedule_delta": [
    {
      "start_at": 1738972800,
      "node_count": 123,
      "end_at": 1738972800
    }
  ],
  "instance_sku": "isku_k3R-nX9vLm7Qp2Yw5Jd8F"
}
'
{
  "object": "pool_transfer",
  "id": "pxfr_k3R-nX9vLm7Qp2Yw5Jd8F",
  "created_at": 1738972800,
  "from_pool": "pool_k3R-nX9vLm7Qp2Yw5Jd8F",
  "to_pool": "pool_k3R-nX9vLm7Qp2Yw5Jd8F",
  "instance_sku": {
    "id": "isku_k3R-nX9vLm7Qp2Yw5Jd8F",
    "name": "<string>"
  },
  "allocation_schedule_delta": [
    {
      "start_at": 1738972800,
      "node_count": 123,
      "end_at": 1738972800
    }
  ],
  "rejected_reason": "<string>"
}

Authorizations

​
Authorization
string
header
required

Create an API token using sf tokens create or at https://sfcompute.com/account/api-keys.

Headers

​
Idempotency-Key
string | null

Unique key for idempotent transfer creation.

Body

application/json

Transfer some or all of one pool into another.

​
from_pool
string
required

Source pool (must belong to the authenticated caller).

Pattern: (pool_[0-9a-zA-Z_-]{1,21}|cap_[0-9a-zA-Z_-]{1,21})|(sfc:pool:[a-zA-Z0-9._-]+(:[a-zA-Z0-9._-]+){2,2})
Example:

"pool_k3R-nX9vLm7Qp2Yw5Jd8F"

​
to_pool
string
required

Destination pool (must belong to the authenticated caller).

Pattern: (pool_[0-9a-zA-Z_-]{1,21}|cap_[0-9a-zA-Z_-]{1,21})|(sfc:pool:[a-zA-Z0-9._-]+(:[a-zA-Z0-9._-]+){2,2})
Example:

"pool_k3R-nX9vLm7Qp2Yw5Jd8F"

​
allocation_schedule_delta
object[]
required

The transfer's allocation schedule as constant-quantity rectangles. If the final entry does not have end_at: null, a zero-quantity unbounded tail is appended automatically.

​
instance_sku
required

Instance SKU the transfer applies to.

Pattern: isku_[0-9a-zA-Z_-]{1,21}
Example:

"isku_k3R-nX9vLm7Qp2Yw5Jd8F"

Response

Pool transfer accepted.

A transfer of compute from one pool (from_pool) to another (to_pool).

​
object
string
default:pool_transfer
required
read-only

Discriminator for /pool_transfers responses.

Allowed value: "pool_transfer"
​
id
required

Accepts the canonical prefix below; additional legacy prefixes are aliased for read compatibility. Writes always emit the canonical form.

Pattern: pxfr_[0-9a-zA-Z_-]{1,21}
Example:

"pxfr_k3R-nX9vLm7Qp2Yw5Jd8F"

​
status
enum<string>
required

Lifecycle status of a pool transfer.

Available options:
pending,
executed,
rejected
​
created_at
integer<int64>
required

Unix timestamp.

Example:

1738972800

​
from_pool
required

Accepts the canonical prefix below; additional legacy prefixes are aliased for read compatibility. Writes always emit the canonical form.

Pattern: pool_[0-9a-zA-Z_-]{1,21}
Example:

"pool_k3R-nX9vLm7Qp2Yw5Jd8F"

​
to_pool
required

Accepts the canonical prefix below; additional legacy prefixes are aliased for read compatibility. Writes always emit the canonical form.

Pattern: pool_[0-9a-zA-Z_-]{1,21}
Example:

"pool_k3R-nX9vLm7Qp2Yw5Jd8F"

​
instance_sku
object
required

Instance SKU the transfer applied to. Carries the SKU's human-readable name when one is registered.

​
allocation_schedule_delta
object[]
required

The transfer's allocation schedule, expanded into constant-quantity rectangles. The final rectangle has end_at: null (the unbounded tail); gaps are represented as explicit zero-quantity rectangles.

​
rejected_reason
string | null

Reason a pool transfer was rejected.