Platform API

GET/api/platform/database-readiness-contract

request access

Platform database readiness.

Permissions

HTTP request

GET https://<your-host>/api/platform/database-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/platform/database-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>",
  "databaseProvider": "<string>",
  "providerCallsEnabled": false,
  "kubernetesApplyAllowed": false,
  "cnpgClusterCreationAllowed": false,
  "databaseMutationAllowed": false,
  "schemaMigrationAllowed": false,
  "backupExecutionAllowed": false,
  "restoreExecutionAllowed": false,
  "objectStorageAccessAllowed": false,
  "credentialValuesAllowed": false,
  "connectionStringsAllowed": false,
  "rawDatabaseRowsAllowed": false,
  "rawBackupPayloadsAllowed": false,
  "rawKubernetesPayloadsAllowed": false,
  "rawProviderPayloadsAllowed": false,
  "readinessSurfaces": [],
  "requiredInputs": [],
  "requiredGuards": [],
  "planSections": [],
  "blockedReasons": [],
  "requiredEvidence": [],
  "rules": []
}

GET/api/platform/degradation-contract

request access

Degradation contract.

Permissions

HTTP request

GET https://<your-host>/api/platform/degradation-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/platform/degradation-contract'

POST/api/platform/degradation/check/{site}

admin access

Degradation check.

Permissions

HTTP request

POST https://<your-host>/api/platform/degradation/check/{site}

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/platform/degradation/check/<site>'

GET/api/platform/degradation/degraded

audit access

Degradation degraded.

Permissions

HTTP request

GET https://<your-host>/api/platform/degradation/degraded

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/platform/degradation/degraded'

POST/api/platform/degradation/enter/{site}

admin access

Degradation enter.

Permissions

HTTP request

POST https://<your-host>/api/platform/degradation/enter/{site}

Path parameters

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: DegradationEnterRequest.

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/platform/degradation/enter/<site>'

POST/api/platform/degradation/exit/{site}

admin access

Degradation exit.

Permissions

HTTP request

POST https://<your-host>/api/platform/degradation/exit/{site}

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/platform/degradation/exit/<site>'

GET/api/platform/degradation/global

audit access

Degradation global.

Permissions

HTTP request

GET https://<your-host>/api/platform/degradation/global

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/platform/degradation/global'

GET/api/platform/degradation/rules

audit access

Degradation rules.

Permissions

HTTP request

GET https://<your-host>/api/platform/degradation/rules

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/platform/degradation/rules'

GET/api/platform/design-system-contract

request access

Platform design system.

Permissions

HTTP request

GET https://<your-host>/api/platform/design-system-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/platform/design-system-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>",
  "designMode": "<string>",
  "lightModeRequired": false,
  "darkModeRequired": false,
  "accessibilityReviewRequired": false,
  "evidenceSafetyRequired": false,
  "liveThemeMutationAllowed": false,
  "externalFontFetchAllowed": false,
  "unsafeErrorDetailAllowed": false,
  "rawUiDiagnosticRowsAllowed": false,
  "rawEvidencePayloadsAllowed": false,
  "rawProviderPayloadsAllowed": false,
  "credentialValuesAllowed": false,
  "secretValuesAllowed": false,
  "accessTokenValuesAllowed": false,
  "rawRecipientDataAllowed": false,
  "brandTokens": [],
  "designSurfaces": [],
  "statusFamilies": [],
  "requiredInputs": [],
  "requiredGuards": [],
  "planSections": [],
  "blockedReasons": [],
  "requiredEvidence": [],
  "rules": []
}

GET/api/platform/health

audit access

Platform health.

Permissions

HTTP request

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

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

GET/api/platform/health/adapters

audit access

Platform health adapters.

Permissions

HTTP request

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

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

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>",
  "adapters": null
}

GET/api/platform/health/all

audit access

Component health checks.

