Requests API

GET/api/requests

request access

Returns a backward-compatible bare request-summary array.

include_total defaults to false; when true, X-Total-Count is returned if the tightly budgeted capped aggregate completes, otherwise X-Total-Count-Unavailable: true is returned. X-Total-Count-Capped: true marks the navigation ceiling. X-Next-Cursor is emitted only when another deterministic (created_at, id) page exists.

Permissions

HTTP request

GET https://<your-host>/api/requests

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.

200 response headers

Returns a bare JSON array; include_total defaults to false, so total-count headers are conditional, and X-Next-Cursor is emitted only when another deterministic page exists.

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/requests'

POST/api/requests

request access

Create requests.

Permissions

HTTP request

POST https://<your-host>/api/requests

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: CreateRequest.

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 '{"request_type":"<string>","site":"<string>","environment":"<string>","name":"<string>","justification":"<string>"}' \
  'https://<your-host>/api/requests'

POST/api/requests/batch/approve

approve access

Record THIS approver's sign-off on up to 100 requests in one call (#17, final slice).

Each id goes through the SAME approve_one quorum/SoD core as a single approve, so a batch CANNOT bypass the multi-role quorum: a required_approval_roles > 1 request gets this approver's ONE decision and stays Planned (quorum_met=false) until N distinct roles + approvers approve. Items are independent; partial success is normal; HTTP 200 always (clients MUST inspect each result's ok/quorum_met). Duplicate ids are deduped.

approve is a FLAT capability, checked ONCE up front: a caller lacking it gets a single 403 for the WHOLE batch, audited EXACTLY ONCE with the non-id "batch" sentinel. check_sod (approver != creator) stays the PER-ITEM gate inside approve_one, so approving a request you created fails only that id.

Permissions

HTTP request

POST https://<your-host>/api/requests/batch/approve

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: BatchApproveRequest.

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 POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '{"ids":[]}' \
  'https://<your-host>/api/requests/batch/approve'

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

{
  "results": null,
  "succeeded": null,
  "failed": null,
  "approved": null
}

POST/api/requests/batch/cancel

request access

