Skip to content

Which optional services this cloud offers.

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

Readable by any signed-in principal. It lists every service an operator can switch off or an install profile can leave out, with whether it is offered. A console hides what is not.

While a service is not offered, its tenant routes answer 503 SERVICE_DISABLED, never 404, so a client can tell “switched off” from “not built”. Every control plane agrees within about a second of a switch.

The services and whether each is offered.

Media typeapplication/json
object
items
required
Array<object>
object
key
required
string
enabled
required

The service is offered on this cloud. When false, its routes answer 503 SERVICE_DISABLED.

boolean
reason

Why the service is not offered (switched off, or not on this install profile).

string

Example

{
"items": [
{
"key": "db"
}
]
}

Missing or invalid token.

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"
}
]
}
WWW-Authenticate
string