Skip to main content

Fetch a Single Cluster

GET 
/clusters/:cluster_id

Retrieve a specific cluster by its ID. The cluster must belong to the client.

Request​

Path Parameters

    cluster_id Cluster Idrequired

Header Parameters

    X-Nops-Api-Key stringrequired

    API key for authentication

Responses​

Successful Response

Schema

    id Id (integer)required
    external_id External Id (string)required
    name Name (string)required
    arn Arn (string)required
    region Region (string)required
    vpc Vpc (string)required
    status Status (string)required
    client_id Client Id (string)required
    account_id Account Id (string)required
    last_agent_status date-time
    onboarded Onboarded (boolean)required
    onboarded_at date-time
    configured Configured (boolean)required

    configuration_statuses

    object

    required

    karpenter Karpenter (boolean)
    cluster_autoscaler Cluster Autoscaler (boolean)
    bc_plus Bc Plus (boolean)
    k8s_data_fetcher K8S Data Fetcher (boolean)
    installed_agent_version Installed Agent Version (string)
    is_ga_karpenter Is Ga Karpenter (boolean)
    eks_version Eks Version (string)
    savings_daily Savings Daily (number)
    savings_for_period Savings For Period (number)
    realized_daily Realized Daily (number)
    realized_for_period Realized For Period (number)
    cost_daily Cost Daily (number)
    cost_for_period Cost For Period (number)
    autoscaler_type Autoscaler Type (string)required
    api_key_id Api Key Id (integer)
Loading...