Cancel up to 100 requests in one call (#17).

Each id is cancelled INDEPENDENTLY through the same cancel_one core (so the SoD rule and the per-item transaction are identical to a single cancel); partial success is normal and the response reports a per-id outcome. Items are NOT atomic with each other — a failure on one does not roll back the rest. NOTE: even an all-failed batch returns HTTP 200; clients MUST inspect failed/results. Duplicate ids are deduped (each request is acted on once).

Permissions

HTTP request

POST https://<your-host>/api/requests/batch/cancel

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: BatchCancelRequest.

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 POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '{"ids":[],"reason":"<string>"}' \
  'https://<your-host>/api/requests/batch/cancel'

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

{
  "results": null,
  "succeeded": null,
  "failed": null
}

POST/api/requests/batch/fail

execute access

Terminally fail up to 100 requests in one call (#17, slice 3).

Each id is failed INDEPENDENTLY through the same fail_one core (so the scope rule, the per-item transaction, AND the fails-at-its-current-stage behavior are identical to a single fail); partial success is normal and the response reports a per-id outcome. Items are NOT atomic with each other. Even an all-failed batch returns HTTP 200; clients MUST inspect failed/results. Duplicate ids are deduped.

execute is a FLAT capability, checked ONCE up front: a caller lacking it gets a single 403 for the WHOLE batch, audited EXACTLY ONCE with a non-id "batch" sentinel.

Permissions

HTTP request

POST https://<your-host>/api/requests/batch/fail

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: BatchFailRequest.

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 POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '{"ids":[],"reason":"<string>"}' \
  'https://<your-host>/api/requests/batch/fail'

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

{
  "results": null,
  "succeeded": null,
  "failed": null
}

POST/api/requests/batch/reject

approve access

Reject up to 100 requests in one call (#17, slice 2).

Each id is rejected INDEPENDENTLY through the same reject_one core (so the scope/SoD rule and the per-item transaction are identical to a single reject); partial success is normal and the response reports a per-id outcome. Items are NOT atomic with each other — a failure on one does not roll back the rest. NOTE: even an all-failed batch returns HTTP 200; clients MUST inspect failed/results. Duplicate ids are deduped (each request is acted on once).

The approve capability is a FLAT capability, so it is checked ONCE up front: a caller lacking it gets a single 403 for the WHOLE batch (never per-item), audited EXACTLY ONCE with a non-id sentinel — looping the ids would be wasteful and risk an existence oracle on a denied caller. check_sod (creator != approver) remains the per-item gate inside reject_one.

Permissions

HTTP request

POST https://<your-host>/api/requests/batch/reject

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: BatchRejectRequest.

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 POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '{"ids":[],"reason":"<string>"}' \
  'https://<your-host>/api/requests/batch/reject'

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

{
  "results": null,
  "succeeded": null,
  "failed": null
}

POST/api/requests/batch/rework

approve access

Send up to 100 requests back to Intake in one call (#17, slice 3).

Each id is reworked INDEPENDENTLY through the same rework_one core (so the scope rule and per-item transaction are identical to a single rework); partial success is normal and the response reports a per-id outcome. Items are NOT atomic with each other. Even an all-failed batch returns HTTP 200; clients MUST inspect failed/results. Duplicate ids are deduped.

approve is a FLAT capability, checked ONCE up front: a caller lacking it gets a single 403 for the WHOLE batch, audited EXACTLY ONCE with a non-id "batch" sentinel (looping the ids would be wasteful and risk an existence oracle on a denied caller). rework has no SoD gate (matching the single handler).

Permissions

HTTP request

POST https://<your-host>/api/requests/batch/rework

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: BatchReworkRequest.

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 POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '{"ids":[],"reason":"<string>"}' \
  'https://<your-host>/api/requests/batch/rework'

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

{
  "results": null,
  "succeeded": null,
  "failed": null
}

GET/api/requests/execution-timeline-contract

request access

Requests execution timeline.

Permissions

HTTP request

GET https://<your-host>/api/requests/execution-timeline-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/requests/execution-timeline-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>",
  "requestTimelineMode": "<string>",
  "timelineReadOnly": false,
  "evidenceReferencesReadOnly": false,
  "operationLinksReadOnly": false,
  "liveRequestQueryAllowed": false,
  "requestMutationAllowed": false,
  "workflowMutationAllowed": false,
  "operationMutationAllowed": false,
  "providerCallsAllowed": false,
  "notificationDispatchAllowed": false,
  "rawRequestPayloadsAllowed": false,
  "rawTimelineRowsAllowed": false,
  "rawApprovalDataAllowed": false,
  "rawOperationRowsAllowed": false,
  "rawEvidencePayloadsAllowed": false,
  "rawProviderPayloadsAllowed": false,
  "rawLogContentAllowed": false,
  "rawRecipientDataAllowed": false,
  "credentialValuesAllowed": false,
  "tokenValuesAllowed": false,
  "tenantIdentifiersAllowed": false,
  "objectIdentifiersAllowed": false,
  "principalIdentifiersAllowed": false,
  "privateNetworkValuesAllowed": false,
  "timelineStages": null,
  "timelineEventTypes": null,
  "evidenceStates": null,
  "timelineViews": null,
  "requiredGuards": null,
  "blockedReasons": null,
  "requiredEvidence": [],
  "rules": []
}

GET/api/requests/intake-form

request access

Requests intake form.

Permissions

HTTP request

GET https://<your-host>/api/requests/intake-form

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/requests/intake-form'

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

{
  "title": "<string>",
  "description": "<string>",
  "source": "<string>",
  "formMode": "<string>",
  "formSubmissionAllowed": false,
  "liveRequestCreationAllowed": false,
  "inputKinds": [],
  "fields": [],
  "blockedReasons": [],
  "requiredEvidence": []
}

GET/api/requests/intake-support-contract

request access

Requests intake support.

Permissions

HTTP request

GET https://<your-host>/api/requests/intake-support-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/requests/intake-support-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>",
  "intakeSupportMode": "<string>",
  "templateCatalogReadOnly": false,
  "duplicateDetectionDryRunOnly": false,
  "draftStateReadOnly": false,
  "liveSubmissionAllowed": false,
  "draftPersistenceAllowed": false,
  "duplicateQueryAllowed": false,
  "workflowMutationAllowed": false,
  "approvalMutationAllowed": false,
  "providerCallsAllowed": false,
  "rawRequestPayloadsAllowed": false,
  "rawDraftPayloadsAllowed": false,
  "rawDuplicateRowsAllowed": false,
  "rawProviderPayloadsAllowed": false,
  "rawLogContentAllowed": false,
  "rawRowsAllowed": false,
  "rawRecipientDataAllowed": false,
  "credentialValuesAllowed": false,
  "tenantIdentifiersAllowed": false,
  "objectIdentifiersAllowed": false,
  "privateNetworkValuesAllowed": false,
  "supportSurfaces": [],
  "templateTypes": [],
  "duplicateSignals": [],
  "draftStates": [],
  "requiredGuards": [],
  "blockedReasons": [],
  "requiredEvidence": [],
  "rules": []
}

GET/api/requests/lifecycle-contract

request access

Requests lifecycle.

Permissions

HTTP request

GET https://<your-host>/api/requests/lifecycle-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/requests/lifecycle-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>",
  "lifecycleMode": "<string>",
  "dryRunRequired": false,
  "approvalRequired": false,
  "lockRequired": false,
  "redactedEvidenceRequired": false,
  "liveExecutionAllowed": false,
  "providerCallsAllowed": false,
  "workflowMutationAllowed": false,
  "approvalMutationAllowed": false,
  "lockMutationAllowed": false,
  "rawRequestPayloadsAllowed": false,
  "rawExecutionLogsAllowed": false,
  "rawEvidencePayloadsAllowed": false,
  "rawProviderPayloadsAllowed": false,
  "credentialValuesAllowed": false,
  "secretValuesAllowed": false,
  "accessTokenValuesAllowed": false,
  "rawRecipientDataAllowed": false,
  "lifecycleStages": null,
  "requiredInputs": [],
  "requiredGuards": null,
  "planSections": null,
  "blockedReasons": null,
  "requiredEvidence": [],
  "rules": []
}

GET/api/requests/preflight-contract

request access

Requests preflight.

Permissions

HTTP request

GET https://<your-host>/api/requests/preflight-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/requests/preflight-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>",
  "preflightMode": "<string>",
  "inputSchemaReadOnly": false,
  "dryRunDecisionRequired": false,
  "evidenceRedactionRequired": false,
  "liveSubmissionAllowed": false,
  "liveExecutionAllowed": false,
  "providerCallsAllowed": false,
  "providerValidationAllowed": false,
  "livePolicyEvaluationAllowed": false,
  "requestMutationAllowed": false,
  "workflowMutationAllowed": false,
  "approvalMutationAllowed": false,
  "workerDispatchAllowed": false,
  "rawRequestPayloadsAllowed": false,
  "rawValidationRowsAllowed": false,
  "rawProviderPayloadsAllowed": false,
  "rawInventoryRowsAllowed": false,
  "rawCmdbRowsAllowed": false,
  "rawApprovalDataAllowed": false,
  "rawUserDataAllowed": false,
  "rawRecipientDataAllowed": false,
  "credentialValuesAllowed": false,
  "tokenValuesAllowed": false,
  "tenantIdentifiersAllowed": false,
  "objectIdentifiersAllowed": false,
  "principalIdentifiersAllowed": false,
  "privateNetworkValuesAllowed": false,
  "hypervisorScope": [],
  "preflightSurfaces": [],
  "validationStages": [],
  "requiredInputs": [],
  "requiredGuards": [],
  "blockedReasons": [],
  "requiredEvidence": [],
  "rules": []
}

