Operations API

GET/api/operations/activity-queue-contract

request access

Operations activity queue.

Permissions

HTTP request

GET https://<your-host>/api/operations/activity-queue-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/operations/activity-queue-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>",
  "activityOperationQueueMode": "<string>",
  "queueSummaryReadOnly": false,
  "childOperationSummaryReadOnly": false,
  "lockStateReadOnly": false,
  "retryStateReadOnly": false,
  "blockedReasonSummaryOnly": false,
  "liveQueueQueryAllowed": false,
  "operationMutationAllowed": false,
  "workflowMutationAllowed": false,
  "workerDispatchAllowed": false,
  "providerCallsAllowed": false,
  "notificationDispatchAllowed": false,
  "rawOperationRowsAllowed": false,
  "rawChildOperationRowsAllowed": false,
  "rawLockRowsAllowed": false,
  "rawRetryRowsAllowed": false,
  "rawExecutionLogsAllowed": false,
  "rawProviderPayloadsAllowed": false,
  "rawUserDataAllowed": false,
  "rawRecipientDataAllowed": false,
  "credentialValuesAllowed": false,
  "tokenValuesAllowed": false,
  "tenantIdentifiersAllowed": false,
  "objectIdentifiersAllowed": false,
  "principalIdentifiersAllowed": false,
  "privateNetworkValuesAllowed": false,
  "queueItemTypes": [],
  "queueStates": [],
  "queueLenses": [],
  "requiredGuards": [],
  "blockedReasons": [],
  "requiredEvidence": [],
  "rules": []
}

GET/api/operations/aiops-suggestion-contract

request access

Operations aiops suggestion.

Permissions

HTTP request

GET https://<your-host>/api/operations/aiops-suggestion-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/operations/aiops-suggestion-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>",
  "suggestionMode": "<string>",
  "dryRunRequired": false,
  "providerCallsEnabled": false,
  "liveCorrelationAllowed": false,
  "liveRemediationAllowed": false,
  "liveTicketMutationAllowed": false,
  "automationDispatchAllowed": false,
  "rawOperationRowsAllowed": false,
  "rawHealthRowsAllowed": false,
  "rawLogPayloadsAllowed": false,
  "rawUserDataAllowed": false,
  "rawRecipientDataAllowed": false,
  "rawProviderPayloadsAllowed": false,
  "suggestionSources": [],
  "suggestionSignals": [],
  "requiredInputs": [],
  "requiredGuards": [],
  "planSections": [],
  "blockedReasons": [],
  "requiredEvidence": [],
  "rules": []
}

GET/api/operations/certificate-lifecycle-contract

request access

Operations certificate lifecycle.

Permissions

HTTP request

GET https://<your-host>/api/operations/certificate-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/operations/certificate-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>",
  "providerCallsEnabled": false,
  "targets": [],
  "actions": [],
  "requiredGuards": [],
  "planSections": [],
  "blockedReasons": []
}

GET/api/operations/datacenter-readiness-contract

request access

Operations datacenter readiness.

Permissions

HTTP request

GET https://<your-host>/api/operations/datacenter-readiness-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/operations/datacenter-readiness-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>",
  "readinessMode": "<string>",
  "providerCallsEnabled": false,
  "liveExecutionAllowed": false,
  "rawInventoryRowsAllowed": false,
  "readinessDomains": [],
  "requiredInputs": [],
  "requiredGuards": [],
  "planSections": [],
  "blockedReasons": [],
  "requiredEvidence": [],
  "rules": []
}

GET/api/operations/datacenter-readiness-review

audit access

Dry-run operations datacenter-readiness review.

Turns the static operations/datacenter-readiness descriptor into a real decision: evaluate the readiness guards over a proposed datacenter-readiness request and return datacenter-readiness-recorded (all criteria met; the live provisioning is a separately-approved step) or block. Never provisions (distinct from the stateful datacenter_readiness engine).

Permissions

HTTP request

GET https://<your-host>/api/operations/datacenter-readiness-review

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/operations/datacenter-readiness-review'

GET/api/operations/degradation-mode-contract

request access

Operations degradation mode.

Permissions

