Ops API

GET/api/ops/emergency-contract

request access

Emergency contract.

Permissions

HTTP request

GET https://<your-host>/api/ops/emergency-contract

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

This operation does not accept a request body.

Response

200 response body

Structure: Value.

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request GET \
  --header 'Authorization: Bearer <token>' \
  'https://<your-host>/api/ops/emergency-contract'

Schematic response body

Illustrative shape generated from the extracted field types, not a recorded live response. Values are placeholders; null marks a field whose type could not be resolved.

Success status: 200

{
  "source": "<string>",
  "providerCallsEnabled": false,
  "modes": [],
  "requiredGuards": [],
  "planSections": [],
  "blockedReasons": [],
  "endpoints": null,
  "rules": []
}

GET/api/ops/emergency/active

admin access

Emergency active.

Permissions

HTTP request

GET https://<your-host>/api/ops/emergency/active

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

This operation does not accept a request body.

Response

For 200, the known response body type is Value. Its field schema is unavailable, so no JSON shape is inferred.

Error responses use the platform ApiError body (error, message, optional detail).

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request GET \
  --header 'Authorization: Bearer <token>' \
  'https://<your-host>/api/ops/emergency/active'

POST/api/ops/emergency/approve/{id}

admin access

Approve emergency.

Permissions

HTTP request

POST https://<your-host>/api/ops/emergency/approve/{id}

Path parameters

Query parameters

This operation has no query parameters.

Request headers

Request body

This operation does not accept a request body.

Response

For 200, the known response body type is Value. Its field schema is unavailable, so no JSON shape is inferred.

Error responses use the platform ApiError body (error, message, optional detail).

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Idempotency-Key: <idempotency-key>' \
  'https://<your-host>/api/ops/emergency/approve/<id>'

POST/api/ops/emergency/close/{id}

admin access

Close emergency.

Permissions

HTTP request

POST https://<your-host>/api/ops/emergency/close/{id}

Path parameters

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: EmergencyCloseRequest.

Response

For 200, the known response body type is Value. Its field schema is unavailable, so no JSON shape is inferred.

Error responses use the platform ApiError body (error, message, optional detail).

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '{"postReviewNotes":"<string>"}' \
  'https://<your-host>/api/ops/emergency/close/<id>'

POST/api/ops/emergency/execute/{id}

admin access

Execute emergency.

Permissions

HTTP request

POST https://<your-host>/api/ops/emergency/execute/{id}

Path parameters

Query parameters

This operation has no query parameters.

Request headers

Request body

This operation does not accept a request body.

Response

For 200, the known response body type is Value. Its field schema is unavailable, so no JSON shape is inferred.

Error responses use the platform ApiError body (error, message, optional detail).

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Idempotency-Key: <idempotency-key>' \
  'https://<your-host>/api/ops/emergency/execute/<id>'

GET/api/ops/emergency/history

admin access

Emergency history.

Permissions

HTTP request

GET https://<your-host>/api/ops/emergency/history

Path parameters

This operation has no path parameters.

Query parameters

Request headers

Request body

This operation does not accept a request body.

Response

For 200, the known response body type is Value. Its field schema is unavailable, so no JSON shape is inferred.

Error responses use the platform ApiError body (error, message, optional detail).

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request GET \
  --header 'Authorization: Bearer <token>' \
  'https://<your-host>/api/ops/emergency/history'

POST/api/ops/emergency/initiate

admin access

Initiate emergency.

Permissions

HTTP request

POST https://<your-host>/api/ops/emergency/initiate

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: EmergencyInitiateRequest.

Response

For 200, the known response body type is Value. Its field schema is unavailable, so no JSON shape is inferred.

Error responses use the platform ApiError body (error, message, optional detail).

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '{"description":"<string>","systems":[],"reason":"<string>","site":"<string>"}' \
  'https://<your-host>/api/ops/emergency/initiate'

GET/api/ops/emergency/stats

admin access

Emergency stats.

Permissions

