Protect API

GET/api/protect/application-aware-backup-validation-contract

request access

Protect app aware backup.

Permissions

HTTP request

GET https://<your-host>/api/protect/application-aware-backup-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/protect/application-aware-backup-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>",
  "providerCallsEnabled": false,
  "workflows": [],
  "signals": [],
  "requiredGuards": [],
  "planSections": [],
  "blockedReasons": []
}

GET/api/protect/backup-coverage-contract

request access

Backup coverage contract.

Permissions

HTTP request

GET https://<your-host>/api/protect/backup-coverage-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/protect/backup-coverage-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>",
  "coverageMode": "<string>",
  "dryRunRequired": false,
  "providerCallsEnabled": false,
  "liveBackupQueryAllowed": false,
  "supportedWorkflows": [],
  "requiredInputs": [],
  "requiredGuards": [],
  "blockedReasons": [],
  "requiredEvidence": []
}

GET/api/protect/backup-coverage-gap-contract

request access

Protect backup coverage gap.

Permissions

HTTP request

GET https://<your-host>/api/protect/backup-coverage-gap-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/protect/backup-coverage-gap-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,
  "gapScopes": [],
  "gapSignals": [],
  "requiredGuards": [],
  "planSections": [],
  "blockedReasons": []
}

GET/api/protect/backup-dr-assignment-contract

request access

Protect backup dr assignment.

Permissions

HTTP request

GET https://<your-host>/api/protect/backup-dr-assignment-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/protect/backup-dr-assignment-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,
  "workflows": [],
  "signals": [],
  "requiredGuards": [],
  "planSections": [],
  "blockedReasons": []
}

POST/api/protect/backup/coverage-report

execute access

Backup coverage report.

Permissions

HTTP request

POST https://<your-host>/api/protect/backup/coverage-report

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: CoverageReportRequest.

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 '{"siteScope":[],"environmentScope":[]}' \
  'https://<your-host>/api/protect/backup/coverage-report'

GET/api/protect/backup/coverage-reports

audit access