These are SIMULATED (the health_monitor engine is pure / IO-free), so the overall status is NOT a live truth signal. The response is marked advisory and points at the real dependency-backed probe (#6) so a monitoring system can never mistake a hardcoded healthy for a live one (swarm finding #4). Additive: the original PlatformHealth fields are unchanged.

Permissions

HTTP request

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

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

GET/api/platform/health/check/{adapter}

audit access

Platform health check adapter.

Permissions

HTTP request

GET https://<your-host>/api/platform/health/check/{adapter}

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: ryuki_engine::health_monitor::HealthCheck.

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/platform/health/check/<adapter>'

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

{
  "name": "<string>",
  "component": "<string>",
  "status": {},
  "source": {},
  "last_check": "<string>",
  "message": "<string>"
}

GET/api/platform/health/components

audit access

Platform health components.

Permissions

HTTP request

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

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

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": null,
  "overall_status": null,
  "timestamp": null,
  "components": null
}

GET/api/platform/health/dependencies

audit access

Dependency-backed self-health (#6).

Unlike the binary /ready, this reports EACH backing dependency (database connectivity, migrations, scheduler liveness) and an aggregate verdict. Alerting-safe: a probe that errors is down (never silently healthy), and the aggregate maps to 200 (healthy/degraded — still serving) or 503 (unhealthy). Authenticated (it lives in the human-gated router).

Permissions

HTTP request

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

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 serde_json::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/platform/health/dependencies'

GET/api/platform/health/loops

audit access

Per-loop breakdown of the background-loop heartbeat registry.

The aggregate /api/platform/health/dependencies reports only THAT a loop is wedged; this reports WHICH loop, its cadence, how long it has been silent (age_secs), and its overdue threshold_secs, so an operator can diagnose. Authenticated like its sibling (it lives in the human-gated router; the loop names are already surfaced by the aggregate's down detail). A wedged loop maps to 503 (else 200); the body always carries the full breakdown.

Permissions

HTTP request

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

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 serde_json::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/platform/health/loops'

GET/api/platform/health/metrics

audit access

Platform health metrics text.

Permissions

HTTP request

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

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 operation returns a raw or text response body; no JSON shape applies.

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

GET/api/platform/kubernetes-runtime-readiness-contract

request access

Platform k8s runtime.

Permissions

HTTP request

GET https://<your-host>/api/platform/kubernetes-runtime-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/platform/kubernetes-runtime-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>",
  "runtimeProvider": "<string>",
  "deploymentTarget": "<string>",
  "providerCallsEnabled": false,
  "kubectlApplyAllowed": false,
  "helmInstallAllowed": false,
  "helmUpgradeAllowed": false,
  "kustomizeBuildAllowed": false,
  "clusterMutationAllowed": false,
  "namespaceMutationAllowed": false,
  "deploymentMutationAllowed": false,
  "serviceMutationAllowed": false,
  "ingressMutationAllowed": false,
  "networkPolicyMutationAllowed": false,
  "serviceAccountMutationAllowed": false,
  "sensitiveResourceMutationAllowed": false,
  "imagePullAllowed": false,
  "registryAccessAllowed": false,
  "rawKubernetesPayloadsAllowed": false,
  "rawProviderPayloadsAllowed": false,
  "kubeconfigValuesAllowed": false,
  "clusterIdentifiersAllowed": false,
  "sensitiveValuesAllowed": false,
  "readinessSurfaces": [],
  "ingressFrontTierProfiles": [],
  "ingressRoutePostures": [],
  "requiredInputs": [],
  "requiredGuards": [],
  "planSections": [],
  "blockedReasons": [],
  "requiredEvidence": [],
  "rules": []
}

GET/api/platform/local-container-readiness-contract

request access

Platform local container.

Permissions

HTTP request

GET https://<your-host>/api/platform/local-container-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/platform/local-container-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>",
  "runtimeProvider": "<string>",
  "deploymentTarget": "<string>",
  "providerCallsEnabled": false,
  "dockerComposeUpAllowed": false,
  "dockerComposeBuildAllowed": false,
  "dockerRunAllowed": false,
  "imagePushAllowed": false,
  "registryAccessAllowed": false,
  "serviceMutationAllowed": false,
  "networkMutationAllowed": false,
  "portBindingMutationAllowed": false,
  "environmentValuesAllowed": false,
  "envFileAllowed": false,
  "volumeMountsAllowed": false,
  "providerServiceAllowed": false,
  "externalEgressAllowed": false,
  "rawRuntimePayloadsAllowed": false,
  "providerReturnedContentAllowed": false,
  "sensitiveAuthValuesAllowed": false,
  "runtimeIdentifiersAllowed": false,
  "readinessSurfaces": [],
  "requiredInputs": [],
  "requiredGuards": [],
  "planSections": [],
  "blockedReasons": [],
  "requiredEvidence": [],
  "rules": []
}