HTTP request

GET https://<your-host>/api/operations/degradation-mode-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/operations/degradation-mode-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>",
  "degradationMode": "<string>",
  "providerCallsEnabled": false,
  "liveExecutionAllowed": false,
  "failoverAutomationAllowed": false,
  "rawProviderPayloadsAllowed": false,
  "degradationScopes": [],
  "degradationStates": [],
  "safeCapabilities": [],
  "requiredInputs": [],
  "requiredGuards": [],
  "blockedReasons": [],
  "requiredEvidence": [],
  "rules": []
}

GET/api/operations/degradation-mode-readiness

audit access

Dry-run operations degradation-mode change readiness.

Turns the static operations/degradation-mode descriptor into a real decision: evaluate the readiness guards over a proposed degradation-mode change and return degradation-review-recorded (all criteria met; the live action is a separately-approved step) or block. Never changes live degradation state (distinct from the stateful degradation_mode engine).

Permissions

HTTP request

GET https://<your-host>/api/operations/degradation-mode-readiness

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/operations/degradation-mode-readiness'

GET/api/operations/dependency-replay-contract

request access

Operations dependency replay.

Permissions

HTTP request

GET https://<your-host>/api/operations/dependency-replay-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/operations/dependency-replay-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>",
  "operationDependencyReplayMode": "<string>",
  "dependencyGraphReadOnly": false,
  "replaySimulationDryRunOnly": false,
  "lockStateReadOnly": false,
  "liveReplayAllowed": false,
  "operationMutationAllowed": false,
  "childOperationMutationAllowed": false,
  "lockMutationAllowed": false,
  "retryMutationAllowed": false,
  "providerCallsAllowed": false,
  "workflowMutationAllowed": false,
  "rawOperationRowsAllowed": false,
  "rawExecutionLogsAllowed": false,
  "rawReplayPayloadsAllowed": false,
  "rawProviderPayloadsAllowed": false,
  "rawRecipientDataAllowed": false,
  "credentialValuesAllowed": false,
  "tenantIdentifiersAllowed": false,
  "objectIdentifiersAllowed": false,
  "privateNetworkValuesAllowed": false,
  "serialNumbersAllowed": false,
  "graphNodeTypes": [],
  "graphEdgeTypes": [],
  "replayPhases": [],
  "requiredGuards": [],
  "blockedReasons": [],
  "requiredEvidence": [],
  "rules": []
}

GET/api/operations/emergency-change-contract

request access

Operations emergency change.

Permissions

HTTP request

GET https://<your-host>/api/operations/emergency-change-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/operations/emergency-change-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": []
}

GET/api/operations/failure-patterns

request access

The LIVE failure-pattern knowledge base (#41).

The failure_patterns table (migration 028) was seeded but never read by the API; this exposes it as a real read surface alongside the knowledge-suggestion contract/readiness endpoints. Request-tier read, ordered by occurrence_count DESC (most frequent first). This is a global knowledge base with no site dimension, so no per-site scoping applies. The suggested_article_body (potentially long) is omitted from the list; the title + summary fields are returned. Empty + durable:false when no DB.

Permissions

HTTP request

GET https://<your-host>/api/operations/failure-patterns

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/operations/failure-patterns'

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

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

GET/api/operations/firmware-compliance-exception-contract

request access

Operations firmware compliance.

Permissions

HTTP request

GET https://<your-host>/api/operations/firmware-compliance-exception-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/operations/firmware-compliance-exception-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>",
  "exceptionMode": "<string>",
  "dryRunRequired": false,
  "providerCallsEnabled": false,
  "liveFirmwareChangesAllowed": false,
  "rawInventoryRowsAllowed": false,
  "hostIdentifiersAllowed": false,
  "serialNumbersAllowed": false,
  "exactFirmwareVersionsAllowed": false,
  "rawVendorPayloadsAllowed": false,
  "supportedProfiles": [],
  "exceptionTypes": [],
  "riskLevels": [],
  "requiredInputs": [],
  "requiredGuards": [],
  "planSections": [],
  "blockedReasons": [],
  "requiredEvidence": [],
  "rules": []
}

