Get a scan

GET

/api/v1/scans/{id}

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

• Production
• Local development

Authorizations

• bearerAuth
• sessionCookie

Parameters

Path Parameters

id

required

string

Responses

200

OK

Media typeapplication/json

GET /scans/{id} response: the scan with its task breakdown

object

id

string

aws_account_id

string

trigger

string

triggered_by

string

status

string

stats

Are the aggregated counters on a scan

object

seen

integer

created

integer

updated

integer

deleted

integer

api_calls

integer

started_at

string format: date-time

finished_at

string format: date-time

created_at

string format: date-time

tasks

Array<object>

One account × region × service unit of work

object

id

string

aws_account_id

string

region

string

service

string

status

string

error

string

resource_count

integer

started_at

string format: date-time

finished_at

string format: date-time

Example^generated

{
  "id": "example",
  "aws_account_id": "example",
  "trigger": "example",
  "triggered_by": "example",
  "status": "example",
  "stats": {
    "seen": 1,
    "created": 1,
    "updated": 1,
    "deleted": 1,
    "api_calls": 1
  },
  "started_at": "2026-04-15T12:00:00Z",
  "finished_at": "2026-04-15T12:00:00Z",
  "created_at": "2026-04-15T12:00:00Z",
  "tasks": [
    {
      "id": "example",
      "aws_account_id": "example",
      "region": "example",
      "service": "example",
      "status": "example",
      "error": "example",
      "resource_count": 1,
      "started_at": "2026-04-15T12:00:00Z",
      "finished_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"
}