GET/api/platform/object-storage-readiness-contract

request access

Platform object storage.

Permissions

HTTP request

GET https://<your-host>/api/platform/object-storage-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/platform/object-storage-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>",
  "storageProvider": "<string>",
  "providerCallsEnabled": false,
  "azureApiCallsAllowed": false,
  "storageAccountMutationAllowed": false,
  "containerMutationAllowed": false,
  "blobReadWriteAllowed": false,
  "lifecyclePolicyMutationAllowed": false,
  "immutabilityPolicyMutationAllowed": false,
  "publicNetworkAccessAllowed": false,
  "sharedKeyUsageAllowed": false,
  "sasTokenValuesAllowed": false,
  "credentialValuesAllowed": false,
  "connectionStringsAllowed": false,
  "rawBlobPayloadsAllowed": false,
  "rawStoragePayloadsAllowed": false,
  "rawProviderPayloadsAllowed": false,
  "storageIdentifiersAllowed": false,
  "readinessSurfaces": [],
  "requiredInputs": [],
  "requiredGuards": [],
  "planSections": [],
  "blockedReasons": [],
  "requiredEvidence": [],
  "rules": []
}

GET/api/platform/portal-information-architecture-contract

request access

Platform portal ia.

Permissions

HTTP request

GET https://<your-host>/api/platform/portal-information-architecture-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/platform/portal-information-architecture-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>",
  "architectureMode": "<string>",
  "portalRuntime": "<string>",
  "browserIsolationRequired": false,
  "stableNavigationRequired": false,
  "sameOriginApiRoutingRequired": false,
  "ssrRequired": false,
  "hydrationRequired": false,
  "serverFunctionBoundaryRequired": false,
  "browserProviderCallsAllowed": false,
  "externalApiCallsAllowed": false,
  "staticOnlyHostingAllowed": false,
  "roleBypassAllowed": false,
  "unsafeAdminDetailAllowed": false,
  "rawSearchRowsAllowed": false,
  "rawEvidencePayloadsAllowed": false,
  "rawProviderPayloadsAllowed": false,
  "credentialValuesAllowed": false,
  "secretValuesAllowed": false,
  "accessTokenValuesAllowed": false,
  "rawRecipientDataAllowed": false,
  "architectureSurfaces": [],
  "primaryNavigation": [],
  "personaViews": [],
  "requiredInputs": [],
  "requiredGuards": [],
  "planSections": [],
  "blockedReasons": [],
  "requiredEvidence": [],
  "rules": []
}

GET/api/platform/registry-readiness-contract

request access

Platform registry readiness.

Permissions

HTTP request

GET https://<your-host>/api/platform/registry-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/platform/registry-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>",
  "registryProvider": "<string>",
  "providerCallsEnabled": false,
  "harborApiCallsAllowed": false,
  "registryPushAllowed": false,
  "registryPullAllowed": false,
  "projectMutationAllowed": false,
  "robotAccountMutationAllowed": false,
  "retentionPolicyMutationAllowed": false,
  "immutabilityRuleMutationAllowed": false,
  "scannerMutationAllowed": false,
  "replicationMutationAllowed": false,
  "webhookMutationAllowed": false,
  "credentialValuesAllowed": false,
  "robotSecretValuesAllowed": false,
  "registryUrlsAllowed": false,
  "imageDigestsAllowed": false,
  "rawRegistryPayloadsAllowed": false,
  "rawScannerPayloadsAllowed": false,
  "rawProviderPayloadsAllowed": false,
  "registryIdentifiersAllowed": false,
  "readinessSurfaces": [],
  "requiredInputs": [],
  "requiredGuards": [],
  "planSections": [],
  "blockedReasons": [],
  "requiredEvidence": [],
  "rules": []
}

GET/api/platform/release-promotion-contract

request access

Platform release promotion.

Permissions

HTTP request

