Sign in
DigitalOcean-public.v2-new_Kubernetes

Fetch Clusterlint Diagnostics for a Kubernetes Cluster

To request clusterlint diagnostics for your cluster, send a GET request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID/clusterlint. If the run_id query parameter is provided, then the diagnostics for the specific run is fetched. By default, the latest results are shown.

To find out how to address clusterlint feedback, please refer to the clusterlint check documentation.

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

Path parameters

cluster_idstring uuid required

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

Query parameters

run_idstring uuid

Specifies the clusterlint run whose results will be retrieved.

Response

The response is a JSON object which contains the diagnostics on Kubernetes objects in the cluster. Each diagnostic will contain some metadata information about the object and feedback for users to act upon.

run_idstring

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

requested_atstring date-time

A time value given in ISO8601 combined date and time format that represents when the schedule clusterlint run request was made.

completed_atstring date-time

A time value given in ISO8601 combined date and time format that represents when the schedule clusterlint run request was completed.

Example response

{
  "run_id": "50c2f44c-011d-493e-aee5-361a4a0d1844",
  "requested_at": "2019-10-30T05:34:07Z",
  "completed_at": "2019-10-30T05:34:11Z",
  "diagnostics": [
    {
      "check_name": "unused-config-map",
      "severity": "warning",
      "message": "Unused config map",
      "object": {
        "name": "foo",
        "kind": "config map",
        "namespace": "kube-system"
      }
    }
  ]
}

Changes

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