Delete the Log Export configuration for a cluster

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

• ORG_ADMIN
• CLUSTER_ADMIN
• CLUSTER_OPERATOR_WRITER

DELETE /api/v1/clusters/{cluster_id}/logexport

cURL

cURL

curl --request DELETE \
  --url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/logexport \
  --header 'Authorization: Bearer <token>'

200

{
  "cluster_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "spec": {
    "auth_principal": "<string>",
    "aws_external_id": "<string>",
    "azure_shared_key": "<string>",
    "groups": [
      {
        "channels": [
          "<string>"
        ],
        "log_name": "<string>",
        "enable_sending_queue": true,
        "redact": true
      }
    ],
    "log_name": "<string>",
    "omitted_channels": [
      "<string>"
    ],
    "redact": true,
    "region": "<string>"
  },
  "updated_at": "2023-11-07T05:31:56Z",
  "user_message": "<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.

LogExportClusterInfo contains a package of information that fully describes both the intended state of the log export configuration for a specific cluster but also some metadata around its deployment status, any error messages, and some timestamps.

cluster_id · string

created_at · string<date-time>

spec · object

LogExportClusterSpecification contains all the data necessary to configure log export for an individual cluster. Users would supply this data via the API and also receive it back when inspecting the state of their log export configuration.

Show child attributes

status · enum<string>

LogExportStatus encodes the possible states that a configuration can be in as it is created, deployed, and disabled.

Available options: DISABLED, DISABLING, DISABLE_FAILED, ENABLED, ENABLING, ENABLE_FAILED, CREDENTIALS_ERROR

updated_at · string<date-time>

user_message · string