HTTP request

GET https://<your-host>/api/ops/emergency/stats

Path parameters

This operation has no path parameters.

Query parameters

Request headers

Request body

This operation does not accept a request body.

Response

For 200, the known response body type is Value. Its field schema is unavailable, so no JSON shape is inferred.

Error responses use the platform ApiError body (error, message, optional detail).

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request GET \
  --header 'Authorization: Bearer <token>' \
  'https://<your-host>/api/ops/emergency/stats'

POST/api/ops/emergency/verify/{id}

admin access

Verify emergency.

Permissions

HTTP request

POST https://<your-host>/api/ops/emergency/verify/{id}

Path parameters

Query parameters

This operation has no query parameters.

Request headers

Request body

This operation does not accept a request body.

Response

For 200, the known response body type is Value. Its field schema is unavailable, so no JSON shape is inferred.

Error responses use the platform ApiError body (error, message, optional detail).

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Idempotency-Key: <idempotency-key>' \
  'https://<your-host>/api/ops/emergency/verify/<id>'

GET/api/ops/incident-context-contract

request access

Incident context contract.

Permissions

HTTP request

GET https://<your-host>/api/ops/incident-context-contract

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

This operation does not accept a request body.

Response

200 response body

Structure: Value.

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request GET \
  --header 'Authorization: Bearer <token>' \
  'https://<your-host>/api/ops/incident-context-contract'

Schematic response body

Illustrative shape generated from the extracted field types, not a recorded live response. Values are placeholders; null marks a field whose type could not be resolved.

Success status: 200

{
  "source": "<string>",
  "providerCallsEnabled": false,
  "liveExecutionEnabled": false,
  "endpoints": []
}

GET/api/ops/incident/active

audit access

List active incident contexts, newest first.

Capped at the latest MAX_LIST_ROWS (1000) rows — a defense-in-depth bound against a sustained-incident burst, not full pagination.

Permissions

HTTP request

GET https://<your-host>/api/ops/incident/active

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

This operation does not accept a request body.

Response

For 200, the known response body type is Value. Its field schema is unavailable, so no JSON shape is inferred.

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request GET \
  --header 'Authorization: Bearer <token>' \
  'https://<your-host>/api/ops/incident/active'

POST/api/ops/incident/assemble

execute access

Incident assemble.

Permissions

HTTP request

POST https://<your-host>/api/ops/incident/assemble

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: IncidentAssembleRequest.

Response

For 200, the known response body type is Value. Its field schema is unavailable, so no JSON shape is inferred.

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '{"incidentTitle":"<string>","severity":"<string>","affectedCiNames":[],"site":"<string>"}' \
  'https://<your-host>/api/ops/incident/assemble'

GET/api/ops/incident/{id}

audit access

Get incident.

Permissions

HTTP request

GET https://<your-host>/api/ops/incident/{id}

Path parameters

Query parameters

This operation has no query parameters.

Request headers

Request body

This operation does not accept a request body.

Response

For 200, the known response body type is Value. Its field schema is unavailable, so no JSON shape is inferred.

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request GET \
  --header 'Authorization: Bearer <token>' \
  'https://<your-host>/api/ops/incident/<id>'

POST/api/ops/incident/{id}/add-ci

execute access

Incident add ci.

Permissions

HTTP request

POST https://<your-host>/api/ops/incident/{id}/add-ci

Path parameters

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: IncidentAddCiRequest.

Response

For 200, the known response body type is Value. Its field schema is unavailable, so no JSON shape is inferred.

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '{"ciName":"<string>","ciType":"<string>"}' \
  'https://<your-host>/api/ops/incident/<id>/add-ci'

GET/api/ops/incident/{id}/changes

audit access

Incident changes.

Permissions

HTTP request

GET https://<your-host>/api/ops/incident/{id}/changes

Path parameters

Query parameters

This operation has no query parameters.

Request headers

Request body

This operation does not accept a request body.

Response

200 response body

