List a plan's resource changes

GET

/api/v1/plans/{id}/changes

curl --request GET \
  --url https://api.aletheia-ops.com/api/v1/plans/example/changes \
  --header 'Authorization: Bearer <token>'

• Production
• Local development

Authorizations

• bearerAuth
• sessionCookie

Parameters

Path Parameters

id

required

string

Responses

200

OK

Media typeapplication/json

A keyset-paginated changes list

object

items

Array<object>

One per-resource change

object

id

string

address

string

module_address

string

resource_type

string

action

string

action_reason

string

replace_paths

Array<string>

resource_id

string

match_method

string

before

after

after_unknown

next_cursor

string

Example^generated

{
  "items": [
    {
      "id": "example",
      "address": "example",
      "module_address": "example",
      "resource_type": "example",
      "action": "example",
      "action_reason": "example",
      "replace_paths": [
        "example"
      ],
      "resource_id": "example",
      "match_method": "example",
      "before": "example",
      "after": "example",
      "after_unknown": "example"
    }
  ],
  "next_cursor": "example"
}

401

No valid credential was presented, or it has expired.

Media typeapplication/json

object

code

required

Stable, machine-readable identifier. Branch on this.

string

message

required

Human-readable explanation. Safe to display; do not parse.

string

Examples

{
  "code": "unauthorized",
  "message": "authentication required"
}

{
  "code": "invalid_credentials",
  "message": "invalid email or password"
}

{
  "code": "invalid_token",
  "message": "invalid or expired token"
}

{
  "code": "token_reuse",
  "message": "session revoked"
}

{
  "code": "webhook_unauthorized",
  "message": "webhook verification failed"
}

403

Authenticated, but not permitted to perform this action.

Media typeapplication/json

object

code

required

Stable, machine-readable identifier. Branch on this.

string

message

required

Human-readable explanation. Safe to display; do not parse.

string

Examples

{
  "code": "forbidden",
  "message": "you do not have permission to perform this action"
}

{
  "code": "csrf_failed",
  "message": "missing or invalid CSRF token"
}

{
  "code": "account_deactivated",
  "message": "your account is deactivated; contact your administrator"
}

{
  "code": "ai_disabled",
  "message": "the AI assistant is disabled for this organization"
}

404

The resource does not exist, or belongs to another organization. The two are deliberately indistinguishable.

Media typeapplication/json

object

code

required

Stable, machine-readable identifier. Branch on this.

string

message

required

Human-readable explanation. Safe to display; do not parse.

string

Examples

Examplenot_found

{
  "code": "not_found",
  "message": "resource not found"
}

500

An unexpected failure. Diagnostic detail is logged server-side and deliberately not returned. Quote the X-Request-Id response header when reporting one.

Media typeapplication/json

object

code

required

Stable, machine-readable identifier. Branch on this.

string

message

required

Human-readable explanation. Safe to display; do not parse.

string

Examples

Exampleinternal_error

{
  "code": "internal_error",
  "message": "internal server error"
}