GET/api/operations/hardware-lifecycle-contract

request access

Operations hardware lifecycle.

Permissions

HTTP request

GET https://<your-host>/api/operations/hardware-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/operations/hardware-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>",
  "providerCallsEnabled": false,
  "liveExecutionAllowed": false,
  "serialNumbersAllowed": false,
  "supportedProfiles": [],
  "lifecycleStates": [],
  "requiredInputs": [],
  "requiredGuards": [],
  "planSections": [],
  "blockedReasons": [],
  "requiredEvidence": [],
  "rules": []
}

GET/api/operations/hardware-lifecycle-readiness

audit access

Dry-run operations hardware-lifecycle readiness.

Turns the static operations/hardware-lifecycle descriptor into a real decision: evaluate the readiness guards over a proposed hardware-lifecycle action and return hardware-lifecycle-recorded (all criteria met; the live change is a separately-approved step) or block. Never changes live hardware state (distinct from the stateful hardware_lifecycle engine).

Permissions

HTTP request

GET https://<your-host>/api/operations/hardware-lifecycle-readiness

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/operations/hardware-lifecycle-readiness'

GET/api/operations/incident-context-contract

request access

Operations incident context.

Permissions

HTTP request

GET https://<your-host>/api/operations/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/operations/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>",
  "panelMode": "<string>",
  "providerCallsEnabled": false,
  "liveExecutionAllowed": false,
  "rawProviderPayloadsAllowed": false,
  "contextDomains": [],
  "panelSections": [],
  "requiredInputs": [],
  "requiredGuards": [],
  "blockedReasons": [],
  "requiredEvidence": [],
  "rules": []
}

GET/api/operations/incident-context-readiness

audit access

Dry-run operations incident-context readiness.

Turns the static operations/incident-context descriptor into a real decision: evaluate the readiness guards over a proposed incident-context enrichment and return incident-context-recorded (all criteria met; the live action is a separately- approved step) or block. Never mutates an incident (distinct from the stateful incident_context engine).

Permissions

HTTP request

GET https://<your-host>/api/operations/incident-context-readiness

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/operations/incident-context-readiness'

GET/api/operations/knowledge-suggestion-contract

request access

Operations knowledge suggestion.

Permissions

HTTP request

GET https://<your-host>/api/operations/knowledge-suggestion-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/operations/knowledge-suggestion-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>",
  "suggestionMode": "<string>",
  "dryRunRequired": false,
  "providerCallsEnabled": false,
  "liveKnowledgePublishAllowed": false,
  "liveTicketMutationAllowed": false,
  "rawOperationRowsAllowed": false,
  "rawLogPayloadsAllowed": false,
  "rawErrorDetailsAllowed": false,
  "rawUserDataAllowed": false,
  "rawRecipientDataAllowed": false,
  "rawProviderPayloadsAllowed": false,
  "suggestionSources": [],
  "suggestionSignals": [],
  "requiredInputs": [],
  "requiredGuards": [],
  "planSections": [],
  "blockedReasons": [],
  "requiredEvidence": [],
  "rules": []
}

GET/api/operations/knowledge-suggestion-readiness

request access

Dry-run operations knowledge-suggestion readiness.

Turns the static operations/knowledge-suggestion descriptor into a real decision: evaluate the readiness guards over a proposed knowledge/runbook suggestion and return suggestion-recorded (all criteria met; publication is a separately-approved step) or block. Never publishes knowledge or mutates tickets; evidence is referenced by summary only.

Permissions

HTTP request

GET https://<your-host>/api/operations/knowledge-suggestion-readiness

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/operations/knowledge-suggestion-readiness'

GET/api/operations/maintenance-communications-contract

request access

Operations maintenance comm.

Permissions

HTTP request

GET https://<your-host>/api/operations/maintenance-communications-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/operations/maintenance-communications-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>",
  "communicationMode": "<string>",
  "providerCallsEnabled": false,
  "liveNotificationAllowed": false,
  "rawRecipientDataAllowed": false,
  "messageTypes": [],
  "communicationChannels": [],
  "requiredInputs": [],
  "requiredGuards": [],
  "blockedReasons": [],
  "requiredEvidence": [],
  "rules": []
}