List persisted coverage reports, paged (#14).

Returns an empty array when no DB is available rather than an error. The body stays a BARE array (backward-compatible); the scope-filtered total rides the X-Total-Count header.

Permissions

HTTP request

GET https://<your-host>/api/protect/backup/coverage-reports

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/protect/backup/coverage-reports'

GET/api/protect/backup/coverage-reports/{id}

audit access

Fetch a single coverage report by id.

Returns 404 when absent or when no DB is configured.

Permissions

HTTP request

GET https://<your-host>/api/protect/backup/coverage-reports/{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/protect/backup/coverage-reports/<id>'

POST/api/protect/backup/restore-approve

approve access

Approve backup restore.

Permissions

HTTP request

POST https://<your-host>/api/protect/backup/restore-approve

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: RestoreActionRequest.

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 '{"restoreId":"<string>"}' \
  'https://<your-host>/api/protect/backup/restore-approve'

POST/api/protect/backup/restore-execute

execute access

Execute a persisted restore request (must be Approved) and record the execution by transitioning Approved -> Executed.

The response is the evidence the engine produced. The CAS transition also makes execute non-idempotent in the safe direction: a second call finds the request Executed (not Approved), so the engine's Approved precondition rejects it (409) — a restore cannot be silently run twice, and list/get reflect that it ran.

Permissions

HTTP request

POST https://<your-host>/api/protect/backup/restore-execute

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: RestoreActionRequest.

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 '{"restoreId":"<string>"}' \
  'https://<your-host>/api/protect/backup/restore-execute'

POST/api/protect/backup/restore-plan

execute access

Plan backup restore.

Permissions

HTTP request

POST https://<your-host>/api/protect/backup/restore-plan

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: RestorePlanRequest.

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 '{"sourceCiKey":"<string>","restoreType":"<string>","restorePoint":"<string>","targetSite":"<string>","targetEnvironment":"<string>","owner":"<string>"}' \
  'https://<your-host>/api/protect/backup/restore-plan'

GET/api/protect/backup/restore-tests/recency

audit access

?overdue_after_days=N — restore test recency (#47).

A backup is only proven by a successful restore test; this reports, per source_ci_key THAT HAS RESTORE-REQUEST HISTORY, the last successful test (status Verified/Completed) and classifies it current/overdue/never_tested against the policy window (default 90 days, bounded). Systems with no restore request at all are out of scope (a coverage question — see coverage reports); the response carries a scope + note saying so. Read-only; empty + durable:false when no DB.

Permissions

HTTP request

GET https://<your-host>/api/protect/backup/restore-tests/recency

Path parameters

This operation has no path parameters.

Query parameters

Request headers

Request body

This operation does not accept a request body.

Response

200 response body

Structure: Value.

Errors

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

Examples

Request

curl --silent --show-error --globoff \
  --request GET \
  --header 'Authorization: Bearer <token>' \
  'https://<your-host>/api/protect/backup/restore-tests/recency'

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

{
  "overdue_after_days": null,
  "systems": null,
  "summary": null,
  "scope": null,
  "note": null,
  "durable": false
}

POST/api/protect/backup/restore-validate

execute access

Validate a persisted restore request (read-only — no state transition).

Permissions

HTTP request

POST https://<your-host>/api/protect/backup/restore-validate

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: RestoreActionRequest.

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 '{"restoreId":"<string>"}' \
  'https://<your-host>/api/protect/backup/restore-validate'

GET/api/protect/backup/restores

audit access

List persisted restore requests, paged (#14).

Returns an empty array when no DB is available rather than an error. The body stays a BARE array (backward-compatible); the scope-filtered total rides the X-Total-Count header.

Permissions

HTTP request

GET https://<your-host>/api/protect/backup/restores

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/protect/backup/restores'

GET/api/protect/backup/restores/{id}

audit access

Fetch a single restore request by id.

Returns 404 when absent or when no DB is configured.

Permissions

HTTP request

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

GET/api/protect/controlled-restore-contract

request access

Protect controlled restore.

Permissions

HTTP request

GET https://<your-host>/api/protect/controlled-restore-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/protect/controlled-restore-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,
  "restoreTypes": [],
  "requiredGuards": [],
  "planSections": [],
  "blockedReasons": []
}

GET/api/protect/dr-contract

request access

Dr contract.

Permissions

HTTP request

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

Schematic response body

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

Success status: 200

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

GET/api/protect/dr/due-tests

audit access

Dr tests due.

Permissions

HTTP request

GET https://<your-host>/api/protect/dr/due-tests

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/protect/dr/due-tests'

GET/api/protect/dr/plans

audit access

List dr plans.

Permissions

HTTP request

GET https://<your-host>/api/protect/dr/plans

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/protect/dr/plans'

POST/api/protect/dr/plans

execute access

Create dr plan.

Permissions

HTTP request

POST https://<your-host>/api/protect/dr/plans

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: DrPlanCreateRequest.

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 '{"name":"<string>","site":"<string>","targetSite":"<string>","systems":[],"rpo":0,"rto":0}' \
  'https://<your-host>/api/protect/dr/plans'

DELETE/api/protect/dr/plans/{id}

execute access

Delete dr plan.

Permissions

HTTP request

DELETE https://<your-host>/api/protect/dr/plans/{id}

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 DELETE \
  --header 'Authorization: Bearer <token>' \
  --header 'Idempotency-Key: <idempotency-key>' \
  'https://<your-host>/api/protect/dr/plans/<id>'

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

{
  "deleted": null
}

GET/api/protect/dr/plans/{id}

audit access

Get dr plan.

Permissions

HTTP request

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

PUT/api/protect/dr/plans/{id}

execute access

Update dr plan.

Permissions

HTTP request

PUT https://<your-host>/api/protect/dr/plans/{id}

Path parameters

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: DrPlanUpdateRequest.

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 PUT \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '{"name":"<string>","targetSite":"<string>","systems":[],"rpo":0,"rto":0}' \
  'https://<your-host>/api/protect/dr/plans/<id>'

POST/api/protect/dr/plans/{id}/rpo-rto

execute access

Dr plan update rpo rto.

Permissions

HTTP request

POST https://<your-host>/api/protect/dr/plans/{id}/rpo-rto

Path parameters

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: DrRpoRtoRequest.

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 '{"rpo":0,"rto":0}' \
  'https://<your-host>/api/protect/dr/plans/<id>/rpo-rto'

GET/api/protect/dr/readiness

audit access

Dr readiness.

Permissions

HTTP request

GET https://<your-host>/api/protect/dr/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/protect/dr/readiness'

GET/api/protect/dr/scenarios

audit access

Dr scenarios.

Permissions

HTTP request

GET https://<your-host>/api/protect/dr/scenarios

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/protect/dr/scenarios'

POST/api/protect/dr/tests/complete

execute access

Complete dr test.

Permissions

HTTP request

POST https://<your-host>/api/protect/dr/tests/complete

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: DrTestCompleteRequest.

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 '{"testId":"<string>","result":"<string>","systemsFailed":[]}' \
  'https://<your-host>/api/protect/dr/tests/complete'

GET/api/protect/dr/tests/results/{id}

audit access

Dr test results.

Permissions

HTTP request

GET https://<your-host>/api/protect/dr/tests/results/{id}

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/protect/dr/tests/results/<id>'

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

{
  "plan_id": null,
  "count": null,
  "test_results": null
}

POST/api/protect/dr/tests/start

execute access

Start dr test.

Permissions

HTTP request

POST https://<your-host>/api/protect/dr/tests/start

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: DrTestStartRequest.

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 '{"planId":"<string>","scenarioType":"<string>","tester":"<string>"}' \
  'https://<your-host>/api/protect/dr/tests/start'

GET/api/protect/immutability-air-gap-compliance-contract

request access

Protect immutability air gap.

Permissions

HTTP request

GET https://<your-host>/api/protect/immutability-air-gap-compliance-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/protect/immutability-air-gap-compliance-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,
  "workflows": [],
  "signals": [],
  "repositoryPostureProfiles": [],
  "repositoryTransitionStates": [],
  "requiredGuards": [],
  "planSections": [],
  "blockedReasons": []
}

GET/api/protect/immutability-contract

request access

Immutability contract.

Permissions

HTTP request

GET https://<your-host>/api/protect/immutability-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/protect/immutability-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,
  "liveRemediationAllowed": false,
  "veeamMutationAllowed": false,
  "rawRepositoryDataAllowed": false,
  "rawProviderPayloadsAllowed": false,
  "credentialValuesAllowed": false,
  "tenantIdentifiersAllowed": false,
  "privateNetworkValuesAllowed": false,
  "workflows": [],
  "requiredGuards": [],
  "blockedReasons": []
}

