Get the infrastructure overview

GET

/api/v1/overview

const url = 'https://api.aletheia-ops.com/api/v1/overview';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

Authorizations

bearerAuth
sessionCookie

Responses

200

application/json

The overview landing response — onboarding stage, inventory freshness, and one entry per tile.

object

organization_id

string format: uuid

generated_at

string format: date-time

onboarding_state

The organization’s discovery lifecycle stage.

string

Allowed values: no_accounts first_discovery_running ready

freshness

How current the discovered inventory is, across the organization’s accounts.

object

last_discovery_completed_at

string format: date-time

accounts_total

integer

accounts_fresh

integer

accounts_stale

integer

accounts_failing

integer

tiles

Array<object>

One tile on the overview. A tile is ready (it carries a value), pending (the capability behind it has not shipped, and pending_reason says which), or error (its provider failed or timed out — the rest of the response is still served).

object

key

string

Allowed values: resources_total connected_accounts active_regions discovery_freshness management_state unowned_resources high_risk_findings recent_changes failed_deployments open_remediation_prs

status

string

Allowed values: ready pending error

value

Primary count. Ready tiles only.

integer

breakdown

Optional label/value pairs. Ready tiles only.

Array<object>

One label/value pair in a tile breakdown, such as a resource type and its count.

object

label

string

value

integer

items

Optional list, such as recent changes. Ready tiles only.

Array<object>

One entry in a list tile.

object

string

title

string

occurred_at

string format: date-time

actor

string

computed_at

string format: date-time

pending_reason

Pending tiles only.

string

Allowed values: requires_ownership requires_code_mapping requires_change_timeline requires_deployments requires_findings requires_remediation

error

Human-readable failure. Error tiles only.

string

Example

{
  "onboarding_state": "no_accounts",
  "tiles": [
    {
      "key": "resources_total",
      "status": "ready",
      "breakdown": [
        {
          "label": "aws_s3_bucket"
        }
      ],
      "pending_reason": "requires_ownership"
    }
  ]
}

401

No valid credential was presented, or it has expired.

application/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.

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

500

An unexpected failure. Diagnostic detail is logged server-side and deliberately not returned. Quote the X-Request-Id response header when reporting one.

application/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

internal_error

{
  "code": "internal_error",
  "message": "internal server error"
}