Maintain API

GET/api/maintain/baseline-contract

request access

Baseline contract.

Permissions

HTTP request

GET https://<your-host>/api/maintain/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/maintain/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>",
  "providerCallsEnabled": false,
  "liveRemediationAllowed": false,
  "dryRunRequired": false,
  "supportedWorkflows": [],
  "baselineChecks": [],
  "validSites": null,
  "requiredGuards": [],
  "blockedReasons": []
}

POST/api/maintain/baseline/check/{server}

execute access

Baseline check.

Permissions

HTTP request

POST https://<your-host>/api/maintain/baseline/check/{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 POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Idempotency-Key: <idempotency-key>' \
  'https://<your-host>/api/maintain/baseline/check/<server>'

GET/api/maintain/baseline/compliance

audit access

Baseline compliance.

Permissions

HTTP request

GET https://<your-host>/api/maintain/baseline/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/maintain/baseline/compliance'

GET/api/maintain/baseline/coverage

audit access

Baseline coverage.

Permissions

HTTP request

GET https://<your-host>/api/maintain/baseline/coverage

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/maintain/baseline/coverage'

GET/api/maintain/baseline/noncompliant

audit access

Baseline noncompliant.

Permissions

HTTP request

GET https://<your-host>/api/maintain/baseline/noncompliant

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/maintain/baseline/noncompliant'

POST/api/maintain/baseline/remediate/{server}/{check_id}

execute access

Baseline remediate.

Permissions

HTTP request

POST https://<your-host>/api/maintain/baseline/remediate/{server}/{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/maintain/baseline/remediate/<server>/<check_id>'

GET/api/maintain/baseline/trend

audit access

Baseline trend.

Permissions

HTTP request

GET https://<your-host>/api/maintain/baseline/trend

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/maintain/baseline/trend'

GET/api/maintain/calendar-contract

request access

Maintenance calendar contract.

Permissions

HTTP request

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

GET/api/maintain/calendar/active

audit access

Maintenance calendar active.

Permissions

HTTP request

GET https://<your-host>/api/maintain/calendar/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/maintain/calendar/active?site=<site>'

POST/api/maintain/calendar/cancel/{id}

execute access

Cancel maintenance calendar.

Permissions

HTTP request

POST https://<your-host>/api/maintain/calendar/cancel/{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/maintain/calendar/cancel/<id>'

GET/api/maintain/calendar/conflicts

audit access

Maintenance calendar conflicts.

Permissions

HTTP request

GET https://<your-host>/api/maintain/calendar/conflicts

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/maintain/calendar/conflicts?site=<site>&start=<start>&end=<end>'

GET/api/maintain/calendar/month

audit access

Maintenance calendar month.

Permissions

HTTP request

GET https://<your-host>/api/maintain/calendar/month

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/maintain/calendar/month?site=<site>&month=<month>'

POST/api/maintain/calendar/schedule

execute access

Maintenance calendar schedule.

Permissions

HTTP request

POST https://<your-host>/api/maintain/calendar/schedule

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: MaintenanceCalendarScheduleRequest.

Response

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

Errors

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

Examples

Request

curl --silent --show-error --globoff \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '{"site":"<string>","startTime":"<string>","endTime":"<string>","reason":"<string>","affectedCis":[]}' \
  'https://<your-host>/api/maintain/calendar/schedule'

GET/api/maintain/calendar/upcoming

audit access

Maintenance calendar upcoming.

Permissions

HTTP request

GET https://<your-host>/api/maintain/calendar/upcoming

Path parameters

This operation has no path parameters.

Query parameters

Request headers

Request body

This operation does not accept a request body.

Response

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

Errors

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

Examples

Request

curl --silent --show-error --globoff \
  --request GET \
  --header 'Authorization: Bearer <token>' \
  'https://<your-host>/api/maintain/calendar/upcoming?site=<site>'

GET/api/maintain/certificate-contract

request access

Certificate lifecycle contract.

Permissions

HTTP request

GET https://<your-host>/api/maintain/certificate-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/maintain/certificate-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,
  "liveExecutionAllowed": false,
  "dryRunRequired": false,
  "supportedWorkflows": [],
  "validStatuses": [],
  "validServiceTypes": [],
  "requiredInputs": [],
  "requiredGuards": [],
  "blockedReasons": [],
  "requiredEvidence": [],
  "rules": []
}

POST/api/maintain/certificates/approve/{id}

execute access

Approve certificates.

Permissions

HTTP request

POST https://<your-host>/api/maintain/certificates/approve/{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/maintain/certificates/approve/<id>'