GET https://<your-host>/api/platform/release-promotion-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/platform/release-promotion-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>",
  "promotionMode": "<string>",
  "dryRunRequired": false,
  "providerCallsEnabled": false,
  "liveDeploymentAllowed": false,
  "registryPushAllowed": false,
  "helmUpgradeAllowed": false,
  "kubectlApplyAllowed": false,
  "clusterMutationAllowed": false,
  "credentialValuesAllowed": false,
  "rawPipelineLogsAllowed": false,
  "rawRegistryPayloadsAllowed": false,
  "rawProviderPayloadsAllowed": false,
  "promotionStages": [],
  "validationSignals": [],
  "requiredInputs": [],
  "requiredGuards": [],
  "planSections": [],
  "blockedReasons": [],
  "requiredEvidence": [],
  "rules": []
}

GET/api/platform/security-baseline-contract

request access

Platform security baseline.

Permissions

HTTP request

GET https://<your-host>/api/platform/security-baseline-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/platform/security-baseline-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>",
  "baselineMode": "<string>",
  "noSecretPolicyRequired": false,
  "browserIsolationRequired": false,
  "networkIsolationRequired": false,
  "rbacApprovalRequired": false,
  "dryRunRequired": false,
  "redactedEvidenceRequired": false,
  "verificationGatesRequired": false,
  "providerCallsAllowed": false,
  "liveAuthenticationAllowed": false,
  "workflowMutationAllowed": false,
  "policyMutationAllowed": false,
  "approvalBypassAllowed": false,
  "rbacBypassAllowed": false,
  "browserVendorEndpointAllowed": false,
  "rawRequestPayloadsAllowed": false,
  "rawProviderPayloadsAllowed": false,
  "rawEvidencePayloadsAllowed": false,
  "rawLogContentAllowed": false,
  "credentialValuesAllowed": false,
  "secretValuesAllowed": false,
  "accessTokenValuesAllowed": false,
  "rawRecipientDataAllowed": false,
  "securityControls": [],
  "verificationGates": [],
  "requiredInputs": [],
  "requiredGuards": [],
  "planSections": [],
  "blockedReasons": [],
  "requiredEvidence": [],
  "rules": []
}

GET/api/platform/status

audit access

Platform status.

Permissions

HTTP request

GET https://<your-host>/api/platform/status

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 serde_json::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/platform/status'

GET/api/platform/status-contract

request access

Platform status contract.

Permissions

HTTP request

GET https://<your-host>/api/platform/status-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/platform/status-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>",
  "mode": "<string>",
  "status": "<string>",
  "providerCallsAllowed": false,
  "liveExecutionAllowed": false,
  "workflowMutationAllowed": false,
  "credentialValuesAllowed": false,
  "secretValuesAllowed": false,
  "rawProviderPayloadsAllowed": false,
  "rawRecipientDataAllowed": false,
  "tenantIdentifiersAllowed": false,
  "objectIdentifiersAllowed": false,
  "privateNetworkValuesAllowed": false,
  "guards": null,
  "blockedReasons": []
}

GET/api/platform/summary

public accessno bearer auth required

Platform summary.

Permissions

HTTP request

GET https://<your-host>/api/platform/summary

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 \
  'https://<your-host>/api/platform/summary'

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

{
  "productName": null,
  "lifecycleStages": null,
  "components": null,
  "guardrails": null,
  "browserIsolation": false,
  "localAuthorization": null
}

GET/api/platform/ui-mockup-acceptance-contract

request access

Platform ui mockup.

Permissions

HTTP request

GET https://<your-host>/api/platform/ui-mockup-acceptance-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/platform/ui-mockup-acceptance-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>",
  "acceptanceMode": "<string>",
  "mockupCoverageRequired": false,
  "accessibilityReviewRequired": false,
  "browserIsolationRequired": false,
  "evidenceSafetyRequired": false,
  "liveUiExecutionAllowed": false,
  "browserProviderCallsAllowed": false,
  "externalAssetFetchAllowed": false,
  "directVendorApiAllowed": false,
  "unsafeDebugDetailAllowed": false,
  "rawMockupRowsAllowed": false,
  "rawEvidencePayloadsAllowed": false,
  "rawProviderPayloadsAllowed": false,
  "credentialValuesAllowed": false,
  "secretValuesAllowed": false,
  "accessTokenValuesAllowed": false,
  "rawRecipientDataAllowed": false,
  "mockupDocuments": [],
  "mockupSurfaces": [],
  "requiredInputs": [],
  "requiredGuards": [],
  "planSections": [],
  "blockedReasons": [],
  "requiredEvidence": [],
  "rules": []
}

