Skip to content

Get a change

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

OK

Media typeapplication/json

Full change (drawer): summary fields plus payload and resources

object
id
string
source_system
string
kind
string
occurred_at
string format: date-time
recorded_at
string format: date-time
actor

Normalized actor identity on a timeline change

object
type
string
id
string
display
string
arn
string
actor_user_id
string
via
string
aws_account_id
string
region
string
event_name
string
summary
string
payload
object
key
additional properties
any
resources
Array<object>

Links a change to an inventory resource (and, when known, the resulting config revision — the replay substrate)

object
resource_id
string
resource_config_revision_id
string
match_kind
string
Examplegenerated
{
"id": "example",
"source_system": "example",
"kind": "example",
"occurred_at": "2026-04-15T12:00:00Z",
"recorded_at": "2026-04-15T12:00:00Z",
"actor": {
"type": "example",
"id": "example",
"display": "example",
"arn": "example"
},
"actor_user_id": "example",
"via": "example",
"aws_account_id": "example",
"region": "example",
"event_name": "example",
"summary": "example",
"payload": {},
"resources": [
{
"resource_id": "example",
"resource_config_revision_id": "example",
"match_kind": "example"
}
]
}

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"
}

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"
}

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"
}

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"
}