Skip to content
StratumStratum Docs

Get an instance's SSH host-certificate status.

GET
/v1/projects/{projectId}/compute/instances/{instanceId}/ssh-host-cert
Code sample: Shell / cURL
curl --request GET \
  --url https://stratum.example.com/v1/projects/example/compute/instances/example/ssh-host-cert \
  --header 'Authorization: Bearer <token>'

/423 — returns the current SSH host-certificate the instance’s agent obtained over IMDS (serial, validity window, CA generation, principals), so the UI can show “host key is CA-signed, renews automatically” instead of a TOFU prompt. A fresh instance whose agent hasn’t signed yet returns hasCertificate: false. Read over the audit record in sshca.signed_certs; gates on the compute:DescribeInstance Cedar action on the instance (same as reading the instance).

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
projectId
required
string
/^p-[a-z0-9-]+$/
instanceId
required
string
/^i-[a-z0-9-]+$/

Responses

Section titled “Responses”

200

Section titled “200”

The instance’s host-certificate status.

Media typeapplication/json

An instance’s current SSH host-certificate status. When hasCertificate is false (a fresh instance whose agent hasn’t signed yet) the remaining fields are omitted.

object
instanceId
required
string
hasCertificate
required

Whether the instance currently has a signed host certificate.

boolean
serial

Hex serial of the host certificate.

string
caGeneration

The host CA generation that signed it.

integer
validFrom
string format: date-time
validUntil
string format: date-time
principals

Hostnames/IPs the certificate certifies.

Array<string>

Example 

{
  "instanceId": "i-A8c2D4e6F",
  "caGeneration": 1
}

403

Section titled “403”

Authenticated but not authorized.

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
>= 400 <= 599
detail
string
instance
string format: uri-reference
requestId
required
string
code
required
string
issues

The findings of a rejected IAM policy document (custom and resource policies).

Array<object>

One finding of a rejected IAM policy document. A rejection lists every finding, so the author fixes the document in one round trip.

object
code
required

The finding, e.g. INVALID_DOCUMENT, UNKNOWN_ACTION, ACTION_NOT_APPLICABLE.

string
statement
required

Index of the statement at fault; -1 for the document as a whole.

integer
>= -1
detail
required
string
action

The offending action, where one is at fault (ACTION_NOT_APPLICABLE).

string
errors

Field errors, for codes that carry them: each problem at its field (see FieldError). Documented on the responses that set it, e.g. approveNodeJoin’s INVALID_INPUT and JOIN_APPROVAL_REFUSED. Absent otherwise.

Array<object>

One field’s problem, the stage-2 installer API’s shape. field is the field’s path, message what is wrong with it.

object
field
required

The field’s path, e.g. links[0].interface, disks[1].confirm, mgmt.address or role; empty for the whole request.

string
message
required
string
details

Structured facts about the refusal, for codes that carry them. The shape is fixed per code and documented on the response that answers it, e.g. IMAGE_POOL_MISMATCH (see ImagePoolMismatchDetails) and IMAGE_IN_USE. Absent for codes that carry none.

object
key
additional properties
any

Example 

{
  "issues": [
    {
      "code": "ACTION_NOT_APPLICABLE",
      "action": "compute:CreateVpc"
    }
  ]
}