GET/api/operations/maintenance-communications-readiness

audit access

Dry-run operations maintenance-communication readiness.

Turns the static operations/maintenance-comm descriptor into a real decision: evaluate the readiness guards over a proposed maintenance notification and return comm-plan-recorded (all criteria met; live dispatch is a separately-approved step) or block. Never dispatches a notification or exposes recipient data.

Permissions

HTTP request

GET https://<your-host>/api/operations/maintenance-communications-readiness

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/operations/maintenance-communications-readiness'

GET/api/operations/network-vlan-readiness

audit access

Dry-run operations network VLAN/port-group provisioning readiness.

Turns the static operations/network-vlan descriptor into a real decision: evaluate the readiness guards over a proposed provisioning request and return vlan-plan-recorded (all criteria met; the live network change is a separately-approved step) or block. Never changes live network state.

Permissions

HTTP request

GET https://<your-host>/api/operations/network-vlan-readiness

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/operations/network-vlan-readiness'

GET/api/operations/network-vlan-readiness-contract

request access

Operations network vlan.

Permissions

HTTP request

GET https://<your-host>/api/operations/network-vlan-readiness-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/operations/network-vlan-readiness-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>",
  "readinessMode": "<string>",
  "providerCallsEnabled": false,
  "liveNetworkChangesAllowed": false,
  "rawInventoryRowsAllowed": false,
  "networkIdentifiersAllowed": false,
  "supportedWorkflows": [],
  "readinessDomains": [],
  "requiredInputs": [],
  "requiredGuards": [],
  "planSections": [],
  "blockedReasons": [],
  "requiredEvidence": [],
  "rules": []
}

GET/api/operations/out-of-band-access-validation-contract

request access

Operations oob access.

Permissions

HTTP request

GET https://<your-host>/api/operations/out-of-band-access-validation-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/operations/out-of-band-access-validation-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>",
  "validationMode": "<string>",
  "providerCallsEnabled": false,
  "liveAccessChecksAllowed": false,
  "liveCertificateChecksAllowed": false,
  "rawInventoryRowsAllowed": false,
  "endpointIdentifiersAllowed": false,
  "serialNumbersAllowed": false,
  "accountIdentifiersAllowed": false,
  "supportedConsoleTypes": [],
  "supportedWorkflows": [],
  "readinessDomains": [],
  "requiredInputs": [],
  "requiredGuards": [],
  "planSections": [],
  "blockedReasons": [],
  "requiredEvidence": [],
  "rules": []
}

GET/api/operations/outage-comms-contract

request access

Outage contract.

Permissions

HTTP request

GET https://<your-host>/api/operations/outage-comms-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/operations/outage-comms-contract'

GET/api/operations/outage-comms/active

audit access

Outage notices active.

Permissions

HTTP request

GET https://<your-host>/api/operations/outage-comms/active

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/operations/outage-comms/active?site=<site>'

GET/api/operations/outage-comms/history

audit access

Outage notices history.

Permissions

HTTP request

GET https://<your-host>/api/operations/outage-comms/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.

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/operations/outage-comms/history?site=<site>'

GET/api/operations/outage-comms/notices

audit access

List outage notices.

Permissions

HTTP request

GET https://<your-host>/api/operations/outage-comms/notices

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; the filtered total is exposed via the X-Total-Count response header.

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/operations/outage-comms/notices'

POST/api/operations/outage-comms/notices

admin access

Create outage notices.

Permissions

HTTP request

POST https://<your-host>/api/operations/outage-comms/notices

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: OutageNoticeCreateRequest.

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 '{"site":"<string>","affectedSystems":[],"startTime":"<string>","endTime":"<string>","impactLevel":"<string>"}' \
  'https://<your-host>/api/operations/outage-comms/notices'

GET/api/operations/outage-comms/notices/{id}

audit access

Get outage notices.

Permissions

HTTP request

GET https://<your-host>/api/operations/outage-comms/notices/{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/operations/outage-comms/notices/<id>'

POST/api/operations/outage-comms/notices/{id}/acknowledge

admin access

