Skip to content

Add a Terraform state source

POST
/api/v1/state-sources
curl --request POST \
--url https://api.aletheia-ops.com/api/v1/state-sources \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "bucket": "example", "key": "example", "region": "example", "aws_account_id": "example" }'
Media typeapplication/json

POST /state-sources body (plan 10 §2.2)

object
bucket
required
string
key
required
string
region
string
aws_account_id
string
Examplegenerated
{
"bucket": "example",
"key": "example",
"region": "example",
"aws_account_id": "example"
}

Created

Media typeapplication/json

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

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

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