GET/api/maintain/certificates/expiring

audit access

Certificates expiring.

Permissions

HTTP request

GET https://<your-host>/api/maintain/certificates/expiring

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/maintain/certificates/expiring'

POST/api/maintain/certificates/install/{id}

execute access

Certificates install.

Permissions

HTTP request

POST https://<your-host>/api/maintain/certificates/install/{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/maintain/certificates/install/<id>'

GET/api/maintain/certificates/inventory

audit access

Certificates inventory.

Permissions

HTTP request

GET https://<your-host>/api/maintain/certificates/inventory

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/maintain/certificates/inventory'

POST/api/maintain/certificates/renew/{id}

execute access

Certificates renew.

Permissions

HTTP request

POST https://<your-host>/api/maintain/certificates/renew/{id}

Path parameters

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: CertificateRenewRequest.

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 '{"validityDays":0}' \
  'https://<your-host>/api/maintain/certificates/renew/<id>'

POST/api/maintain/certificates/request

execute access

Certificates request.

Permissions

HTTP request

POST https://<your-host>/api/maintain/certificates/request

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: CertificateRequestRequest.

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 '{"commonName":"<string>","subject":"<string>","serviceType":"<string>","hostname":"<string>","site":"<string>","validityDays":0}' \
  'https://<your-host>/api/maintain/certificates/request'

POST/api/maintain/certificates/revoke/{id}

execute access

Revoke certificates.

Permissions

HTTP request

POST https://<your-host>/api/maintain/certificates/revoke/{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/maintain/certificates/revoke/<id>'

POST/api/maintain/certificates/validate

execute access

Validate certificates.

Permissions

HTTP request

POST https://<your-host>/api/maintain/certificates/validate

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: CertificateValidateRequest.

Response

200 response body

Structure: Value.

Errors

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

Examples

Request

curl --silent --show-error --globoff \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '{"commonName":"<string>","subject":"<string>","serviceType":"<string>","hostname":"<string>","site":"<string>","validityDays":0}' \
  'https://<your-host>/api/maintain/certificates/validate'

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

{
  "valid": false,
  "message": "<string>"
}

POST/api/maintain/certificates/verify/{id}

execute access

Verify certificates.

Permissions

HTTP request

POST https://<your-host>/api/maintain/certificates/verify/{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/maintain/certificates/verify/<id>'

DELETE/api/maintain/certificates/{id}

execute access

Operational cleanup of a TERMINAL certificate.

Only an Expired/Revoked cert is deletable: an Active/Expiring cert is LIVE, and removing its record from the execute tier would lose tracking of an in-use certificate (the patch-wave delete lesson). Certificates are a leaf table (no FK references them) — no cascade. Site-scoped (out-of-scope → 404, no oracle).

Permissions

HTTP request

DELETE https://<your-host>/api/maintain/certificates/{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/maintain/certificates/<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/maintain/certificates/{id}

audit access

Get certificates.

Permissions

HTTP request

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

GET/api/maintain/patch-contract

request access

Patch contract.

Permissions

HTTP request

GET https://<your-host>/api/maintain/patch-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/maintain/patch-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,
  "patchMode": "<string>",
  "dryRunRequired": false,
  "liveExecutionAllowed": false,
  "supportedWorkflows": [],
  "waveDimensions": [],
  "validOsFamilies": [],
  "validSites": null,
  "requiredInputs": [],
  "requiredGuards": [],
  "blockedReasons": [],
  "requiredEvidence": []
}

POST/api/maintain/patch/approve

approve access

Approve patch.

Permissions

HTTP request

POST https://<your-host>/api/maintain/patch/approve

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: PatchActionRequest.

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 '{"waveId":"<string>"}' \
  'https://<your-host>/api/maintain/patch/approve'

GET/api/maintain/patch/compliance

audit access

Patch compliance.

Permissions

HTTP request

GET https://<your-host>/api/maintain/patch/compliance

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/maintain/patch/compliance'

POST/api/maintain/patch/execute

execute access

Execute patch.

Permissions

HTTP request

POST https://<your-host>/api/maintain/patch/execute

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: PatchActionRequest.

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 '{"waveId":"<string>"}' \
  'https://<your-host>/api/maintain/patch/execute'

GET/api/maintain/patch/pending-reboots

audit access

Patch pending reboots.

Permissions

HTTP request

GET https://<your-host>/api/maintain/patch/pending-reboots

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/maintain/patch/pending-reboots'

POST/api/maintain/patch/plan

execute access

Plan patch.

Permissions

HTTP request

