Read one service's state.

GET

/v1/admin/services/{key}

Code sample: Shell / cURL

curl --request GET \
  --url https://stratum.example.com/v1/admin/services/db \
  --header 'Authorization: Bearer <token>'

• A Stratum cluster endpoint.

Cedar action: platform:DescribeServices.

Authorizations

• bearerAuth

Parameters

Path Parameters

key

required

string

Allowed values: db k8s client-vpn backup s3 secrets security asg

A registered service key. images and lb are always-on services with no registry row, so they are not addressable here.

Responses

200

The service.

Media typeapplication/json

One Stratum service in the service registry. Only managed services are switchable; a service the platform itself runs on is always on where it exists. A single-node install does not offer asg, db, k8s or s3 at all.

object

key

required

The service key (db, k8s, client-vpn, backup, s3, secrets, security, asg).

string

bucket

required

The hosting bucket.

string

Allowed values: B C

switchable

required

An operator may turn it off.

boolean

requires

required

Service keys that must be on for this one to work.

Array<string>

summary

required

string

available

required

The service exists here: on this install’s profile, and with its backend deployed. S3 on a cluster is not available until the Ceph object gateway (RGW) is deployed (waitsFor).

boolean

waitsFor

Set when the service is unavailable only because its backend is not deployed yet: ceph (no Ceph cluster yet), rgw (Ceph runs, its object gateway is not deployed). Also set on a service whose prerequisite (requires) waits so, with that prerequisite’s value (db waits with s3). The operator’s switch is kept meanwhile; the service turns on by itself once the backend is deployed.

string

Allowed values: ceph rgw

enabled

required

On right now. Never true when available is false.

boolean

reason

Why the service is unavailable or off.

string

updatedAt

When an operator last switched it. Absent if never.

string format: date-time

updatedBy

string

teardown

A service’s teardown record.

object

state

required

Running: tenant routes answer 503 while the service’s reconcilers delete the resources. done: none were left and the service was switched off.

string

Allowed values: running done

planId

string

by

string

startedAt

string format: date-time

detail

What a running teardown is waiting on.

string

Example

{
  "key": "db",
  "bucket": "B",
  "waitsFor": "ceph",
  "teardown": {
    "state": "running"
  }
}

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

404

Resource not found.

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