Skip to main content
POST
Create pool transfer

Authorizations

Authorization
string
header
required

Create an API token using sf tokens create or at https://sfcompute.com/dashboard/tokens.

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})|(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})|(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. Every time is a Unix timestamp in seconds on the allocation schedule grid; the first start_at can also be the current time.

sku
string
required

SKU the transfer applies to. Rejected at submission if the SKU id is not registered. Any id spelling is accepted.

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

"sku_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
string
required
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
string
required
Pattern: pool_[0-9a-zA-Z_-]{1,21}
Example:

"pool_k3R-nX9vLm7Qp2Yw5Jd8F"

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

"pool_k3R-nX9vLm7Qp2Yw5Jd8F"

sku
object
required

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.