Skip to main content
GET
Get pool transfer

Authorizations

Authorization
string
header
required

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

Path Parameters

id
required

Pool transfer ID 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"

Response

Pool transfer details.

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
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"

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.