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

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.

Servers

Path parameters

Name Type Required Description
cluster_id String Yes

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

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
exclude_checks[] Array No

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

include_groups[] Array No

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

exclude_groups[] Array No

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

include_checks[] Array No

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

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.