Skip to content

Metadata for the instance-agent binary this control plane serves.

GET
/v1/admin/compute/instance-agent
Code sample: Shell / cURL
curl --request GET \
--url https://stratum.example.com/v1/admin/compute/instance-agent \
--header 'Authorization: Bearer <token>'

Operator endpoint. Reports the version, size and SHA-256 of the in-VM agent binary available from /v1/admin/compute/instance-agent/binary, so a copy can be verified after it lands.

It exists because every automated route to a working agent runs through either the agent itself or the control plane reaching into the guest. When those are the broken thing — an agent that never installed, an air-gapped machine — an operator needs a plain file they can copy and a digest to check it against.

Install-scoped, like the other /v1/admin/compute/* endpoints.

Metadata for the served agent binary.

Media typeapplication/json

Metadata for the in-VM instance-agent binary this control plane serves.

The checksum is the reason this endpoint exists separately from the download. A truncated copy produces a binary systemd will happily try to exec and fail on in a way that looks like an SELinux labelling problem, so an operator copying the agent by hand needs the digest to verify against before they start debugging the wrong thing.

object
version
required

Build of the served agent. Empty when the control plane cannot resolve one; the binary is still downloadable.

string
sha256
required

Hex SHA-256 of the binary. The download returns the same value in the X-Stratum-Agent-Sha256 response header, so a scripted fetch can verify without calling this endpoint first.

string
/^[0-9a-f]{64}$/
size
required

Size of the binary, in the unit named by sizeType.

integer format: int64
sizeType
required

Unit size is expressed in. Always bytes; present so a client renders the number without assuming a unit.

string
Allowed values: bytes
filename
required

Name the download is served under (Content-Disposition). This is the name stratum-instance-agent install expects, so a manual copy should keep it.

string
path
required

On-disk path the control plane serves the binary from. Operator-only, and the thing to check when this endpoint reports 503 on an install that should have an agent.

string

Example

{
"version": "v0.0.0-c4722d14",
"sha256": "6a79b20687e3daf7cae0aa337427cd9f6454c733ab29965218431f3c1f8be51a",
"size": 7016610,
"sizeType": "bytes",
"filename": "stratum-instance-agent",
"path": "/usr/local/lib/stratum/stratum-instance-agent"
}

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"
}
]
}

This control plane is not serving an agent binary — its image may predate the agent, or the configured path is wrong.

Deliberately 503 and not 404: the endpoint exists and the condition is operator-actionable, rather than the URL being wrong. code is AGENT_BINARY_UNAVAILABLE.

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"
}
]
}