Structure: Value.

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request GET \
  --header 'Authorization: Bearer <token>' \
  'https://<your-host>/api/ops/incident/<id>/changes'

Schematic response body

Illustrative shape generated from the extracted field types, not a recorded live response. Values are placeholders; null marks a field whose type could not be resolved.

Success status: 200

{
  "source": "<string>",
  "incident_id": null,
  "recent_changes": null
}

POST/api/ops/incident/{id}/escalate

execute access

Incident escalate.

Permissions

HTTP request

POST https://<your-host>/api/ops/incident/{id}/escalate

Path parameters

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: IncidentEscalateRequest.

Response

For 200, the known response body type is Value. Its field schema is unavailable, so no JSON shape is inferred.

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '{"reason":"<string>"}' \
  'https://<your-host>/api/ops/incident/<id>/escalate'

GET/api/ops/incident/{id}/oncall

audit access

Incident oncall.

Permissions

HTTP request

GET https://<your-host>/api/ops/incident/{id}/oncall

Path parameters

Query parameters

This operation has no query parameters.

Request headers

Request body

This operation does not accept a request body.

Response

200 response body

Structure: Value.

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request GET \
  --header 'Authorization: Bearer <token>' \
  'https://<your-host>/api/ops/incident/<id>/oncall'

Schematic response body

Illustrative shape generated from the extracted field types, not a recorded live response. Values are placeholders; null marks a field whose type could not be resolved.

Success status: 200

{
  "source": "<string>",
  "incident_id": null,
  "on_call": null
}

POST/api/ops/incident/{id}/resolve

execute access

Incident resolve.

Permissions

HTTP request

POST https://<your-host>/api/ops/incident/{id}/resolve

Path parameters

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: IncidentResolveRequest.

Response

For 200, the known response body type is Value. Its field schema is unavailable, so no JSON shape is inferred.

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '{"resolution":"<string>"}' \
  'https://<your-host>/api/ops/incident/<id>/resolve'

GET/api/ops/incident/{id}/services

audit access

Incident services.

Permissions

HTTP request

GET https://<your-host>/api/ops/incident/{id}/services

Path parameters

Query parameters

This operation has no query parameters.

Request headers

Request body

This operation does not accept a request body.

Response

200 response body

Structure: Value.

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request GET \
  --header 'Authorization: Bearer <token>' \
  'https://<your-host>/api/ops/incident/<id>/services'

Schematic response body

Illustrative shape generated from the extracted field types, not a recorded live response. Values are placeholders; null marks a field whose type could not be resolved.

Success status: 200

{
  "source": "<string>",
  "incident_id": null,
  "affected_ci": null,
  "upstream_deps": null,
  "downstream_deps": null
}

GET/api/ops/runbook-contract

request access

Runbook contract.

Permissions

HTTP request

GET https://<your-host>/api/ops/runbook-contract

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

This operation does not accept a request body.

Response

200 response body

Structure: Value.

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request GET \
  --header 'Authorization: Bearer <token>' \
  'https://<your-host>/api/ops/runbook-contract'

Schematic response body

Illustrative shape generated from the extracted field types, not a recorded live response. Values are placeholders; null marks a field whose type could not be resolved.

Success status: 200

{
  "source": "<string>",
  "providerCallsEnabled": false,
  "liveExecutionEnabled": false,
  "exceptionAuthority": null,
  "endpoints": []
}

GET/api/ops/runbook/active

audit access

Return all non-terminal runbook executions across all sites.

503 when no database is configured.

Permissions

HTTP request

GET https://<your-host>/api/ops/runbook/active

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

This operation does not accept a request body.

Response

For 200, the known response body type is Value. Its field schema is unavailable, so no JSON shape is inferred.

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request GET \
  --header 'Authorization: Bearer <token>' \
  'https://<your-host>/api/ops/runbook/active'

POST/api/ops/runbook/approve/{id}

approve access

Approve a persisted runbook execution.

Approver = authenticated caller. 403 for initiator self-approval; 503/404/409 as appropriate otherwise.