GET/api/platform/uptime

audit access

Uptime.

Permissions

HTTP request

GET https://<your-host>/api/platform/uptime

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: serde_json::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/platform/uptime'

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

{
  "uptime_seconds": null,
  "uptime_human": null
}

GET/api/platform/vault-deployment-readiness-contract

request access

Platform vault deployment.

Permissions

HTTP request

GET https://<your-host>/api/platform/vault-deployment-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/platform/vault-deployment-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>",
  "vaultProvider": "<string>",
  "deploymentTarget": "<string>",
  "providerCallsEnabled": false,
  "vaultApiCallsAllowed": false,
  "helmInstallAllowed": false,
  "helmUpgradeAllowed": false,
  "kubectlApplyAllowed": false,
  "vaultInitAllowed": false,
  "vaultUnsealAllowed": false,
  "vaultPolicyMutationAllowed": false,
  "kubernetesAuthMutationAllowed": false,
  "secretWriteAllowed": false,
  "injectorMutationAllowed": false,
  "autoUnsealMutationAllowed": false,
  "auditLogReadAllowed": false,
  "rawVaultPayloadsAllowed": false,
  "rawKubernetesPayloadsAllowed": false,
  "rawProviderPayloadsAllowed": false,
  "secretValuesAllowed": false,
  "vaultIdentifiersAllowed": false,
  "readinessSurfaces": [],
  "requiredInputs": [],
  "requiredGuards": [],
  "planSections": [],
  "blockedReasons": [],
  "requiredEvidence": [],
  "rules": []
}

GET/api/platform/vault-secret-delivery-contract

request access

Platform vault secret delivery.

Permissions

HTTP request

GET https://<your-host>/api/platform/vault-secret-delivery-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/platform/vault-secret-delivery-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>",
  "deliveryProvider": "<string>",
  "providerCallsEnabled": false,
  "vaultApiCallsAllowed": false,
  "kubernetesApplyAllowed": false,
  "helmInstallAllowed": false,
  "helmUpgradeAllowed": false,
  "crdApplyAllowed": false,
  "vaultConnectionMutationAllowed": false,
  "vaultAuthMutationAllowed": false,
  "vaultStaticSecretMutationAllowed": false,
  "kubernetesSecretMutationAllowed": false,
  "secretDataReadAllowed": false,
  "secretDataWriteAllowed": false,
  "rolloutRestartAllowed": false,
  "transformationTemplateAllowed": false,
  "rawVaultPayloadsAllowed": false,
  "rawKubernetesPayloadsAllowed": false,
  "rawProviderPayloadsAllowed": false,
  "secretValuesAllowed": false,
  "vaultIdentifiersAllowed": false,
  "deliverySurfaces": [],
  "requiredInputs": [],
  "requiredGuards": [],
  "planSections": [],
  "blockedReasons": [],
  "requiredEvidence": [],
  "rules": []
}

GET/health

public accessno bearer auth required

Health.

Permissions

HTTP request

GET https://<your-host>/health

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: serde_json::Value.

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

Errors

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

Examples

Request

curl --silent --show-error --globoff \
  --request GET \
  'https://<your-host>/health'

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

{
  "status": null,
  "database": null,
  "config": null,
  "auth_mode": null,
  "rate_limit_enabled": null
}

GET/metrics

audit access

Metrics.

Permissions

HTTP request

GET https://<your-host>/metrics

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 operation returns a raw or text response body; no JSON shape applies.

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

GET/ready

public accessno bearer auth required

Ready.

Permissions

HTTP request

GET https://<your-host>/ready

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 serde_json::Value. Its field schema is unavailable, so no JSON shape is inferred.

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

Errors

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

Examples

Request

curl --silent --show-error --globoff \
  --request GET \
  'https://<your-host>/ready'