Skip to content
Authrim

Inspect one control-plane provisioning operation.

GET
/api/admin/platform/control-plane/operations/{operationId}
Code sample: Shell / cURL 
curl --request GET \
  --url https://auth.example.com/api/admin/platform/control-plane/operations/example \
  --header 'Authorization: Bearer <token>'

Returns an environment-scoped, redacted operation, its ordered step status, and the actions currently permitted by Control guards. This read-only endpoint does not mutate resources.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
operationId
required
string
>= 1 characters <= 128 characters /^[a-zA-Z0-9][a-zA-Z0-9._:-]*$/

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Provisioning operation status.

Media type application/json
object
operation
required
object
operationId
required
string
operationKind
required
string
status
required
string
Allowed values: queued running waiting_retry succeeded blocked canceled
attemptCount
required
integer
nextAttemptAt
required
integer | null format: int64
lastErrorCode
required
string | null
createdAt
required
integer format: int64
updatedAt
required
integer format: int64
availableActions
required
Array<string>
<= 4 items unique items
Allowed values: retry_create_d1 retry_apply_migrations retry_reconcile_worker_bindings restore_previous_settings cancel
steps
required
Array<object>
<= 64 items
object
stepKey
required
string
displayOrder
required
integer
status
required
string
Allowed values: queued running waiting_retry succeeded blocked canceled skipped rolled_back
attemptCount
required
integer
nextAttemptAt
required
integer | null format: int64
lastErrorCode
required
string | null
observedResourceId
required
string | null
progressCurrent
required
integer | null
progressTotal
required
integer | null
startedAt
required
integer | null format: int64
completedAt
required
integer | null format: int64
updatedAt
required
integer format: int64
key
additional properties
key
additional properties
key
additional properties
Example 
{
  "operation": {
    "status": "queued",
    "availableActions": [
      "retry_create_d1"
    ],
    "steps": [
      {
        "status": "queued"
      }
    ]
  }
}

400

Section titled “400 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Section titled “401 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Section titled “403 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

404

Section titled “404 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

503

Section titled “503 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}