POST/api/protect/immutability/air-gap/{id}

execute access

Immutability air gap.

Permissions

HTTP request

POST https://<your-host>/api/protect/immutability/air-gap/{id}

Path parameters

Query parameters

This operation has no query parameters.

Request headers

Request body

This operation does not accept a request body.

Response

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

Errors

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

Examples

Request

curl --silent --show-error --globoff \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Idempotency-Key: <idempotency-key>' \
  'https://<your-host>/api/protect/immutability/air-gap/<id>'

POST/api/protect/immutability/check/{id}

execute access

Immutability check.

Permissions

HTTP request

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

Path parameters

Query parameters

This operation has no query parameters.

Request headers

Request body

This operation does not accept a request body.

Response

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

Errors

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

Examples

Request

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

GET/api/protect/immutability/compliance

audit access

Immutability compliance report.

Permissions

HTTP request

GET https://<your-host>/api/protect/immutability/compliance

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/protect/immutability/compliance'

GET/api/protect/immutability/noncompliant

audit access

Immutability noncompliant.

Permissions

HTTP request

GET https://<your-host>/api/protect/immutability/noncompliant

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/protect/immutability/noncompliant'

GET/api/protect/immutability/remediation/{id}

audit access

Immutability remediation.

Permissions

HTTP request

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

POST/api/protect/immutability/retention-lock/{id}

execute access

Lock immutability retention.

Permissions

HTTP request

POST https://<your-host>/api/protect/immutability/retention-lock/{id}

Path parameters

Query parameters

This operation has no query parameters.

Request headers

Request body

This operation does not accept a request body.

Response

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

Errors

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

Examples

Request

curl --silent --show-error --globoff \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Idempotency-Key: <idempotency-key>' \
  'https://<your-host>/api/protect/immutability/retention-lock/<id>'

GET/api/protect/immutability/retention-risk

audit access

Immutability retention risk.

Permissions

HTTP request

GET https://<your-host>/api/protect/immutability/retention-risk

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/protect/immutability/retention-risk'

POST/api/protect/immutability/verify-all

execute access

Immutability verify all.

Permissions

HTTP request

POST https://<your-host>/api/protect/immutability/verify-all

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 POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Idempotency-Key: <idempotency-key>' \
  'https://<your-host>/api/protect/immutability/verify-all'

GET/api/protect/legal-hold-contract

request access

Legal hold contract.

Permissions

HTTP request

GET https://<your-host>/api/protect/legal-hold-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/protect/legal-hold-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,
  "liveRetentionChangesAllowed": false,
  "veeamMutationAllowed": false,
  "serviceNowMutationAllowed": false,
  "rawCaseDataAllowed": false,
  "rawRecipientDataAllowed": false,
  "rawBackupRowsAllowed": false,
  "rawProviderPayloadsAllowed": false,
  "supportedWorkflows": [],
  "requiredGuards": [],
  "planSections": [],
  "blockedReasons": []
}

GET/api/protect/legal-hold-retention-contract