GET/api/requests/{id}

request access

Get requests.

Permissions

HTTP request

GET https://<your-host>/api/requests/{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/requests/<id>'

GET/api/requests/{id}/approval-decisions

audit access

The individual approval-decision LEDGER for one request: every recorded request_approval_decisions row (approval_epoch, current, role, decision, actor, decided_at, reason), including historical cycles that no longer satisfy quorum.

The companion to requests_approval_quorum: quorum = the verdict, this = the records behind it.

Audit-tier — same identity-grade sensitivity as the quorum endpoint and the audit trail. NOT approve-tier: every approve-holding role (DatacenterApprover, PlatformAdmin) ALSO holds audit, and gating on approve would wrongly exclude the audit-only Auditor from an audit ledger. actor is already exposed by the quorum endpoint's approvers list; reason is the approver's free-text reject justification — treat it as AUDIT-VISIBLE free text (any secret/PII redaction is a write-side concern, out of scope for this read). 404 for an unknown OR out-of-scope request (no oracle). Empty ledger + durable:false with no DB (the dry-run approve arm writes no ledger), distinct from a durable-but-empty {decisions:[],durable:true}.

Permissions

HTTP request

GET https://<your-host>/api/requests/{id}/approval-decisions

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/requests/<id>/approval-decisions'

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

