Skip to main content
GET
Get the cluster architecture map (browser session)

Authorizations

ankra_session
string
cookie
required

Browser session. Mutations also require X-Ankra-CSRF.

Path Parameters

cluster_id
string<uuid>
required

Query Parameters

application_id
string<uuid>

Focus the map on this application: its namespaces on the cluster and their neighbours are expanded.

environment_id
string<uuid>

With application_id, take only the application's installations in this environment.

Response

The cluster's architecture map

The cluster drawn from Ankra's synchronised copy of it and Ankra's own records.

cluster_id
string<uuid>
required
observed_at
string<date-time> | null
required

When the synchronised copy last heard from the cluster; null when it never has.

mirror
enum<string>
required

fresh: every kind read synchronised within the platform's staleness limit. stale: at least one is older, or a kind every cluster serves has never synchronised while others have (TunnelBindings, which only some clusters serve, may be missing), so the map may be behind the cluster or missing parts of it; the answer does not say which kind. not_synced: the cluster has never been synchronised and nothing is drawn, which is not an empty cluster.

Available options:
fresh,
stale,
not_synced
focus
ClusterArchitectureFocus · object | null
required

The application the map is focused on.

groups
ClusterArchitectureGroup · object[]
required
nodes
ClusterArchitectureNode · object[]
required
edges
ClusterArchitectureEdge · object[]
required
capped
boolean
required

The map is not the whole cluster: a cap (300 groups, 600 nodes, 1000 edges, or a record listing) was reached, or an object in Ankra's synchronised copy could not be read in full, so lines it would give are not drawn.

not_drawn
enum<string>[]
required

What the map does not draw, so an absent line is not read as an absent connection. managed_services_not_shown: the cluster runs managed services the caller may not list, or more than were read.

Available options:
traffic,
gateway_api,
databases_outside_ankra,
tunnel_binding_routes,
statefulset_claim_templates,
stack_owners,
managed_services_not_shown