Skip to content

Get an IaC project

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

OK

Media typeapplication/json

GET /iac-projects/{id} response (plan 10 §2.2): the deployment unit plus its state source, resource counts, matched %, and the managed_missing state resources

object
id
string
repository_id
string
path
string
system
string
kind
string
backend_type
string
status
string
state_source_id
string
state_source

A customer-configured state backend (plan 10 §2.2)

object
id
string
kind
string
config
object
key
additional properties
any
aws_account_id
string
origin
string
status
string
last_synced_at
string format: date-time
last_error
string
created_at
string format: date-time
state_resources
integer
matched
integer
matched_percent
integer
missing
Array<object>

A state entry with no live counterpart, surfaced on the deployment-unit view as managed_missing (plan 10 §2.3)

object
address
string
code_address
string
resource_type
string
management_state
string
identity
object
key
additional properties
any
Examplegenerated
{
"id": "example",
"repository_id": "example",
"path": "example",
"system": "example",
"kind": "example",
"backend_type": "example",
"status": "example",
"state_source_id": "example",
"state_source": {
"id": "example",
"kind": "example",
"config": {},
"aws_account_id": "example",
"origin": "example",
"status": "example",
"last_synced_at": "2026-04-15T12:00:00Z",
"last_error": "example",
"created_at": "2026-04-15T12:00:00Z"
},
"state_resources": 1,
"matched": 1,
"matched_percent": 1,
"missing": [
{
"address": "example",
"code_address": "example",
"resource_type": "example",
"management_state": "example",
"identity": {}
}
]
}

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