{
  "decisions": null,
  "current_approval_epoch": null,
  "durable": false
}

GET/api/requests/{id}/approval-quorum

audit access

Multi-role approval quorum status for one request (#4).

Reads the recorded request_approval_decisions and reports whether they meet a breadth quorum: distinct approving ROLES and distinct APPROVERS (default 2/2, bounded 1..=10), with any rejection blocking it. Audit-tier (approval identities, like the audit trail). 404 unknown request. READ-ONLY: reports the same current-epoch quorum enforced by the approval flow. Empty + durable:false with no DB.

Permissions

HTTP request

GET https://<your-host>/api/requests/{id}/approval-quorum

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/requests/<id>/approval-quorum'

POST/api/requests/{id}/approve

approve access

Approve requests.

Permissions

HTTP request

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

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/requests/<id>/approve'

POST/api/requests/{id}/approve-live-apply

admin access

Admin approves the completed LivePlan for this request and mints a CP-signed LiveApply grant (AWX bridge slice 5c).

It revalidates and reconstructs the mutation from the exact immutable plan row/attempt/digest the administrator reviewed; it never accepts a caller-built spec or destination. The agent then independently verifies the signed grant. Admin-gated and mutation-authorizing — fail closed.

Permissions

HTTP request

POST https://<your-host>/api/requests/{id}/approve-live-apply

Path parameters

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: ReviewedLivePlanSelection.

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 POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '{"approved_plan_job_id":"<uuid>","approved_plan_attempt_id":"<uuid>","approved_plan_digest":"<string>"}' \
  'https://<your-host>/api/requests/<id>/approve-live-apply'

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

{
  "job_id": "<uuid>",
  "approver": "<string>",
  "status": "<string>",
  "mode": "<string>"
}

GET/api/requests/{id}/audit

audit access

The ordered, actor-attributed audit trail for one request.

DB-backed entries are tagged durable: true; the no-DB (dry-run) store is tagged durable: false. No secrets are ever written to the trail, so this read is safe to expose.

Permissions

HTTP request

GET https://<your-host>/api/requests/{id}/audit

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/requests/<id>/audit'

POST/api/requests/{id}/cancel

request access

Withdraw a request before execution begins.

SoD: an admin may cancel any request; a requester may cancel only their OWN request (matched against requests.created_by). The central route gate applies a coarse request floor; this handler enforces the finer requester-or-admin rule because the route table cannot see created_by.

Permissions

HTTP request

POST https://<your-host>/api/requests/{id}/cancel

Path parameters

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: ReasonBody.

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/requests/<id>/cancel'

GET/api/requests/{id}/evidence

audit access

A tamper-evident compliance evidence pack for ONE persisted request: the redacted evidence pack (from the pure engine pipeline, built off the REAL persisted request state) plus the durable, actor-attributed audit trail, sealed with a SHA-256 digest over the stable content.

The digest deliberately excludes generated_at, so re-exporting an unchanged request yields the SAME digest (tamper-evidence). Gated on the audit tier — the same identity-grade sensitivity as the audit trail.

Permissions

HTTP request

GET https://<your-host>/api/requests/{id}/evidence

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/requests/<id>/evidence'

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

{
  "request_id": null,
  "generated_at": null,
  "algorithm": "<string>",
  "digest": null,
  "durable": null,
  "item_count": null,
  "redacted": null,
  "content": null
}

POST/api/requests/{id}/execute

execute access

Execute requests.

Permissions

HTTP request

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

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 POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Idempotency-Key: <idempotency-key>' \
  'https://<your-host>/api/requests/<id>/execute'

GET/api/requests/{id}/execution-job

request access

The execution-agent job dispatched for this request (AWX bridge slice 3).

Read-only AWX-style "job" view: which agent ran it, the mode (dry-run/live), job + result status, the evidence digest, and timestamps. The full (sanitized) evidence lives on the request's stages via GET /api/requests/{id}; this surfaces the job itself. 404 when no job has been dispatched (e.g. request not yet executed).

Permissions

HTTP request

GET https://<your-host>/api/requests/{id}/execution-job

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/requests/<id>/execution-job'

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

{
  "request_id": null,
  "agent_job_id": null,
  "mode": null,
  "status": null,
  "result_status": null,
  "evidence_digest": null,
  "verification_ready": null,
  "created_at": null,
  "completed_at": null,
  "source": "<string>"
}

POST/api/requests/{id}/fail

execute access

Mark a request terminally Failed (e.g. an execution or verification failure).

mark a request terminally Failed (e.g. an execution or verification failure). Execute-tier; requires a reason. Valid from any non-concluded state.

Permissions

HTTP request

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

Path parameters

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: ReasonBody.

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/requests/<id>/fail'

POST/api/requests/{id}/lock

execute access

Lock requests.

Permissions

HTTP request

POST https://<your-host>/api/requests/{id}/lock

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/requests/<id>/lock'

POST/api/requests/{id}/plan

execute access

Plan requests.

Permissions

HTTP request

POST https://<your-host>/api/requests/{id}/plan

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/requests/<id>/plan'

GET/api/requests/{id}/policy-eval

request access

Evaluate the request's policy readiness against the guardrail catalog.

Informational (a read): it reports which guardrail rules' required inputs are satisfied; it does NOT gate the lifecycle. Degrades to 404 when the request is unknown.

Permissions

HTTP request

GET https://<your-host>/api/requests/{id}/policy-eval

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/requests/<id>/policy-eval'

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>",
  "request_id": null,
  "workflow_id": null,
  "applicable": null,
  "ready": null,
  "blocking_failures": null,
  "decisions": null
}