Permissions

HTTP request

POST https://<your-host>/api/ops/runbook/approve/{id}

Path parameters

Query parameters

This operation has no query parameters.

Request headers

Request body

This operation does not accept a request body.

Response

For 200, the known response body type is Value. Its field schema is unavailable, so no JSON shape is inferred.

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Idempotency-Key: <idempotency-key>' \
  'https://<your-host>/api/ops/runbook/approve/<id>'

GET/api/ops/runbook/catalog

audit access

Runbook catalog.

Permissions

HTTP request

GET https://<your-host>/api/ops/runbook/catalog

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

This operation does not accept a request body.

Response

For 200, the known response body type is Value. Its field schema is unavailable, so no JSON shape is inferred.

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request GET \
  --header 'Authorization: Bearer <token>' \
  'https://<your-host>/api/ops/runbook/catalog'

POST/api/ops/runbook/complete/{id}

execute access

Complete a persisted runbook execution.

503/404/409 as appropriate.

Permissions

HTTP request

POST https://<your-host>/api/ops/runbook/complete/{id}

Path parameters

Query parameters

This operation has no query parameters.

Request headers

Request body

This operation does not accept a request body.

Response

For 200, the known response body type is Value. Its field schema is unavailable, so no JSON shape is inferred.

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Idempotency-Key: <idempotency-key>' \
  'https://<your-host>/api/ops/runbook/complete/<id>'

GET/api/ops/runbook/execution/{id}

audit access

Fetch a persisted runbook execution by id.

503/404 as appropriate.

Permissions

HTTP request

GET https://<your-host>/api/ops/runbook/execution/{id}

Path parameters

Query parameters

This operation has no query parameters.

Request headers

Request body

This operation does not accept a request body.

Response

For 200, the known response body type is Value. Its field schema is unavailable, so no JSON shape is inferred.

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request GET \
  --header 'Authorization: Bearer <token>' \
  'https://<your-host>/api/ops/runbook/execution/<id>'

GET/api/ops/runbook/executions

audit access

List runbook executions for a given site.

503 when no database is configured. List runbook executions for a site, newest first. Capped at the latest MAX_LIST_ROWS (1000) rows — a defense-in-depth bound, not full pagination; a site with a deeper history returns only its most recent executions.

Permissions

HTTP request

GET https://<your-host>/api/ops/runbook/executions

Path parameters

This operation has no path parameters.

Query parameters

Request headers

Request body

This operation does not accept a request body.

Response

For 200, the known response body type is Value. Its field schema is unavailable, so no JSON shape is inferred.

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request GET \
  --header 'Authorization: Bearer <token>' \
  'https://<your-host>/api/ops/runbook/executions'

POST/api/ops/runbook/fail/{id}

execute access

Fail a persisted runbook execution.

503/404/409 as appropriate.

Permissions

HTTP request

POST https://<your-host>/api/ops/runbook/fail/{id}

Path parameters

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: RunbookFailRequest.

Response

For 200, the known response body type is Value. Its field schema is unavailable, so no JSON shape is inferred.

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '{"reason":"<string>"}' \
  'https://<your-host>/api/ops/runbook/fail/<id>'

POST/api/ops/runbook/rollback/{id}

execute access

Rollback a persisted runbook execution.

503/404/409 as appropriate.

Permissions

HTTP request

POST https://<your-host>/api/ops/runbook/rollback/{id}

Path parameters

Query parameters

This operation has no query parameters.

Request headers

Request body

This operation does not accept a request body.

Response

For 200, the known response body type is Value. Its field schema is unavailable, so no JSON shape is inferred.

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Idempotency-Key: <idempotency-key>' \
  'https://<your-host>/api/ops/runbook/rollback/<id>'

POST/api/ops/runbook/start

execute access

Create a new runbook execution and persist it.

Returns the entity (including the generated id) so the caller can drive subsequent lifecycle steps. 503 when no database is configured.

Permissions

