Skip to content

List IaC projects

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

OK

Media typeapplication/json

Iac-projects envelope

object
items
Array<object>

IaC-project projection

object
id
string
repository_id
string
path
string
system
string
kind
string
detection
string
backend_type
string
backend_config
object
key
additional properties
any
required_providers
object
key
additional properties
any
environment_hints
object
key
additional properties
any
environment_id
string
status
string
last_seen_commit_sha
string
state_source_id
string
state_source

State backend behind a root project, reduced to what a project row needs to explain itself

object
id
string
status
string
account_linked
boolean
bucket
string
key
string
last_synced_at
string
last_error
string
matched_percent
integer
total
integer
Examplegenerated
{
"items": [
{
"id": "example",
"repository_id": "example",
"path": "example",
"system": "example",
"kind": "example",
"detection": "example",
"backend_type": "example",
"backend_config": {},
"required_providers": {},
"environment_hints": {},
"environment_id": "example",
"status": "example",
"last_seen_commit_sha": "example",
"state_source_id": "example",
"state_source": {
"id": "example",
"status": "example",
"account_linked": true,
"bucket": "example",
"key": "example",
"last_synced_at": "example",
"last_error": "example"
},
"matched_percent": 1
}
],
"total": 1
}

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

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