Skip to content
StratumStratum Docs

List substrate scrape-target health (which metric targets are up/down).

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

Bootstrap-admin endpoint returning the per-target scrape health the node-health card summarizes as “N targets down”. Each entry is one Prometheus scrape target — keyed by job + service + node_id + instance — with its current up/down state, so operators can see WHAT is down (e.g. vmstorage on n-f2gcfa6x) rather than just a count.

The controlplane queries VictoriaMetrics for the up metric (up==1 = scraped OK, up==0 = scrape failed) and groups the result by its identifying labels. Down targets carry a short lastError when vmagent recorded a scrape-error reason.

. Cross-ref the substrate services list (same bootstrap-admin Cedar gate) and (the scrape set).

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Per-scrape-target up/down state.

Media typeapplication/json
object
items
required
Array<object>
object
job
required

The vmagent scrape job (e.g. victoriametrics, node, alertmanager).

string
service

The per-target service label (e.g. vmstorage, vminsert, vmselect). May be empty.

string
nodeId

The node_id label — which node the target runs on. May be empty for non-per-node targets.

string
instance
required

The Prometheus instance label (scrape address / node id).

string
up
required

True when the last scrape succeeded (up==1), false when it failed (up==0).

boolean
lastError

Short scrape-failure reason when known (down targets only). Optional.

string
downCount
required

Number of targets currently down (up==0) — the figure the node-health card summarizes.

integer

Example generated

{
  "items": [
    {
      "job": "example",
      "service": "example",
      "nodeId": "example",
      "instance": "example",
      "up": true,
      "lastError": "example"
    }
  ],
  "downCount": 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"
    }
  ]
}

503

Section titled “503”

VictoriaMetrics backend unavailable (no metrics read path configured).

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