Skip to main content
GET
/
preview
/
v2
/
instances
/
{id}
/
ssh
Get instance SSH info
curl --request GET \
  --url https://api.sfcompute.com/preview/v2/instances/{id}/ssh \
  --header 'Authorization: Bearer <token>'
{
  "hostname": "<string>",
  "port": 1,
  "host_keys": [
    {
      "key_type": "<string>",
      "key": "AAAAC3NzaC1lZDI1NTE5AAAAI..."
    }
  ],
  "last_successful_key_update_at": 1738972800,
  "last_attempted_key_update_at": 1738972800
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

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.

Pattern: (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})
Example:

"inst_k3R-nX9vLm7Qp2Yw5Jd8F"

Response

SSH connection details.

​
hostname
string
required
Example:

"24.125.89.203"

​
port
integer<u-int16>
required
Required range: x >= 0
Example:

22

​
host_keys
object[]
required
​
last_successful_key_update_at
null | integer<int64>

Unix timestamp of the last successful host key refresh.

Example:

1738972800

​
last_attempted_key_update_at
null | integer<int64>

Unix timestamp of the last attempted host key refresh.

Example:

1738972800