Integrations API

GET/api/integrations

admin access

List connections.

Never includes secret material.

Permissions

HTTP request

GET https://<your-host>/api/integrations

Path parameters

This operation has no path parameters.

Query parameters

Request headers

Request body

This operation does not accept a request body.

Response

200 response body

Structure: Value.

Returns a paginated JSON object with total/limit/offset keys.

Errors

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

Examples

Request

curl --silent --show-error --globoff \
  --request GET \
  --header 'Authorization: Bearer <token>' \
  'https://<your-host>/api/integrations'

Schematic response body

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

Success status: 200

{
  "source": null,
  "connections": null,
  "count": null,
  "total": null,
  "limit": null,
  "offset": null
}

POST/api/integrations

admin access

Create a connection.

For db-encrypted source: encrypts inline_secret server-side; discards plaintext; response never includes the secret.

Permissions

HTTP request

POST https://<your-host>/api/integrations

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: CreateConnectionRequest.

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 '{"vendor_type":"<string>","name":"<string>","endpoint_url":"<string>","credential_source":"<string>"}' \
  'https://<your-host>/api/integrations'

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

GET/api/integrations/adapter-contract-test-contract

request access

Test integrations adapter contract.

Permissions

HTTP request

GET https://<your-host>/api/integrations/adapter-contract-test-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/integrations/adapter-contract-test-contract'

Schematic response body

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

Success status: 200

{
  "source": "<string>",
  "providerCallsEnabled": false,
  "targets": [],
  "testTypes": [],
  "fixtureTypes": [],
  "requiredGuards": [],
  "planSections": [],
  "blockedReasons": []
}

GET/api/integrations/adapter-readiness-matrix-contract

request access

Integrations adapter matrix.

Permissions

HTTP request

GET https://<your-host>/api/integrations/adapter-readiness-matrix-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/integrations/adapter-readiness-matrix-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,
  "adapters": [],
  "states": [],
  "dimensions": [],
  "guards": [],
  "planSections": [],
  "blockedReasons": [],
  "capabilities": []
}

GET/api/integrations/capabilities

admin access