request access

Protect legal hold.

Permissions

HTTP request

GET https://<your-host>/api/protect/legal-hold-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/protect/legal-hold-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>",
  "providerCallsEnabled": false,
  "workflows": [],
  "signals": [],
  "requiredGuards": [],
  "planSections": [],
  "blockedReasons": []
}

GET/api/protect/legal-hold/active

audit access

Legal hold active.

Permissions

HTTP request

GET https://<your-host>/api/protect/legal-hold/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/protect/legal-hold/active'

GET/api/protect/legal-hold/compliance/{server}

audit access

Legal hold compliance.

Permissions

HTTP request

GET https://<your-host>/api/protect/legal-hold/compliance/{server}

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/protect/legal-hold/compliance/<server>'

GET/api/protect/legal-hold/evidence/{id}

audit access

Legal hold evidence.

Permissions

HTTP request

GET https://<your-host>/api/protect/legal-hold/evidence/{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/protect/legal-hold/evidence/<id>'

GET/api/protect/legal-hold/expiring

audit access

Legal hold expiring.

Permissions

HTTP request

GET https://<your-host>/api/protect/legal-hold/expiring

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/protect/legal-hold/expiring'

POST/api/protect/legal-hold/extend/{id}

execute access

Legal hold extend.

Permissions

HTTP request

POST https://<your-host>/api/protect/legal-hold/extend/{id}

Path parameters

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: LegalHoldExtendRequest.

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 '{"newExpiry":"<string>"}' \
  'https://<your-host>/api/protect/legal-hold/extend/<id>'

POST/api/protect/legal-hold/place

execute access

Legal hold place.

Permissions

HTTP request

POST https://<your-host>/api/protect/legal-hold/place

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: LegalHoldPlaceRequest.

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 '{"target":"<string>","holdType":"<string>","reason":"<string>","site":"<string>"}' \
  'https://<your-host>/api/protect/legal-hold/place'

POST/api/protect/legal-hold/release/{id}

execute access

Legal hold release.

Permissions

HTTP request

POST https://<your-host>/api/protect/legal-hold/release/{id}

Path parameters

Query parameters

This operation has no query parameters.

Request headers

Request body

This operation does not accept a request body.

Response

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

Errors

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

Examples

Request

curl --silent --show-error --globoff \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Idempotency-Key: <idempotency-key>' \
  'https://<your-host>/api/protect/legal-hold/release/<id>'

POST/api/protect/legal-hold/validate/{id}

execute access

Validate legal hold.

Permissions

HTTP request

POST https://<your-host>/api/protect/legal-hold/validate/{id}

Path parameters

Query parameters

This operation has no query parameters.

Request headers

Request body

This operation does not accept a request body.

Response

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

Errors

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

Examples

Request

curl --silent --show-error --globoff \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Idempotency-Key: <idempotency-key>' \
  'https://<your-host>/api/protect/legal-hold/validate/<id>'

GET/api/protect/repository-capacity

audit access

List repo capacity.

Permissions

HTTP request

GET https://<your-host>/api/protect/repository-capacity

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.

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/protect/repository-capacity'

GET/api/protect/repository-capacity-contract

request access

Protect repository capacity.

Permissions

HTTP request

GET https://<your-host>/api/protect/repository-capacity-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/protect/repository-capacity-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,
  "workflows": [],
  "signals": [],
  "requiredGuards": [],
  "planSections": [],
  "blockedReasons": []
}

GET/api/protect/repository-capacity/at-risk

audit access

Repo capacity at risk.

Permissions

HTTP request

GET https://<your-host>/api/protect/repository-capacity/at-risk

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/protect/repository-capacity/at-risk'

GET/api/protect/repository-capacity/forecast/{id}

audit access

Repo capacity forecast.

Permissions

HTTP request

GET https://<your-host>/api/protect/repository-capacity/forecast/{id}

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/protect/repository-capacity/forecast/<id>'

GET/api/protect/repository-capacity/recommendations/{id}

audit access

Repo capacity recommendations.

Permissions

HTTP request

GET https://<your-host>/api/protect/repository-capacity/recommendations/{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/protect/repository-capacity/recommendations/<id>'

GET/api/protect/repository-capacity/report

audit access

Repo capacity report.

Permissions

HTTP request

GET https://<your-host>/api/protect/repository-capacity/report

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/protect/repository-capacity/report'

GET/api/protect/repository-capacity/trend/{id}

audit access

Repo capacity trend.

Permissions

HTTP request

GET https://<your-host>/api/protect/repository-capacity/trend/{id}

Path parameters

Query parameters