Skip to content

Report an execution from CI

POST
/api/v1/ingest/executions
curl --request POST \
--url https://api.aletheia-ops.com/api/v1/ingest/executions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "external_id": "example", "kind": "example", "source": "example", "status": "example", "trigger": "example", "initiator": "example", "repository": "example", "project_path": "example", "workspace": "example", "environment": "example", "pull_request_number": 1, "external_url": "example", "started_at": "2026-04-15T12:00:00Z", "finished_at": "2026-04-15T12:00:00Z" }'
Media typeapplication/json

Body of POST /ingest/executions

object
external_id
required
string
kind
required
string
source
required
string
status
string
trigger
string
initiator
string
repository
string
project_path
string
workspace
string
environment
string
pull_request_number
integer
external_url
string
started_at
string format: date-time
finished_at
string format: date-time
Examplegenerated
{
"external_id": "example",
"kind": "example",
"source": "example",
"status": "example",
"trigger": "example",
"initiator": "example",
"repository": "example",
"project_path": "example",
"workspace": "example",
"environment": "example",
"pull_request_number": 1,
"external_url": "example",
"started_at": "2026-04-15T12:00:00Z",
"finished_at": "2026-04-15T12:00:00Z"
}

OK

Media typeapplication/json

Response of the execution ingest endpoint

object
execution_id
string
Examplegenerated
{
"execution_id": "example"
}

The request is malformed or fails validation.

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": "validation_failed",
"message": "name: must not be blank"
}

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 request conflicts with the current state.

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": "email_taken",
"message": "an account with this email already exists"
}

The request body exceeds the configured limit. Terraform plans are capped by CRITIAS_INGEST_MAX_PLAN_BYTES (32 MiB by default); webhook bodies have their own limit.

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
Examplepayload_too_large
{
"code": "payload_too_large",
"message": "plan exceeds CRITIAS_INGEST_MAX_PLAN_BYTES"
}

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