Sign in
DigitalOcean-public.v2-new_Kubernetes

Run Clusterlint Checks on a Kubernetes Cluster

Clusterlint helps operators conform to Kubernetes best practices around resources, security and reliability to avoid common problems while operating or upgrading the clusters.

To request a clusterlint run on your cluster, send a POST request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID/clusterlint. This will run all checks present in the doks group by default, if a request body is not specified. Optionally specify the below attributes.

For information about the available checks, please refer to the clusterlint check documentation.

post/v2/kubernetes/clusters/{cluster_id}/clusterlint

Path parameters

cluster_idstring uuid required

A unique ID that can be used to reference a Kubernetes cluster.

Request body

include_groupsstring[]

An array of check groups that will be run when clusterlint executes checks.

include_checksstring[]

An array of checks that will be run when clusterlint executes checks.

exclude_groupsstring[]

An array of check groups that will be omitted when clusterlint executes checks.

exclude_checksstring[]

An array of checks that will be run when clusterlint executes checks.

Example request

{
  "include_groups": [
    "basic",
    "doks",
    "security"
  ],
  "include_checks": [
    "bare-pods",
    "resource-requirements"
  ],
  "exclude_groups": [
    "workload-health"
  ],
  "exclude_checks": [
    "default-namespace"
  ]
}

Response

The response is a JSON object with a key called run_id that you can later use to fetch the run results.

run_idstring

ID of the clusterlint run that can be used later to fetch the diagnostics.

Example response

{
  "run_id": "50c2f44c-011d-493e-aee5-361a4a0d1844"
}

Changes

Changed in 4 of the 8 revisions of this API.14