VM API

GET/api/vm/day2-change-contract

request access

Vm day2 change contract.

Permissions

HTTP request

GET https://<your-host>/api/vm/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/vm/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>",
  "changeMode": "<string>",
  "dryRunRequired": false,
  "providerCallsEnabled": false,
  "liveChangeAllowed": false,
  "lifecycle": [],
  "supportedActions": [],
  "requiredInputs": [],
  "requiredGuards": [],
  "blockedReasons": [],
  "requiredEvidence": []
}

POST/api/vm/day2/approve

approve access

Record a distinct checker decision for the exact validated plan.

The approver capability is checked locally as well as by the central route gate; the server-derived planner identity is never accepted from the request body.

Permissions

HTTP request

POST https://<your-host>/api/vm/day2/approve

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: VmDay2ActionRequest.

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 '{"operationId":"<string>"}' \
  'https://<your-host>/api/vm/day2/approve'

POST/api/vm/day2/execute

execute access

Execute a persisted vm day-2 operation.

Loads the operation by id, runs the engine execution (which sets status to Executed), and persists the transitioned entity. 503/404/409 as appropriate.

Permissions

HTTP request

POST https://<your-host>/api/vm/day2/execute

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: VmDay2ActionRequest.

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 '{"operationId":"<string>"}' \
  'https://<your-host>/api/vm/day2/execute'

POST/api/vm/day2/lock

execute access

Acquire a database-serialized operation lock for the approved VM scope.

The lock is short lived, plan-digest bound, and checked again at execute.

Permissions

HTTP request

POST https://<your-host>/api/vm/day2/lock

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: VmDay2ActionRequest.

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 '{"operationId":"<string>"}' \
  'https://<your-host>/api/vm/day2/lock'

POST/api/vm/day2/plan

execute access

Plan a new vm day-2 operation and persist it.

Returns the entity (including the generated id) so the caller can drive subsequent lifecycle steps. 503 when no database is configured.

Permissions

HTTP request

POST https://<your-host>/api/vm/day2/plan

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: VmDay2PlanRequest.

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 '{"targetCiKey":"<string>","changeType":"<string>","targetValue":0,"site":"<string>","environment":"<string>","owner":"<string>","maintenanceWindow":"<string>"}' \
  'https://<your-host>/api/vm/day2/plan'

POST/api/vm/day2/validate

execute access

Validate a persisted vm day-2 operation.

Loads the operation by id, runs the engine validation check, persists Validated status on success, and returns the ValidationResult. 503/404/409 as appropriate.

Permissions

HTTP request

POST https://<your-host>/api/vm/day2/validate

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: VmDay2ActionRequest.

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 '{"operationId":"<string>"}' \
  'https://<your-host>/api/vm/day2/validate'

POST/api/vm/day2/verify

execute access

Verify a persisted vm day-2 operation.

Loads the operation by id, collects evidence via the engine, persists Verified status, and returns the evidence list. 503/404/409 as appropriate.

Permissions

HTTP request

POST https://<your-host>/api/vm/day2/verify

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: VmDay2ActionRequest.

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 '{"operationId":"<string>"}' \
  'https://<your-host>/api/vm/day2/verify'