Skip to main content
GET
Get hosted log shipping

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-ankra-organisation-id
string

PAT organisation override.

Path Parameters

cluster_id
string<uuid>
required

Response

Successful response

A cluster's hosted log shipping switch.

cluster_id
string<uuid>
required
shipping_enabled
boolean
required

The stored switch. Off for every cluster until a member turns it on.

available
boolean
required

Ankra's hosted log store is live on this platform. While false the switch can be stored, but nothing ships and nothing is read.

agent_supports_switch
boolean
required

The cluster's agent advertised that it obeys the switch. False means no agent can ship yet: the agent needs an upgrade, or hosted log shipping is turned off in its own Helm values.

changed_at
string<date-time> | null
required

When the switch last changed; null when nobody has changed it.