Get the cost autopilot policy

import requests

url = "https://platform.ankra.app/api/v1/org/cloud-cost/autopilot"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://platform.ankra.app/api/v1/org/cloud-cost/autopilot', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "clusters": [
    {
      "cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "cluster_name": "<string>",
      "environment": "<string>",
      "environment_kind": "production",
      "override": {
        "expires_at": "2023-11-07T05:31:56Z",
        "reason": "<string>",
        "set_at": "2023-11-07T05:31:56Z",
        "set_by": "<string>",
        "tier": "hands-off"
      },
      "reason": "<string>",
      "source": "override",
      "tier": "hands-off",
      "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "defaults": {},
  "environment_kinds": [
    "production"
  ],
  "is_set": true,
  "notification_route_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "quiet_hours": {
    "end": "<string>",
    "start": "<string>",
    "timezone": "<string>"
  },
  "recommended_defaults": {},
  "tiers": [
    {
      "applies_to": "<string>",
      "does": "<string>",
      "name": "<string>",
      "proposes": "<string>",
      "rollback_window": "<string>",
      "tier": "hands-off"
    }
  ],
  "updated_at": "2023-11-07T05:31:56Z",
  "updated_by": "<string>",
  "scope": {
    "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "project_name": "<string>",
    "all_projects": true,
    "partial": true
  },
  "project_defaults": [
    {
      "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "project_name": "<string>",
      "defaults": {},
      "set_by": "<string>",
      "set_at": "2023-11-07T05:31:56Z"
    }
  ]
}

{
  "detail": "Cluster not found"
}

{
  "detail": "Cluster not found"
}

{
  "detail": "Cluster not found"
}

{
  "detail": "Cluster not found"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

{
  "detail": "Cluster not found"
}

Cost

Get the cost autopilot policy

How much Ankra may do about cost unasked (ankra cost autopilot): the tier each environment kind defaults to, the quiet hours, the notification route kept with the policy (no notice is sent to it today), the four tiers with what each lets Ankra do, and every live cluster with its tier, whether an override or its environment set it, and the sentence a card shows for it. An organisation that never set a policy reads is_set false and Hands-off for every kind; recommended_defaults is the policy the Autopilot view offers to turn on. Any member can read it. Bearer-PAT twin of the browser route of the same name under /org; the console’s session cookie is not accepted here and the browser route answers a token with a login redirect. The clusters listed are those of one project - the one project_id names, else the caller’s current project - that the caller may read; scope says what was read.

GET

api

org

cloud-cost

autopilot

Get the cost autopilot policy

import requests

url = "https://platform.ankra.app/api/v1/org/cloud-cost/autopilot"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://platform.ankra.app/api/v1/org/cloud-cost/autopilot', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "clusters": [
    {
      "cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "cluster_name": "<string>",
      "environment": "<string>",
      "environment_kind": "production",
      "override": {
        "expires_at": "2023-11-07T05:31:56Z",
        "reason": "<string>",
        "set_at": "2023-11-07T05:31:56Z",
        "set_by": "<string>",
        "tier": "hands-off"
      },
      "reason": "<string>",
      "source": "override",
      "tier": "hands-off",
      "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "defaults": {},
  "environment_kinds": [
    "production"
  ],
  "is_set": true,
  "notification_route_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "quiet_hours": {
    "end": "<string>",
    "start": "<string>",
    "timezone": "<string>"
  },
  "recommended_defaults": {},
  "tiers": [
    {
      "applies_to": "<string>",
      "does": "<string>",
      "name": "<string>",
      "proposes": "<string>",
      "rollback_window": "<string>",
      "tier": "hands-off"
    }
  ],
  "updated_at": "2023-11-07T05:31:56Z",
  "updated_by": "<string>",
  "scope": {
    "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "project_name": "<string>",
    "all_projects": true,
    "partial": true
  },
  "project_defaults": [
    {
      "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "project_name": "<string>",
      "defaults": {},
      "set_by": "<string>",
      "set_at": "2023-11-07T05:31:56Z"
    }
  ]
}

{
  "detail": "Cluster not found"
}

{
  "detail": "Cluster not found"
}

{
  "detail": "Cluster not found"
}

{
  "detail": "Cluster not found"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

{
  "detail": "Cluster not found"
}

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.

Query Parameters

project_id

string

The project to read: a project's id, or all for the whole organisation. Absent reads the caller's current project (the whole organisation while projects are off). A token pinned to a project, or a member limited to projects, may name only their own project.

Response

Successful response

The organisation's cost autopilot policy and every live cluster's tier under it.

clusters

CostAutopilotCluster · object[]

required

Show child attributes

defaults

object

required

The tier each environment kind defaults to; every kind is present.

Show child attributes

environment_kinds

enum<string>[]

required

Available options:

production,

staging,

development,

preview,

unknown

is_set

boolean

required

False for an organisation that never set a policy: every kind is then Hands-off.

notification_route_id

string<uuid> | null

required

The notification route kept with the policy, or null for none. No notice is sent to it today.

quiet_hours

CostAutopilotQuietHours · object | null

required

When the autopilot starts no change of its own; null for none.

Show child attributes

recommended_defaults

object

required

The policy the Autopilot view offers to turn on.

Show child attributes

tiers

CostAutopilotTier · object[]

required

Show child attributes

updated_at

string<date-time> | null

required

Null until a policy is set.

updated_by

string | null

required

The Ankra user id of the last change; null until a policy is set.

scope

CostReadScope · object

required

What a fleet cost read covered (ADR 0022): the project it read, or the whole organisation, and whether the caller's cluster permissions hid clusters from it.

Show child attributes

project_defaults

CostAutopilotProjectDefaults · object[]

required

The projects that set their own defaults, by project name: every one on an organisation-wide read, the scope's own project on a one-project read.

Show child attributes

API reference

Endpoints

Get the cost autopilot policy

Authorizations

Headers

Query Parameters

Response