Get the organisation's fleet cost rollup

import requests

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

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/summary', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "by_credential": [
    {
      "cluster_count": 123,
      "credential_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "credential_name": "<string>",
      "month_to_date_cents": 123,
      "monthly_cost_estimate_cents": 123,
      "projected_month_end_cents": 123,
      "provider": "<string>"
    }
  ],
  "by_provider": [
    {
      "cluster_count": 123,
      "month_to_date_cents": 123,
      "monthly_cost_estimate_cents": 123,
      "projected_month_end_cents": 123,
      "provider": "<string>"
    }
  ],
  "cluster_count": 123,
  "clusters": [
    {
      "cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "cluster_name": "<string>",
      "confidence_level": "<string>",
      "credential_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "credential_name": "<string>",
      "inventory_freshness": "fresh",
      "inventory_observed_at": "2023-11-07T05:31:56Z",
      "month_hours": {
        "cluster_count": 123,
        "hours_elapsed": 123,
        "hours_estimated": 123,
        "hours_measured": 123,
        "hours_metered": 123,
        "is_short": true,
        "note": "<string>",
        "short_cluster_count": 123
      },
      "month_to_date_cents": 123,
      "monthly_cost_estimate_cents": 123,
      "projected_month_end_cents": 123,
      "provider": "<string>",
      "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "project_name": "<string>",
      "price_list_as_of": "2023-12-25",
      "price_source": "provider_list"
    }
  ],
  "currency": "<string>",
  "month_hours": {
    "cluster_count": 123,
    "hours_elapsed": 123,
    "hours_estimated": 123,
    "hours_measured": 123,
    "hours_metered": 123,
    "is_short": true,
    "note": "<string>",
    "short_cluster_count": 123
  },
  "month_to_date_cents": 123,
  "monthly_cost_estimate_cents": 123,
  "projected_month_end_cents": 123,
  "top_clusters": [
    {
      "cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "cluster_name": "<string>",
      "confidence_level": "<string>",
      "credential_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "credential_name": "<string>",
      "inventory_freshness": "fresh",
      "inventory_observed_at": "2023-11-07T05:31:56Z",
      "month_hours": {
        "cluster_count": 123,
        "hours_elapsed": 123,
        "hours_estimated": 123,
        "hours_measured": 123,
        "hours_metered": 123,
        "is_short": true,
        "note": "<string>",
        "short_cluster_count": 123
      },
      "month_to_date_cents": 123,
      "monthly_cost_estimate_cents": 123,
      "projected_month_end_cents": 123,
      "provider": "<string>",
      "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "project_name": "<string>",
      "price_list_as_of": "2023-12-25",
      "price_source": "provider_list"
    }
  ],
  "generated_at": "2023-11-07T05:31:56Z",
  "stale_cluster_count": 123,
  "unmetered_clusters": [
    {
      "cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "cluster_name": "<string>",
      "is_deleted": true,
      "is_inventory_stale": true,
      "is_moved_out": true,
      "is_unpriced": true,
      "last_snapshot_at": "2023-11-07T05:31:56Z",
      "month_hours": {
        "cluster_count": 123,
        "hours_elapsed": 123,
        "hours_estimated": 123,
        "hours_measured": 123,
        "hours_metered": 123,
        "is_short": true,
        "note": "<string>",
        "short_cluster_count": 123
      },
      "month_to_date_cents": 123,
      "provider": "<string>"
    }
  ],
  "unmetered_month_to_date_cents": 123,
  "scope": {
    "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "project_name": "<string>",
    "all_projects": true,
    "partial": true
  },
  "by_project": [
    {
      "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "project_name": "<string>",
      "cluster_count": 123,
      "monthly_cost_estimate_cents": 123,
      "month_to_date_cents": 123,
      "projected_month_end_cents": 123
    }
  ],
  "unpriced_cluster_count": 123
}

{
  "detail": "Cluster not found"
}

{
  "detail": "Cluster not found"
}

{
  "detail": "Cluster not found"
}

{
  "detail": "Cluster not found"
}

{
  "detail": "Cluster not found"
}

{
  "detail": "Cluster not found"
}

GET

api

org

cloud-cost

summary

Get the organisation's fleet cost rollup