POST https://<your-host>/api/maintain/patch/plan

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: PatchPlanRequest.

Response

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

Errors

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

Examples

Request

curl --silent --show-error --globoff \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '{"site":"<string>","osFamily":"<string>","criticality":"<string>"}' \
  'https://<your-host>/api/maintain/patch/plan'

POST/api/maintain/patch/reboot

execute access

Produce the dry-run reboot-orchestration plan for a persisted wave.

Like verify, this is evidence-only: it computes the staged, BATCHED (rolling) reboot plan (backup verify -> per batch: drain-batch -> reboot-batch servers -> health-check-batch gate -> final fleet-wide check, all simulated) and does NOT transition the wave. Batch size comes from the wave's reboot_batch_size / reboot_batch_percent metadata (default: one server per batch). 503 without a database, 404 when the wave is absent, 409 when the engine rejects the wave (e.g. zero servers).

Permissions

HTTP request

POST https://<your-host>/api/maintain/patch/reboot

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: PatchActionRequest.

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 '{"waveId":"<string>"}' \
  'https://<your-host>/api/maintain/patch/reboot'

POST/api/maintain/patch/validate

execute access

Validate patch.

Permissions

HTTP request

POST https://<your-host>/api/maintain/patch/validate

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: PatchActionRequest.

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 '{"waveId":"<string>"}' \
  'https://<your-host>/api/maintain/patch/validate'

POST/api/maintain/patch/verify

execute access

Verify patch.

Permissions

HTTP request

POST https://<your-host>/api/maintain/patch/verify

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: PatchActionRequest.

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 '{"waveId":"<string>"}' \
  'https://<your-host>/api/maintain/patch/verify'

GET/api/maintain/patch/waves

audit access

List persisted patch waves (read surface), paged (#14).

Returns an empty list when no database is configured (demo mode), matching the other read-only GETs. 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/maintain/patch/waves

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/maintain/patch/waves'

DELETE/api/maintain/patch/waves/{id}

execute access

Remove a mistaken patch wave.

Only an UNAPPROVED draft (Draft/Validated) is deletable at this execute-tier route: an Approved/Scheduled wave is approver-reviewed (deleting it is an approval-tier cancellation — out of scope) and an InProgress/Completed/Failed wave has executed (its run is evidence). The patch_wave_servers rows cascade.

Permissions

HTTP request

DELETE https://<your-host>/api/maintain/patch/waves/{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/maintain/patch/waves/<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/maintain/patch/waves/{id}

audit access

Fetch a single persisted patch wave by id (read surface).

404 when absent or when no database is configured.

Permissions

HTTP request

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

GET/api/maintain/software-contract

request access

Software contract.

Permissions

HTTP request

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

POST/api/maintain/software/approve/{id}

approve access

Approve software.

Permissions

HTTP request

POST https://<your-host>/api/maintain/software/approve/{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/maintain/software/approve/<id>'

GET/api/maintain/software/compliance

audit access

Software compliance.

Permissions

HTTP request

GET https://<your-host>/api/maintain/software/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/maintain/software/compliance?site=<site>'

POST/api/maintain/software/execute/{id}

software.deployment.execute access

Execute software.

Permissions

HTTP request

POST https://<your-host>/api/maintain/software/execute/{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/maintain/software/execute/<id>'

GET/api/maintain/software/history/{server}

audit access

Software history.

Permissions

HTTP request

GET https://<your-host>/api/maintain/software/history/{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/maintain/software/history/<server>'

GET/api/maintain/software/packages

audit access

List software packages.

Permissions

HTTP request

GET https://<your-host>/api/maintain/software/packages

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/maintain/software/packages'

POST/api/maintain/software/plan

execute access

Plan software.

Permissions

HTTP request

POST https://<your-host>/api/maintain/software/plan

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: software_deployment::DeploymentRequest.

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 '{"server_name":"<string>","package_id":"<string>","scheduled_time":"<string>"}' \
  'https://<your-host>/api/maintain/software/plan'

POST/api/maintain/software/validate

execute access

Validate software.

Permissions

HTTP request

POST https://<your-host>/api/maintain/software/validate

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: software_deployment::DeploymentRequest.

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 '{"server_name":"<string>","package_id":"<string>","scheduled_time":"<string>"}' \
  'https://<your-host>/api/maintain/software/validate'

POST/api/maintain/software/verify/{id}

execute access

Verify software.

Permissions

HTTP request

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

{
  "passed": false,
  "status": "<string>",
  "note": "<string>",
  "source": "<string>",
  "deployment": null
}