HTTP request

POST https://<your-host>/api/ops/runbook/start

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: RunbookStartRequest.

Response

For 200, the known response body type is Value. Its field schema is unavailable, so no JSON shape is inferred.

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '{"runbookId":"<string>","site":"<string>"}' \
  'https://<your-host>/api/ops/runbook/start'

POST/api/ops/runbook/step/{id}/{step}

execute access

Execute a step on a persisted runbook execution.

503/404/409 as appropriate.

Permissions

HTTP request

POST https://<your-host>/api/ops/runbook/step/{id}/{step}

Path parameters

Query parameters

This operation has no query parameters.

Request headers

Request body

This operation does not accept a request body.

Response

For 200, the known response body type is Value. Its field schema is unavailable, so no JSON shape is inferred.

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Idempotency-Key: <idempotency-key>' \
  'https://<your-host>/api/ops/runbook/step/<id>/<step>'

GET/api/ops/scheduler/executions

execute access

List recent durable-scheduler job runs (when each started/finished, its status, and a short detail).

Execute-tier gated; read-only. 200 with an empty list in dry-run / no-DB mode.

Permissions

HTTP request

GET https://<your-host>/api/ops/scheduler/executions

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

This operation does not accept a request body.

Response

200 response body

Structure: Value.

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request GET \
  --header 'Authorization: Bearer <token>' \
  'https://<your-host>/api/ops/scheduler/executions'

Schematic response body

Illustrative shape generated from the extracted field types, not a recorded live response. Values are placeholders; null marks a field whose type could not be resolved.

Success status: 200

{
  "executions": null,
  "durable": false
}

GET/api/ops/scheduler/schedules

execute access

List the durable scheduler's registered recurring jobs (the registry of what runs and when it next/last ran).

Execute-tier gated; read-only. 200 with an empty list in dry-run / no-DB mode.

Permissions

HTTP request

GET https://<your-host>/api/ops/scheduler/schedules

Path parameters

This operation has no path parameters.

Query parameters

Request headers

Request body

This operation does not accept a request body.

Response

200 response body

Structure: Value.

Returns a paginated JSON object with total/limit/offset keys.

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request GET \
  --header 'Authorization: Bearer <token>' \
  'https://<your-host>/api/ops/scheduler/schedules'

Schematic response body

Illustrative shape generated from the extracted field types, not a recorded live response. Values are placeholders; null marks a field whose type could not be resolved.

Success status: 200

{
  "schedules": null,
  "durable": false,
  "total": null,
  "limit": null,
  "offset": null
}

GET/api/ops/shift-contract

request access

Shift contract.

Permissions

HTTP request

GET https://<your-host>/api/ops/shift-contract

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

This operation does not accept a request body.

Response

For 200, the known response body type is Value. Its field schema is unavailable, so no JSON shape is inferred.

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request GET \
  --header 'Authorization: Bearer <token>' \
  'https://<your-host>/api/ops/shift-contract'

POST/api/ops/shift/acknowledge/{id}

execute access

Acknowledge shift.

Permissions

HTTP request

POST https://<your-host>/api/ops/shift/acknowledge/{id}

Path parameters

Query parameters

This operation has no query parameters.

Request headers

Request body

This operation does not accept a request body.

Response

For 200, the known response body type is Value. Its field schema is unavailable, so no JSON shape is inferred.

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Idempotency-Key: <idempotency-key>' \
  'https://<your-host>/api/ops/shift/acknowledge/<id>'

POST/api/ops/shift/assign/{id}

execute access

Shift assign.

Permissions

HTTP request

POST https://<your-host>/api/ops/shift/assign/{id}

Path parameters

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: ShiftActionRequest.

Response

For 200, the known response body type is Value. Its field schema is unavailable, so no JSON shape is inferred.

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '{"user":"<string>"}' \
  'https://<your-host>/api/ops/shift/assign/<id>'

POST/api/ops/shift/escalate/{id}

execute access

Shift escalate.

Permissions

