Skip to main content
GET
List pool transfers

Authorizations

Authorization
string
header
required

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

Query Parameters

pool
string[]

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

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.

Pattern: (pool_[0-9a-zA-Z_-]{1,21})|(sfc:pool:[a-zA-Z0-9._-]+(:[a-zA-Z0-9._-]+){2,2})
status
enum<string>

Filter by transfer status. Lifecycle status of a pool transfer.

Available options:
pending,
executed,
rejected
limit
integer<u-int32>
default:50
Required range: 1 <= x <= 200
starting_after
string

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

Pattern: ^ptfrc_[A-Za-z0-9_-]+$
Example:

"ptfrc_gqXR7s0Kj5mHvE2wNpLc4Q"

ending_before
string

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

Pattern: ^ptfrc_[A-Za-z0-9_-]+$
Example:

"ptfrc_gqXR7s0Kj5mHvE2wNpLc4Q"

Response

Paginated list of pool transfers.

object
string
default:list
required
read-only
Allowed value: "list"
has_more
boolean
required
data
object[]
required
cursor
null | string
Pattern: ^ptfrc_[A-Za-z0-9_-]+$
Example:

"ptfrc_gqXR7s0Kj5mHvE2wNpLc4Q"