Evidence API

POST/api/evidence/collect

execute access

Evidence collect.

Permissions

HTTP request

POST https://<your-host>/api/evidence/collect

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: ryuki_engine::models::EvidencePack.

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/evidence/collect'

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

{
  "id": "<string>",
  "request_id": "<string>",
  "items": [],
  "redacted": false,
  "created_at": "<string>",
  "format": "<string>",
  "compliance_checks": [],
  "metadata": {}
}

GET/api/evidence/compliance-dashboard-contract

request access

Evidence compliance dashboard.

Permissions

HTTP request

GET https://<your-host>/api/evidence/compliance-dashboard-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/evidence/compliance-dashboard-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>",
  "complianceDashboardMode": "<string>",
  "evidenceRequired": false,
  "providerCallsEnabled": false,
  "liveEvaluationAllowed": false,
  "evidenceMutationAllowed": false,
  "exportMutationAllowed": false,
  "retentionMutationAllowed": false,
  "workflowMutationAllowed": false,
  "notificationDispatchAllowed": false,
  "rawEvidencePayloadsAllowed": false,
  "rawControlRowsAllowed": false,
  "rawAuditLogsAllowed": false,
  "rawUserDataAllowed": false,
  "rawProviderPayloadsAllowed": false,
  "rawRecipientDataAllowed": false,
  "credentialValuesAllowed": false,
  "tokenValuesAllowed": false,
  "tenantIdentifiersAllowed": false,
  "objectIdentifiersAllowed": false,
  "principalIdentifiersAllowed": false,
  "privateNetworkValuesAllowed": false,
  "domains": [],
  "statusBands": [],
  "trendWindows": [],
  "requiredGuards": [],
  "blockedReasons": [],
  "requiredEvidence": []
}

GET/api/evidence/export

audit access

Export evidence.

Permissions

HTTP request

GET https://<your-host>/api/evidence/export

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/evidence/export'

GET/api/evidence/export-retention-contract

request access

Evidence export retention.

Permissions

HTTP request

GET https://<your-host>/api/evidence/export-retention-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/evidence/export-retention-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>",
  "exportRetentionMode": "<string>",
  "redactionRequired": false,
  "providerCallsEnabled": false,
  "liveEvidenceMutationAllowed": false,
  "exportPackageMutationAllowed": false,
  "retentionPolicyMutationAllowed": false,
  "liveAuditSearchAllowed": false,
  "auditSearchQueryAllowed": false,
  "evidencePayloadsAllowed": false,
  "rawRequestPayloadsAllowed": false,
  "rawProviderPayloadsAllowed": false,
  "rawEvidencePayloadsAllowed": false,
  "rawLogContentAllowed": false,
  "unfilteredLogsAllowed": false,
  "stackTracesAllowed": false,
  "rawRowsAllowed": false,
  "serialNumbersAllowed": false,
  "exportWithoutRedactionAllowed": false,
  "credentialValuesAllowed": false,
  "secretValuesAllowed": false,
  "tokenValuesAllowed": false,
  "tenantIdentifiersAllowed": false,
  "objectIdentifiersAllowed": false,
  "privateNetworkValuesAllowed": false,
  "rawRecipientDataAllowed": false,
  "redactionStates": [],
  "exportReadiness": [],
  "safeExportTargets": [],
  "prohibitedContent": [],
  "retentionClasses": [],
  "auditSearchStates": [],
  "searchFacets": [],
  "packageFields": [],
  "requiredGuards": [],
  "requiredEvidence": [],
  "blockedReasons": []
}

POST/api/evidence/redact

execute access

Evidence redact.

Permissions

HTTP request

POST https://<your-host>/api/evidence/redact

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: EvidenceRedactRequest.

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 '{"pack":null}' \
  'https://<your-host>/api/evidence/redact'

POST/api/evidence/verify-compliance

execute access

Evidence verify compliance.

Permissions

HTTP request

POST https://<your-host>/api/evidence/verify-compliance

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: EvidenceRedactRequest.

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 '{"pack":null}' \
  'https://<your-host>/api/evidence/verify-compliance'