Update an IaC project

PATCH

/api/v1/iac-projects/{id}

curl --request PATCH \
  --url https://api.aletheia-ops.com/api/v1/iac-projects/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "system": "example", "kind": "example", "environment_id": "example", "disable": true }'

• Production
• Local development

Authorizations

• bearerAuth
• sessionCookie
• csrfToken

Parameters

Path Parameters

id

required

string

Request Body^required

Media typeapplication/json

Corrects or disables an IaC project

object

system

string

kind

string

environment_id

string

disable

boolean

Example^generated

{
  "system": "example",
  "kind": "example",
  "environment_id": "example",
  "disable": true
}

Responses

200

OK

Media typeapplication/json

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

Example^generated

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

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

404

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

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

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