HTTP request

POST https://<your-host>/api/ops/shift/escalate/{id}

Path parameters

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: ShiftEscalateRequest.

Response

For 200, the known response body type is Value. Its field schema is unavailable, so no JSON shape is inferred.

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '{"reason":"<string>"}' \
  'https://<your-host>/api/ops/shift/escalate/<id>'

GET/api/ops/shift/handover

execute access

Shift handover.

Permissions

HTTP request

GET https://<your-host>/api/ops/shift/handover

Path parameters

This operation has no path parameters.

Query parameters

Request headers

Request body

This operation does not accept a request body.

Response

For 200, the known response body type is Value. Its field schema is unavailable, so no JSON shape is inferred.

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request GET \
  --header 'Authorization: Bearer <token>' \
  'https://<your-host>/api/ops/shift/handover'

GET/api/ops/shift/items

execute access

Filtered + paginated operator triage list over the shift queue.

Unlike /summary (aggregates), /my-items (one owner), and /stale (one hardcoded predicate), this lets an operator triage by item_type / priority / status / owner. DB-only (503 in no-DB — the engine store has no generic filtered list). limit defaults to 50 (clamped 1..=200); has_more is derived by over-fetching one row (no COUNT).

AUTHZ: the closed central read manifest and this handler both require execute. The repository then applies the server-derived typed site/environment/owner policy before content filters, ordering, over-fetch, LIMIT, and OFFSET, so pages and has_more cannot include denied rows.

Permissions

HTTP request

GET https://<your-host>/api/ops/shift/items

Path parameters

This operation has no path parameters.

Query parameters

Request headers

Request body

This operation does not accept a request body.

Response

200 response body

Structure: Value.

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request GET \
  --header 'Authorization: Bearer <token>' \
  'https://<your-host>/api/ops/shift/items'

Schematic response body

Illustrative shape generated from the extracted field types, not a recorded live response. Values are placeholders; null marks a field whose type could not be resolved.

Success status: 200

{
  "source": "<string>",
  "items": null,
  "count": null,
  "limit": null,
  "offset": null,
  "has_more": null
}

GET/api/ops/shift/my-items

execute access

Shift my items.

Permissions

HTTP request

GET https://<your-host>/api/ops/shift/my-items

Path parameters

This operation has no path parameters.

Query parameters

Request headers

Request body

This operation does not accept a request body.

Response

For 200, the known response body type is Value. Its field schema is unavailable, so no JSON shape is inferred.

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request GET \
  --header 'Authorization: Bearer <token>' \
  'https://<your-host>/api/ops/shift/my-items'

POST/api/ops/shift/resolve/{id}

execute access

Shift resolve.

Permissions

HTTP request

POST https://<your-host>/api/ops/shift/resolve/{id}

Path parameters

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: ShiftResolveRequest.

Response

For 200, the known response body type is Value. Its field schema is unavailable, so no JSON shape is inferred.

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '{"resolution":"<string>"}' \
  'https://<your-host>/api/ops/shift/resolve/<id>'

GET/api/ops/shift/stale

execute access

Shift stale.

Permissions

HTTP request

GET https://<your-host>/api/ops/shift/stale

Path parameters

This operation has no path parameters.

Query parameters

Request headers

Request body

This operation does not accept a request body.

Response

For 200, the known response body type is Value. Its field schema is unavailable, so no JSON shape is inferred.

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request GET \
  --header 'Authorization: Bearer <token>' \
  'https://<your-host>/api/ops/shift/stale'

GET/api/ops/shift/summary

execute access

Shift summary.

Permissions

HTTP request

GET https://<your-host>/api/ops/shift/summary

Path parameters

This operation has no path parameters.

Query parameters

Request headers

Request body

This operation does not accept a request body.

Response

For 200, the known response body type is Value. Its field schema is unavailable, so no JSON shape is inferred.

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request GET \
  --header 'Authorization: Bearer <token>' \
  'https://<your-host>/api/ops/shift/summary'