Get instance
Retrieve an instance by ID or name.
Authorizations
Create an API token using sf tokens create or at https://sfcompute.com/account/api-keys.
Path Parameters
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})"inst_k3R-nX9vLm7Qp2Yw5Jd8F"
Response
Instance details.
Identity block flattened into [InstanceResponse]. Response-only: handlers build it from the resolver's [crate::types::resource_path::InstanceScope] at the response boundary.
inst_[0-9a-zA-Z_-]{1,21}"inst_k3R-nX9vLm7Qp2Yw5Jd8F"
A resource path for a instance resource. Format: sfc:instance:::.
sfc:instance:([a-zA-Z0-9._-]+:){2}[a-zA-Z0-9._-]+"sfc:instance:<account_id>:<workspace>:<name>"
Workspace this instance belongs to.
1 - 255[a-zA-Z0-9][a-zA-Z0-9._-]{0,254}"my-resource-name"
"instance"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 SKU this instance is pinned to.
Unix timestamp.
1738972800
Unix timestamp (seconds) when the instance was last updated.
1738972800
Image this instance was launched from.
Whether cloud-init user data is configured for this instance. Fetch the data itself from GET /instances/{id}/cloud_init_user_data.
Pool this instance is utilizing.
Deployment or spot deployment managing this instance, if any.
- Option 1
- Option 2
Preview. Whether this instance requires a public IPv4 address. When false, only SSH (TCP port 22) is open on the instance and no other ports accept inbound traffic.
Preview. Public IPv4 address assigned to this instance. Present only when _preview_enable_public_ipv4 = true; omitted otherwise.
Preview. Firewall attached to this instance's public IP. Omitted when the instance has _preview_enable_public_ipv4 = false.
frwl_[0-9a-zA-Z_-]{1,21}"frwl_k3R-nX9vLm7Qp2Yw5Jd8F"
Metadata tags attached to this instance.
Instance priority. Lower-priority instances are terminated first when the capacity's quota drops below the running-instance count.
yield, normal, preferred, critical