Disable Prometheus Metric Export for a cluster

Can be used by the following roles assigned at the organization, folder or cluster scope:

• CLUSTER_ADMIN
• CLUSTER_OPERATOR_WRITER

DELETE /api/v1/clusters/{cluster_id}/metricexport/prometheus

cURL

cURL

curl --request DELETE \
  --url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/metricexport/prometheus \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

200

{
  "cluster_id": "<string>"
}

{
  "code": 123,
  "details": [
    {
      "@type": "<string>"
    }
  ],
  "message": "<string>"
}

This endpoint is in Preview and subject to change. Refer to the API support policy for more details.

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

cluster_id · string · required

Response

200

application/json

A successful response.

cluster_id · string · required

status · enum<string>

Available options: NOT_DEPLOYED, DISABLING, ENABLING, ENABLED, ERROR