List instances
List all instances.
Authorizations
Create an API token using sf tokens create or at https://sfcompute.com/account/api-keys.
Query Parameters
Scope the returned list to a single workspace (ID, resource path, or name). Without it, the returned list spans every workspace where the caller has Instance:List and Instance:Read (granted at either the workspace or organization level).
A resource path like 'sfc:workspace:acme:my-workspace' or an ID. Resource paths are human-readable but not stable - they change when resources are renamed or moved. IDs are stable and permanent.
(wksp_[0-9a-zA-Z_-]{1,21})|(sfc:workspace:[a-zA-Z0-9._-]+(:[a-zA-Z0-9._-]+){1,1})"wksp_k3R-nX9vLm7Qp2Yw5Jd8F"
Filter by instance ID (repeatable).
A resource path like 'sfc:instance:acme:prod:my-instance' or an ID. Resource paths are human-readable but not stable - they change when resources are renamed or moved. IDs are stable and permanent.
(inst_[0-9a-zA-Z_-]{1,21}|vm_[0-9a-zA-Z_-]{1,21})|(sfc:instance:[a-zA-Z0-9._-]+(:[a-zA-Z0-9._-]+){2,2})Filter by pool (repeatable). Instances on any of the given pools match.
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.
(pool_[0-9a-zA-Z_-]{1,21})|(sfc:pool:[a-zA-Z0-9._-]+(:[a-zA-Z0-9._-]+){2,2})Filter by instance status (repeatable).
awaiting_allocation when waiting for compute allocation on its capacity, running once assigned and the physical machine is running (still takes time for the image to be downloaded and booted), terminated when stopped by the user or after running out of allocation, failed on hardware fault.
Values are not exhaustive across API versions. Clients should tolerate new statuses.
awaiting_allocation, running, terminated, failed Filter to instances created at or after this Unix timestamp (seconds).
Filter to instances created at or before this Unix timestamp (seconds).
Filter by SKU id (repeatable; any id spelling is accepted). Instances on any of the given SKUs match.
1 <= x <= 200Cursor for forward pagination (from a previous response's cursor field).
^instc_[A-Za-z0-9_-]+$"instc_gqXR7s0Kj5mHvE2wNpLc4Q"
Cursor for backward pagination.
^instc_[A-Za-z0-9_-]+$"instc_gqXR7s0Kj5mHvE2wNpLc4Q"
Filter by tag key-value pair (repeatable). Format: key=value (the = between key and value must be percent-encoded in the URL).
Filter by tag key existence (repeatable). Returns resources that have a tag with this key, regardless of the value.