The supported integration vendor types grouped by category, plus the framework operations every adapter implements (#51).

Static (no DB); reflects the real AdapterType catalog, all dry-run. Admin-gated, consistent with the rest of the integration surface.

Permissions

HTTP request

GET https://<your-host>/api/integrations/capabilities

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/integrations/capabilities'

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

{
  "operations": null,
  "execution_mode": "<string>",
  "count": null,
  "vendors": null
}

GET/api/integrations/capabilities/{vendor_type}

admin access

One vendor's capability (#51).

404 for an unknown vendor type. Admin-gated.

Permissions

HTTP request

GET https://<your-host>/api/integrations/capabilities/{vendor_type}

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/integrations/capabilities/<vendor_type>'

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

{
  "vendor_type": null,
  "label": null,
  "category": null,
  "operations": null,
  "execution_mode": "<string>"
}

GET/api/integrations/circuits

admin access

The fleet-wide list of NON-closed integration circuit breakers (the actionable failing-integration set; a reset DELETEs the row, so only open/half_open rows persist).

Admin-gated. The one durable time-sensitive signal that previously had no aggregate operator view — an operator can now answer "which integration breakers are OPEN right now?" without polling every connection id. Carries only state + counters + timestamp + connection_id (no credential/endpoint material).

Permissions

HTTP request

GET https://<your-host>/api/integrations/circuits

Path parameters

This operation has no path parameters.

Query parameters

Request headers

Request body

This operation does not accept a request body.

Response

200 response body

Structure: Value.

Returns a paginated JSON object with total/limit/offset keys.

Errors

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

Examples

Request

curl --silent --show-error --globoff \
  --request GET \
  --header 'Authorization: Bearer <token>' \
  'https://<your-host>/api/integrations/circuits'

Schematic response body

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

Success status: 200

{
  "source": null,
  "breakers": null,
  "total": null,
  "limit": null,
  "offset": null,
  "now_unix": null
}

GET/api/integrations/cohesity/readiness

audit access

Integrations cohesity readiness.

Permissions

HTTP request

GET https://<your-host>/api/integrations/cohesity/readiness

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/integrations/cohesity/readiness'

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

{
  "provider": "<string>",
  "adapter": "<string>",
  "status": "<string>",
  "mode": "<string>",
  "capabilities": [],
  "last_checked": null,
  "source": "<string>"
}

GET/api/integrations/commvault/readiness

audit access

Integrations commvault readiness.

Permissions

HTTP request

GET https://<your-host>/api/integrations/commvault/readiness

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/integrations/commvault/readiness'

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

{
  "provider": "<string>",
  "adapter": "<string>",
  "status": "<string>",
  "mode": "<string>",
  "capabilities": [],
  "last_checked": null,
  "source": "<string>"
}

GET/api/integrations/credentials/expiring

admin access

?within_days=N — connections whose tracked credential expires within N days (default 30, bounded), INCLUDING already-expired ones (expired: true).

Connections with no tracked expiry are excluded — absence of an expiry is not "expiring soon". Admin-gated.

Permissions

HTTP request

GET https://<your-host>/api/integrations/credentials/expiring

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/integrations/credentials/expiring'

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

{
  "within_days": null,
  "count": null,
  "items": null,
  "durable": false
}

GET/api/integrations/datadog/readiness

audit access

Integrations datadog readiness.

Permissions

HTTP request

GET https://<your-host>/api/integrations/datadog/readiness

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/integrations/datadog/readiness'

GET/api/integrations/grafana/readiness

audit access

Integrations grafana readiness.

Permissions

HTTP request

GET https://<your-host>/api/integrations/grafana/readiness

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/integrations/grafana/readiness'

GET/api/integrations/hyperv/readiness

audit access

Integrations hyperv readiness.

Permissions

HTTP request

GET https://<your-host>/api/integrations/hyperv/readiness

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/integrations/hyperv/readiness'

GET/api/integrations/kvm/readiness

audit access

Integrations kvm readiness.

Permissions

HTTP request

GET https://<your-host>/api/integrations/kvm/readiness

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/integrations/kvm/readiness'

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

{
  "provider": "<string>",
  "adapter": "<string>",
  "status": "<string>",
  "mode": "<string>",
  "capabilities": [],
  "last_checked": null,
  "source": "<string>"
}

GET/api/integrations/netbackup/readiness

audit access

Integrations netbackup readiness.

Permissions

HTTP request

GET https://<your-host>/api/integrations/netbackup/readiness

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/integrations/netbackup/readiness'

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

{
  "provider": "<string>",
  "adapter": "<string>",
  "status": "<string>",
  "mode": "<string>",
  "capabilities": [],
  "last_checked": null,
  "source": "<string>"
}

GET/api/integrations/nutanix/readiness

audit access

Integrations nutanix readiness.

Permissions

HTTP request

GET https://<your-host>/api/integrations/nutanix/readiness

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/integrations/nutanix/readiness'

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

{
  "provider": "<string>",
  "adapter": "<string>",
  "status": "<string>",
  "mode": "<string>",
  "capabilities": [],
  "last_checked": null,
  "source": "<string>"
}

GET/api/integrations/prometheus/readiness

audit access

Integrations prometheus readiness.

Permissions

HTTP request

GET https://<your-host>/api/integrations/prometheus/readiness

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/integrations/prometheus/readiness'

GET/api/integrations/proxmox/readiness

audit access

Integrations proxmox readiness.

Permissions

HTTP request

GET https://<your-host>/api/integrations/proxmox/readiness

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/integrations/proxmox/readiness'

GET/api/integrations/readiness

audit access

Integrations readiness.

Permissions

HTTP request

GET https://<your-host>/api/integrations/readiness

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/integrations/readiness'

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,
  "externalAccessBlocked": false,
  "adapters": []
}

GET/api/integrations/rubrik/readiness

audit access

Integrations rubrik readiness.

Permissions

HTTP request

GET https://<your-host>/api/integrations/rubrik/readiness

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/integrations/rubrik/readiness'

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

{
  "provider": "<string>",
  "adapter": "<string>",
  "status": "<string>",
  "mode": "<string>",
  "capabilities": [],
  "last_checked": null,
  "source": "<string>"
}

GET/api/integrations/servicenow/cmdb-file-contract

request access

Integrations servicenow cmdb file.

Permissions

HTTP request

