Update a connection

PATCH

/api/v1/aws/connections/{id}

curl --request PATCH \
  --url https://api.aletheia-ops.com/api/v1/aws/connections/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "default_regions": [ "example" ] }'

• Production
• Local development

Authorizations

• bearerAuth
• sessionCookie
• csrfToken

Parameters

Path Parameters

id

required

string

Request Body^required

Media typeapplication/json

Edits a connection

object

name

string

default_regions

Array<string>

Example^generated

{
  "name": "example",
  "default_regions": [
    "example"
  ]
}

Responses

200

OK

Media typeapplication/json

Public shape of a connection, with account counts

object

id

string

name

string

connection_type

string

status

string

role_name

string

management_role_arn

string

default_regions

Array<string>

template_version

string

accounts_total

integer

accounts_connected

integer

last_validated_at

string format: date-time

created_at

string format: date-time

updated_at

string format: date-time

upgrade

Whether a connection’s deployed role template is behind the latest and, if so, the releases the customer would gain by upgrading

object

available

boolean

latest_version

string

releases

Array<object>

One template version newer than the deployed one and the IAM actions it newly grants (shown in the upgrade wizard)

object

version

string

summary

string

actions

Array<string>

grants_new_access

boolean

Example^generated

{
  "id": "example",
  "name": "example",
  "connection_type": "example",
  "status": "example",
  "role_name": "example",
  "management_role_arn": "example",
  "default_regions": [
    "example"
  ],
  "template_version": "example",
  "accounts_total": 1,
  "accounts_connected": 1,
  "last_validated_at": "2026-04-15T12:00:00Z",
  "created_at": "2026-04-15T12:00:00Z",
  "updated_at": "2026-04-15T12:00:00Z",
  "upgrade": {
    "available": true,
    "latest_version": "example",
    "releases": [
      {
        "version": "example",
        "summary": "example",
        "actions": [
          "example"
        ]
      }
    ],
    "grants_new_access": true
  }
}

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