Submit a Terraform plan from CI

POST

/api/v1/ingest/terraform-plans

curl --request POST \
  --url https://api.aletheia-ops.com/api/v1/ingest/terraform-plans \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "external_id": "example", "execution_external_id": "example", "repository": "example", "project_path": "example", "workspace": "example", "commit_sha": "example", "branch": "example", "pull_request_number": 1, "source": "example", "terraform_version": "example", "plan_json": "example" }'

• Production
• Local development

Authorizations

• ingestToken

Request Body^required

Media typeapplication/json

Body of POST /ingest/terraform-plans

object

external_id

string

execution_external_id

string

repository

string

project_path

string

workspace

string

commit_sha

string

branch

string

pull_request_number

integer

source

required

string

terraform_version

string

plan_json

required

Example^generated

{
  "external_id": "example",
  "execution_external_id": "example",
  "repository": "example",
  "project_path": "example",
  "workspace": "example",
  "commit_sha": "example",
  "branch": "example",
  "pull_request_number": 1,
  "source": "example",
  "terraform_version": "example",
  "plan_json": "example"
}

Responses

202

Accepted

Media typeapplication/json

202 response of the plan ingest endpoint

object

plan_id

string

url

string

Example^generated

{
  "plan_id": "example",
  "url": "example"
}

400

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

{
  "code": "invalid_state",
  "message": "invalid or expired install state"
}

{
  "code": "unsafe_base_url",
  "message": "base URL is not permitted"
}

{
  "code": "invalid_body",
  "message": "could not read request body"
}

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

409

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

{
  "code": "slug_taken",
  "message": "organization slug already taken"
}

{
  "code": "name_taken",
  "message": "a connection with this name already exists"
}

{
  "code": "account_exists",
  "message": "this AWS account is already connected"
}

{
  "code": "connection_exists",
  "message": "a connection for this organization already exists"
}

{
  "code": "scan_conflict",
  "message": "an equivalent scan is already queued or running"
}

{
  "code": "invitation_invalid",
  "message": "this invitation is no longer valid"
}

{
  "code": "last_admin",
  "message": "the organization must keep at least one active platform administrator"
}

{
  "code": "conflict",
  "message": "a resource with this identifier already exists"
}

{
  "code": "turn_in_progress",
  "message": "a turn is already in progress on this conversation"
}

413

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

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