GET https://<your-host>/api/integrations/servicenow/cmdb-file-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/integrations/servicenow/cmdb-file-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,
  "liveApiDisabled": false,
  "rawFileContentAllowed": false,
  "normalizedImportFields": [],
  "workbookShape": [],
  "sanitizedFieldCategories": [],
  "normalizedHeaderExpectations": [],
  "syntheticCategoryExamples": [],
  "rejectionReasons": []
}

GET/api/integrations/servicenow/cmdb-file-row-validation

audit access

Dry-run ServiceNow CMDB file-exchange row validation.

Turns the static cmdb-file-exchange descriptor into a real decision: validate a proposed normalized CMDB import row against the contract rejection reasons and return accepted / rejected with reasons. Site validation is data-backed (site registry). File-based dry-run only — no live ServiceNow API call.

Permissions

HTTP request

GET https://<your-host>/api/integrations/servicenow/cmdb-file-row-validation

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/integrations/servicenow/cmdb-file-row-validation'

GET/api/integrations/servicenow/future-api-contract

request access

Integrations servicenow future api.

Permissions

HTTP request

GET https://<your-host>/api/integrations/servicenow/future-api-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/integrations/servicenow/future-api-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,
  "apiSurfaces": [],
  "signals": [],
  "requiredGuards": [],
  "planSections": [],
  "blockedReasons": []
}

GET/api/integrations/servicenow/future-api-readiness

audit access

Dry-run ServiceNow future-API integration readiness.

Turns the static servicenow-future-api descriptor into a real decision: evaluate the readiness guards over a proposed integration request and return readiness-recorded (all criteria met; live-API enablement is a separately-approved step) or block. Never calls ServiceNow; authentication is referenced by secret handle only.

Permissions

HTTP request

GET https://<your-host>/api/integrations/servicenow/future-api-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/integrations/servicenow/future-api-readiness'

GET/api/integrations/servicenow/readiness

audit access

Integrations servicenow readiness.

Permissions

HTTP request

GET https://<your-host>/api/integrations/servicenow/readiness

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/integrations/servicenow/readiness'

GET/api/integrations/solarwinds/readiness

audit access

Integrations solarwinds readiness.

Permissions

HTTP request

GET https://<your-host>/api/integrations/solarwinds/readiness

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/integrations/solarwinds/readiness'

GET/api/integrations/veeam/readiness

audit access

Integrations veeam readiness.

Permissions

HTTP request

GET https://<your-host>/api/integrations/veeam/readiness

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/integrations/veeam/readiness'

GET/api/integrations/vmware/cluster-capacity-admission

audit access

Dry-run cluster capacity ADMISSION.

Turns the static cluster-capacity-admission-contract descriptor into a real admit/review/block/defer decision over the capacity inventory: compute (CPU + memory) headroom is data-backed; datastore, vSAN, HA failover, DRS balance, and reservation impact are reviewed in dry-run. Prefers live inventory when a DB is wired, otherwise the static seed (matching the integrations/vmware static-seed posture). No live vCenter calls.

Permissions

HTTP request

GET https://<your-host>/api/integrations/vmware/cluster-capacity-admission

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/integrations/vmware/cluster-capacity-admission'

GET/api/integrations/vmware/cluster-capacity-admission-contract

request access

Integrations vmware cluster capacity.

Permissions

HTTP request

GET https://<your-host>/api/integrations/vmware/cluster-capacity-admission-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/integrations/vmware/cluster-capacity-admission-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,
  "livePlacementEnabled": false,
  "workflows": [],
  "decisions": [],
  "signals": [],
  "requiredGuards": [],
  "planSections": [],
  "blockedReasons": [],
  "requiredEvidence": []
}

GET/api/integrations/vmware/customization-spec-governance

audit access

Dry-run guest-customization GOVERNANCE.

Turns the static customization-spec-governance descriptor into a real decision: derive the catalog-governed safe Windows customization facts for the site (spec, OU pattern, domain, timezone, DHCP behavior) and flag drift against any proposed values. block for an unknown site, review on drift, admit when the proposal matches the catalog. Catalog-derived safe facts only — no live vCenter/directory calls.

Permissions

HTTP request