POST/api/requests/{id}/protect

execute access

The post-completion Protect stage (Theme 8).

Valid only from Completed; computes a dry-run backup-coverage summary for the delivered asset and transitions the request to Protecting. Operator- initiated; execute permission. Mirrors requests_verify (dual-store + CAS).

Permissions

HTTP request

POST https://<your-host>/api/requests/{id}/protect

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/requests/<id>/protect'

POST/api/requests/{id}/publish

execute access

The post-completion Publish stage (Theme 8).

Valid only from Protecting; imports the CI records and prepares the dry-run CMDB export, then transitions the request to Operational (its resting state). Operator-initiated; execute permission. Mirrors requests_verify.

Permissions

HTTP request

POST https://<your-host>/api/requests/{id}/publish

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/requests/<id>/publish'

POST/api/requests/{id}/reject

approve access

The approver "say no" act.

Valid only from Planned (the approval decision point); guarded by the approve permission (the inverse of approve). The mandatory reason is recorded in the audit trail and the rejection evidence. Terminal.

Permissions

HTTP request

POST https://<your-host>/api/requests/{id}/reject

Path parameters

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: ReasonBody.

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/requests/<id>/reject'

POST/api/requests/{id}/retire

execute access

The governed end-of-life stage (Theme 8).

Valid only from Operational; computes a dry-run decommission plan (quarantine-first, rollback-capable) and transitions the request to Retired (the terminal end-of-life state). Operator-initiated; execute permission. Mirrors requests_verify (dual-store + CAS).

Permissions

HTTP request

POST https://<your-host>/api/requests/{id}/retire

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/requests/<id>/retire'

POST/api/requests/{id}/rework

approve access

Send a request back to Intake for the requester to fix and re-submit (the non-terminal alternative to reject).

Approve-tier; requires a reason. Valid from Validated/Planned/Approved/Locked.

Permissions

HTTP request

POST https://<your-host>/api/requests/{id}/rework

Path parameters

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: ReasonBody.

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/requests/<id>/rework'

POST/api/requests/{id}/steps/{step_key}/approve-live-apply

admin access

.

.

Per-step mutation is intentionally disabled until each AwaitingApproval step has an admin-scoped, digest-bound safe review surface. Permission, parent scope, and separation-of-duties checks remain ahead of the generic 409 so the refusal preserves the route's non-enumeration contract.

Permissions

HTTP request

POST https://<your-host>/api/requests/{id}/steps/{step_key}/approve-live-apply

Path parameters

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: ReviewedLivePlanSelection.

Response

No successful response schema was extracted for this operation.

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 '{"approved_plan_job_id":"<uuid>","approved_plan_attempt_id":"<uuid>","approved_plan_digest":"<string>"}' \
  'https://<your-host>/api/requests/<id>/steps/<step_key>/approve-live-apply'

POST/api/requests/{id}/validate

execute access

Validate requests.

Permissions

HTTP request

POST https://<your-host>/api/requests/{id}/validate

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/requests/<id>/validate'

POST/api/requests/{id}/verify

execute access

Verify requests.

Permissions

HTTP request

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

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/requests/<id>/verify'