import requests

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

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/summary', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "by_credential": [
    {
      "cluster_count": 123,
      "credential_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "credential_name": "<string>",
      "month_to_date_cents": 123,
      "monthly_cost_estimate_cents": 123,
      "projected_month_end_cents": 123,
      "provider": "<string>"
    }
  ],
  "by_provider": [
    {
      "cluster_count": 123,
      "month_to_date_cents": 123,
      "monthly_cost_estimate_cents": 123,
      "projected_month_end_cents": 123,
      "provider": "<string>"
    }
  ],
  "cluster_count": 123,
  "clusters": [
    {
      "cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "cluster_name": "<string>",
      "confidence_level": "<string>",
      "credential_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "credential_name": "<string>",
      "inventory_freshness": "fresh",
      "inventory_observed_at": "2023-11-07T05:31:56Z",
      "month_hours": {
        "cluster_count": 123,
        "hours_elapsed": 123,
        "hours_estimated": 123,
        "hours_measured": 123,
        "hours_metered": 123,
        "is_short": true,
        "note": "<string>",
        "short_cluster_count": 123
      },
      "month_to_date_cents": 123,
      "monthly_cost_estimate_cents": 123,
      "projected_month_end_cents": 123,
      "provider": "<string>",
      "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "project_name": "<string>",
      "price_list_as_of": "2023-12-25",
      "price_source": "provider_list"
    }
  ],
  "currency": "<string>",
  "month_hours": {
    "cluster_count": 123,
    "hours_elapsed": 123,
    "hours_estimated": 123,
    "hours_measured": 123,
    "hours_metered": 123,
    "is_short": true,
    "note": "<string>",
    "short_cluster_count": 123
  },
  "month_to_date_cents": 123,
  "monthly_cost_estimate_cents": 123,
  "projected_month_end_cents": 123,
  "top_clusters": [
    {
      "cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "cluster_name": "<string>",
      "confidence_level": "<string>",
      "credential_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "credential_name": "<string>",
      "inventory_freshness": "fresh",
      "inventory_observed_at": "2023-11-07T05:31:56Z",
      "month_hours": {
        "cluster_count": 123,
        "hours_elapsed": 123,
        "hours_estimated": 123,
        "hours_measured": 123,
        "hours_metered": 123,
        "is_short": true,
        "note": "<string>",
        "short_cluster_count": 123
      },
      "month_to_date_cents": 123,
      "monthly_cost_estimate_cents": 123,
      "projected_month_end_cents": 123,
      "provider": "<string>",
      "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "project_name": "<string>",
      "price_list_as_of": "2023-12-25",
      "price_source": "provider_list"
    }
  ],
  "generated_at": "2023-11-07T05:31:56Z",
  "stale_cluster_count": 123,
  "unmetered_clusters": [
    {
      "cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "cluster_name": "<string>",
      "is_deleted": true,
      "is_inventory_stale": true,
      "is_moved_out": true,
      "is_unpriced": true,
      "last_snapshot_at": "2023-11-07T05:31:56Z",
      "month_hours": {
        "cluster_count": 123,
        "hours_elapsed": 123,
        "hours_estimated": 123,
        "hours_measured": 123,
        "hours_metered": 123,
        "is_short": true,
        "note": "<string>",
        "short_cluster_count": 123
      },
      "month_to_date_cents": 123,
      "provider": "<string>"
    }
  ],
  "unmetered_month_to_date_cents": 123,
  "scope": {
    "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "project_name": "<string>",
    "all_projects": true,
    "partial": true
  },
  "by_project": [
    {
      "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "project_name": "<string>",
      "cluster_count": 123,
      "monthly_cost_estimate_cents": 123,
      "month_to_date_cents": 123,
      "projected_month_end_cents": 123
    }
  ],
  "unpriced_cluster_count": 123
}

{
  "detail": "Cluster not found"
}

{
  "detail": "Cluster not found"
}

{
  "detail": "Cluster not found"
}

{
  "detail": "Cluster not found"
}

{
  "detail": "Cluster not found"
}

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

by_credential

FleetCredentialCost · object[]

required

Show child attributes

by_provider

FleetProviderCost · object[]

required

Show child attributes

cluster_count

integer

required

clusters

FleetClusterCost · object[]

required

Show child attributes

currency

string

required

month_hours

MonthHours · object | null

required

The hours of every cluster month_to_date_cents counts, the unmetered ones included, summed (MonthHours). Null when no cluster is counted or any counted cluster's hours are missing.

Show child attributes

month_to_date_cents

integer

required

monthly_cost_estimate_cents

integer

required

projected_month_end_cents

integer

required

top_clusters

FleetClusterCost · object[]

required

Show child attributes

generated_at

string<date-time> | null

required

When the newest cost snapshot behind these figures was computed (RFC 3339, UTC), so a reader can say how fresh they are rather than when it asked. Null when no cluster has a snapshot in the window.

stale_cluster_count

integer

required

How many of unmetered_clusters are live clusters whose node inventory went stale (is_inventory_stale): their spend since they were last metered is in no figure here, so with any of them the month end is a floor.

unmetered_clusters

FleetUnmeteredCluster · object[]

required

The clusters in scope that spent money this month but carry no fresh snapshot: deleted this month, with metering that has stalled, or - on a project read - moved to another project after spending under this one; every live cluster priced before whose node inventory went stale, spent this month or not; and every live cluster whose fresh snapshot priced nothing, with is_unpriced, spent this month or not. What they spent is part of month_to_date_cents and projected_month_end_cents; they add no pace and are not in clusters or cluster_count. by_project carries their spend under the projects it was stamped with, by_credential under the credentials it was stamped with, and by_provider under the provider of each one's last snapshot, none of them counting it as a cluster.

Show child attributes

unmetered_month_to_date_cents

integer

required

What the unmetered clusters spent this month, in the display currency: the part of month_to_date_cents no metered cluster accounts for. by_provider, by_credential and by_project each carry it already, so each of them alone sums to month_to_date_cents.

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

by_project

FleetProjectCost · object[]

required

The month split by project, with the unattributed bucket; it sums to the totals above, unmetered spend included.

Show child attributes

unpriced_cluster_count

integer

required

How many live, unarchived clusters in scope no fresh cost snapshot prices and that are not known to spend nothing: the same rule a budget over the same clusters states its unpriced_cluster_count by. It counts a cluster with no snapshot in the last day, one whose node inventory went stale, and one whose fresh snapshot priced nothing (the unmetered_clusters entries with is_unpriced, which name a subset of it). Their pace is unknown, never zero, so while this is above zero monthly_cost_estimate_cents and projected_month_end_cents are floors. A cluster Ankra stopped that holds no machine is not counted. They are not in clusters or cluster_count.

API reference

Endpoints

Get the organisation's fleet cost rollup

Authorizations

Headers

Query Parameters

Response