GET https://<your-host>/api/integrations/vmware/customization-spec-governance

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/integrations/vmware/customization-spec-governance'

GET/api/integrations/vmware/customization-spec-governance-contract

request access

Integrations vmware customization spec.

Permissions

HTTP request

GET https://<your-host>/api/integrations/vmware/customization-spec-governance-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/integrations/vmware/customization-spec-governance-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": [],
  "supportedHypervisors": [],
  "guestCustomizationParity": [],
  "safeFacts": [],
  "driftSignals": [],
  "requiredGuards": [],
  "planSections": [],
  "blockedReasons": []
}

GET/api/integrations/vmware/day2-change-contract

request access

Integrations vmware day2.

Permissions

HTTP request

GET https://<your-host>/api/integrations/vmware/day2-change-contract

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

This operation does not accept a request body.

Response

200 response body

Structure: Value.

Errors

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

Examples

Request

curl --silent --show-error --globoff \
  --request GET \
  --header 'Authorization: Bearer <token>' \
  'https://<your-host>/api/integrations/vmware/day2-change-contract'

Schematic response body

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

Success status: 200

{
  "source": "<string>",
  "providerCallsEnabled": false,
  "liveChangeEnabled": false,
  "actions": [],
  "requiredGuards": [],
  "planSections": [],
  "blockedReasons": []
}

GET/api/integrations/vmware/decommission-quarantine

audit access

Dry-run VM decommission QUARANTINE planning.

Turns the static decommission-quarantine descriptor into a real decision: evaluate the required guards over a proposed decommission and, when met, produce a dry-run quarantine plan. Final disposition (deletion) is ALWAYS held — this contract never deletes; the decision is block or quarantine-planned, never an admit-to-delete. No live decommission/delete; redacted summaries only.

Permissions

HTTP request

GET https://<your-host>/api/integrations/vmware/decommission-quarantine

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/integrations/vmware/decommission-quarantine'

GET/api/integrations/vmware/decommission-quarantine-contract

request access

Integrations vmware decommission.

Permissions

HTTP request

GET https://<your-host>/api/integrations/vmware/decommission-quarantine-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/integrations/vmware/decommission-quarantine-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,
  "stages": [],
  "domains": [],
  "requiredGuards": [],
  "planSections": [],
  "blockedReasons": []
}

GET/api/integrations/vmware/object-placement

audit access

Dry-run vCenter object-placement planning.

Turns the static object-placement descriptor into a real decision: evaluate the placement readiness guards over a proposed request and, when met, produce a dry-run plan that becomes approvable. Three guards are data-backed — site validity (site registry), folder derivability (governed catalog site), and capacity admitted (chains from the cluster-capacity-admission gate). Never places live — decision is block or placement-planned; redacted summaries only.

Permissions

HTTP request

GET https://<your-host>/api/integrations/vmware/object-placement

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/integrations/vmware/object-placement'

GET/api/integrations/vmware/object-placement-contract

request access

Integrations vmware object placement.

Permissions

HTTP request

GET https://<your-host>/api/integrations/vmware/object-placement-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/integrations/vmware/object-placement-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,
  "livePlacementEnabled": false,
  "vcenterDimensions": [],
  "hyperVDimensions": [],
  "proxmoxDimensions": [],
  "nutanixAhvDimensions": [],
  "xenDimensions": [],
  "kvmDimensions": [],
  "requiredGuards": [],
  "planSections": [],
  "blockedReasons": []
}

GET/api/integrations/vmware/readiness

audit access

Integrations vmware readiness.

Permissions

HTTP request

GET https://<your-host>/api/integrations/vmware/readiness

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/integrations/vmware/readiness'

GET/api/integrations/vmware/snapshot-governance

audit access

Dry-run snapshot GOVERNANCE.

Turns the static snapshot-governance descriptor into a real admit/review/block decision: evaluate the contract's required guards (owner / expiry / backup-state / approval / lock / rollback / evidence / CMDB-CI) over a proposed snapshot exception and emit the contract signals, with data-backed expiry/staleness checks. Review/remediation plans only — no live snapshot create/delete.

Permissions

HTTP request

GET https://<your-host>/api/integrations/vmware/snapshot-governance

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/integrations/vmware/snapshot-governance'

GET/api/integrations/vmware/snapshot-governance-contract

