The release token.

GET

/v1/admin/upgrades/release-token

Shell / cURL

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

Whether a release token is set, and what the stable release channel last answered for it. The token itself is never returned. Install-scope; gates on upgrade:DescribeUpgrade.

Authorizations

bearerAuth

Responses

200

The release token’s state.

application/json

The release token: the credential that opens the stable release channel (stableUrl). The token is in OpenBao and never returned. With a token, and the release mirror set to the default (or to stableUrl), the update check and every release download read the stable channel, sending the token as Authorization: Bearer to that host and no other. When the stable channel does not serve a usable index (it refuses the token, answers another HTTP error, cannot be reached, or serves an index that does not verify), that check reads the default mirror instead, and every later check tries the stable channel again.

status:

none: no token is set.
unchecked: set; the next update check uses it.
accepted: the stable channel served its release index to the token.
revoked: it answered 401, an unknown or revoked token.
plan_ended: it answered 403, the company’s Enterprise plan is not in force.
unreachable: no connection, a timeout, or another HTTP error (a 404); message gives the status or the error.
invalid: it served an index that does not verify, or one older than the one already read from it; message says why.
unused: set, but never sent: the release mirror is set to another host, or the update check is off.

object

configured

required

True when a token is set.

boolean

status

required

string

Allowed values: none unchecked accepted revoked plan_ended unreachable invalid unused

message

required

The status in a sentence, for the upgrade settings.

string

stableUrl

required

The stable release channel the token is sent to.

string

updatedAt

When this token was set; null when not known (set before this field existed, or none).

string format: date-time

nullable

updatedBy

required

string

checkedAt

When the stable channel was last read with this token.

string format: date-time

nullable

Example

{
  "status": "none",
  "stableUrl": "https://releases.stratum-labs.cloud"
}

403

Authenticated but not authorized.

application/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

Upstream temporarily unavailable (driver / scheduler / dependency).

application/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

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

object

key

additional properties

any

Example

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