Changes

Inspect a prepared or applied change

Read your saved change plan's current state, approval requirement, application result and recorded readback. Optionally provide readback with an exact query path and input to run an independent permission-checked query and retain its evidence on the applied plan. query_required means saved-state verification is still missing; compare query_recorded data to the requested outcome.

Method

POST

Path

/v1/changes/inspect

Required scope

capabilities:read

Request

curl -X POST "https://api.endurancehq.app/v1/changes/inspect" \
  -H "Authorization: Bearer $EHQ_API_KEY"

JSON body schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "planId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "readback": {
      "type": "object",
      "properties": {
        "path": {
          "type": "string",
          "minLength": 1,
          "maxLength": 300
        },
        "input": {
          "type": "object",
          "propertyNames": {
            "type": "string"
          },
          "additionalProperties": {}
        }
      },
      "required": [
        "path"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "planId"
  ],
  "additionalProperties": false
}

Response

Success status: 200

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {}
    }
  },
  "required": [
    "data"
  ],
  "additionalProperties": false
}

Other surfaces

CLI: ehq changes inspect <plan_id> [--readback-path <procedure>] [--input <json>]

MCP tool: ehq_changes_inspect