Acknowledge outage notices.

Permissions

HTTP request

POST https://<your-host>/api/operations/outage-comms/notices/{id}/acknowledge

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/operations/outage-comms/notices/<id>/acknowledge'

POST/api/operations/outage-comms/notices/{id}/cancel

admin access

Cancel outage notices.

Permissions

HTTP request

POST https://<your-host>/api/operations/outage-comms/notices/{id}/cancel

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/operations/outage-comms/notices/<id>/cancel'

POST/api/operations/outage-comms/notices/{id}/complete

admin access

Complete outage notices.

Permissions

HTTP request

POST https://<your-host>/api/operations/outage-comms/notices/{id}/complete

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/operations/outage-comms/notices/<id>/complete'

GET/api/operations/outage-comms/notices/{id}/preview

audit access

Outage notices preview.

Permissions

HTTP request

GET https://<your-host>/api/operations/outage-comms/notices/{id}/preview

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/operations/outage-comms/notices/<id>/preview'

POST/api/operations/outage-comms/notices/{id}/send

admin access

Send outage notices.

Permissions

HTTP request

POST https://<your-host>/api/operations/outage-comms/notices/{id}/send

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/operations/outage-comms/notices/<id>/send'

GET/api/operations/outage-comms/upcoming

audit access

Outage notices upcoming.

Permissions

HTTP request

GET https://<your-host>/api/operations/outage-comms/upcoming

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/operations/outage-comms/upcoming?site=<site>'

GET/api/operations/platform-health-contract

request access

Operations platform health.

Permissions

HTTP request

GET https://<your-host>/api/operations/platform-health-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/operations/platform-health-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>",
  "healthMode": "<string>",
  "providerCallsEnabled": false,
  "liveExecutionAllowed": false,
  "rawLogsAllowed": false,
  "components": [],
  "healthSignals": [],
  "healthStates": [],
  "requiredInputs": [],
  "requiredGuards": [],
  "blockedReasons": [],
  "requiredEvidence": [],
  "rules": []
}

GET/api/operations/platform-health-readiness

audit access

Dry-run operations platform-health remediation readiness.

Turns the static operations/platform-health descriptor into a real decision: evaluate the readiness guards over a proposed health-remediation review and return health-review-recorded (all criteria met; the live remediation is a separately-approved step) or block. Never executes a remediation or exposes raw logs.

Permissions

HTTP request

GET https://<your-host>/api/operations/platform-health-readiness

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/operations/platform-health-readiness'

GET/api/operations/run-state-contract

request access

Operations run state.

Permissions

HTTP request

GET https://<your-host>/api/operations/run-state-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/operations/run-state-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>",
  "operationRunStateMode": "<string>",
  "operationStateReadOnly": false,
  "childOperationStateReadOnly": false,
  "lockStateReadOnly": false,
  "retryStateReadOnly": false,
  "redactedLogSummaryOnly": false,
  "liveExecutionAllowed": false,
  "workerDispatchAllowed": false,
  "providerCallsAllowed": false,
  "operationMutationAllowed": false,
  "childOperationMutationAllowed": false,
  "lockMutationAllowed": false,
  "retryMutationAllowed": false,
  "workflowMutationAllowed": false,
  "rawOperationRowsAllowed": false,
  "rawChildOperationRowsAllowed": false,
  "rawExecutionLogsAllowed": false,
  "rawLockRowsAllowed": false,
  "rawRetryRowsAllowed": false,
  "rawProviderPayloadsAllowed": false,
  "rawRecipientDataAllowed": false,
  "credentialValuesAllowed": false,
  "tokenValuesAllowed": false,
  "tenantIdentifiersAllowed": false,
  "objectIdentifiersAllowed": false,
  "privateNetworkValuesAllowed": false,
  "serialNumbersAllowed": false,
  "operationStates": [],
  "childOperationStates": [],
  "lockStates": [],
  "retryStates": [],
  "logStates": [],
  "requiredGuards": [],
  "blockedReasons": [],
  "requiredEvidence": [],
  "rules": []
}

GET/api/operations/runbook-launch-contract

request access

Operations runbook launch.

Permissions