Get a connection

GET

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

curl --request GET \
  --url https://api.aletheia-ops.com/api/v1/aws/connections/example \
  --header 'Authorization: Bearer <token>'

• Production
• Local development

Authorizations

• bearerAuth
• sessionCookie

Parameters

Path Parameters

id

required

string

Responses

200

OK

Media typeapplication/json

A connection with its setup material and steps

object

connection

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

setup

Deployment material a customer needs to deploy the read-only role (external id, role name, pre-filled CloudFormation/Terraform aids)

object

external_id

string

role_name

string

principal_arn

string

quick_create_url

string

update_stack_url

string

template_url

string

terraform_snippet

string

template_version

string

steps

Array<object>

One onboarding step row

object

id

string

aws_account_id

string

step

string

status

string

attempt

integer

detail

object

key

additional properties

any

created_at

string format: date-time

updated_at

string format: date-time

Example^generated

{
  "connection": {
    "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
    }
  },
  "setup": {
    "external_id": "example",
    "role_name": "example",
    "principal_arn": "example",
    "quick_create_url": "example",
    "update_stack_url": "example",
    "template_url": "example",
    "terraform_snippet": "example",
    "template_version": "example"
  },
  "steps": [
    {
      "id": "example",
      "aws_account_id": "example",
      "step": "example",
      "status": "example",
      "attempt": 1,
      "detail": {},
      "created_at": "2026-04-15T12:00:00Z",
      "updated_at": "2026-04-15T12:00:00Z"
    }
  ]
}

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

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