Get the relationship graph

GET

/api/v1/graph

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

• Production
• Local development

Authorizations

• bearerAuth
• sessionCookie

Responses

200

OK

Media typeapplication/json

Bounded subgraph the map renders

object

focus

string

nodes

Array<object>

One node in a map subgraph

object

key

string

entity_type

string

id

string

name

string

resource_type

string

aws_account_id

string

region

string

collapsed_count

integer

edges

Array<object>

One edge in a map subgraph

object

id

string

source_key

string

target_key

string

relationship_type

string

confidence

string

status

string

truncated

boolean

Example^generated

{
  "focus": "example",
  "nodes": [
    {
      "key": "example",
      "entity_type": "example",
      "id": "example",
      "name": "example",
      "resource_type": "example",
      "aws_account_id": "example",
      "region": "example",
      "collapsed_count": 1
    }
  ],
  "edges": [
    {
      "id": "example",
      "source_key": "example",
      "target_key": "example",
      "relationship_type": "example",
      "confidence": "example",
      "status": "example"
    }
  ],
  "truncated": true
}

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

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