request access

Integrations vmware snapshot.

Permissions

HTTP request

GET https://<your-host>/api/integrations/vmware/snapshot-governance-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/integrations/vmware/snapshot-governance-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/integrations/vmware/vsan-esxi-lifecycle

audit access

Dry-run vSAN/ESXi (Hyper-V/Proxmox) lifecycle planning.

Turns the static vsan-esxi-lifecycle descriptor into a real decision: evaluate the readiness guards over a proposed cluster/host lifecycle request and, when met, produce a dry-run plan that becomes approvable. Never executes — decision is block or lifecycle-planned; live change is a separately-approved workflow. The supported-hypervisor set follows the catalog source of truth (VMware/Hyper-V/ Proxmox). No live lifecycle action; redacted summaries only.

Permissions

HTTP request

GET https://<your-host>/api/integrations/vmware/vsan-esxi-lifecycle

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/integrations/vmware/vsan-esxi-lifecycle'

GET/api/integrations/vmware/vsan-esxi-lifecycle-contract

request access

Integrations vmware vsan esxi.

Permissions

HTTP request

GET https://<your-host>/api/integrations/vmware/vsan-esxi-lifecycle-contract

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

This operation does not accept a request body.

Response

200 response body

Structure: Value.

Errors

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

Examples

Request

curl --silent --show-error --globoff \
  --request GET \
  --header 'Authorization: Bearer <token>' \
  'https://<your-host>/api/integrations/vmware/vsan-esxi-lifecycle-contract'

Schematic response body

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

Success status: 200

{
  "source": "<string>",
  "providerCallsEnabled": false,
  "workflows": [],
  "supportedHypervisors": [],
  "platformLifecycleParity": [],
  "domains": [],
  "requiredGuards": [],
  "planSections": [],
  "blockedReasons": []
}

GET/api/integrations/xen/readiness

audit access

Integrations xen readiness.

Permissions

HTTP request

GET https://<your-host>/api/integrations/xen/readiness

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/integrations/xen/readiness'

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

{
  "provider": "<string>",
  "adapter": "<string>",
  "status": "<string>",
  "mode": "<string>",
  "capabilities": [],
  "last_checked": null,
  "source": "<string>"
}

GET/api/integrations/zabbix/readiness

audit access

Integrations zabbix readiness.

Permissions

HTTP request

GET https://<your-host>/api/integrations/zabbix/readiness

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/integrations/zabbix/readiness'

POST/api/integrations/{connection_id}/webhook

webhook access

PUBLIC — no human session or agent bearer.

Requires X-Ryuki-Webhook-Timestamp, X-Ryuki-Webhook-Delivery-Id, and an X-Hub-Signature-256 HMAC over the module's v1 canonical message. A first verified delivery records one domain event; an exact retry returns that event's original id. The external payload is capped at 256 KiB and is never echoed or stored.

Permissions

HTTP request

POST https://<your-host>/api/integrations/{connection_id}/webhook

Path parameters

Query parameters

This operation has no query parameters.

Request headers

Request body

Supply the required opaque request bytes as-is. Their SHA-256 digest is covered, together with the fixed path, timestamp, and delivery id, by X-Hub-Signature-256; do not reserialize them after computing the v1 canonical signature.

Response

202 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 'X-Hub-Signature-256: sha256=<hmac-signature>' \
  --header 'X-Ryuki-Webhook-Timestamp: <x-ryuki-webhook-timestamp>' \
  --header 'X-Ryuki-Webhook-Delivery-Id: <x-ryuki-webhook-delivery-id>' \
  --data-binary '@payload.bin' \
  'https://<your-host>/api/integrations/<connection_id>/webhook'

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: 202

{
  "status": "<string>",
  "event_id": 0
}

DELETE/api/integrations/{id}

admin access

Delete connection (cascades to integration_secrets).

Permissions

HTTP request

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

admin access

Get one connection.

Never includes secret material.

Permissions

HTTP request

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

PUT/api/integrations/{id}

admin access

Update a connection.

If credential_source is db-encrypted and inline_secret is provided, re-encrypts.

Permissions

HTTP request

PUT https://<your-host>/api/integrations/{id}

Path parameters

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: UpdateConnectionRequest.

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