A service teardown's progress.

GET

/v1/admin/services/{key}/teardown

Code sample: Shell / cURL

curl --request GET \
  --url https://stratum.example.com/v1/admin/services/db/teardown \
  --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 teardown record and what is left.

Media typeapplication/json

object

service

required

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

remaining

required

The live resources still to go, while running.

Array<object>

One live tenant resource a teardown deletes.

object

kind

required

Db-instance, backup-plan or client-vpn-endpoint.

string

id

required

string

name

string

projectId

required

string

action

required

A database instance keeps a final snapshot, which is not deleted.

string

Allowed values: delete final-snapshot-then-delete

finalSnapshot

The final snapshot’s name, for final-snapshot-then-delete.

string

blocker

Why a teardown cannot delete it (deletion protection, a blue/green member). Clear it through the resource’s own API; the plan cannot be executed while any item is blocked.

string

status

Where the resource is now, in progress (e.g. “deleting”).

string

Example

{
  "teardown": {
    "state": "running"
  },
  "remaining": [
    {
      "action": "delete"
    }
  ]
}

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