cURL
curl --request GET \
--url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/runtime-scanning \
--header 'Authorization: Bearer REPLACE_BEARER_TOKEN'{
"type": "WIZ"
}{
"code": 123,
"details": [
{
"@type": "<string>"
}
],
"message": "<string>"
}Get the runtime scanning status of a cluster.
Can be used by the following roles assigned at the organization, folder or cluster scope:
- CLUSTER_ADMIN
- CLUSTER_OPERATOR_WRITER
- CLUSTER_DEVELOPER
- AUDITOR
- CLUSTER_DATA_ACCESSOR
GET
/
api
/
v1
/
clusters
/
{cluster_id}
/
runtime-scanning
cURL
curl --request GET \
--url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/runtime-scanning \
--header 'Authorization: Bearer REPLACE_BEARER_TOKEN'{
"type": "WIZ"
}{
"code": 123,
"details": [
{
"@type": "<string>"
}
],
"message": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
cluster_id is the ID of the cluster.
Response
A successful response.
RuntimeScanningInfo describes the runtime scanning configuration of a cluster. It is returned by the get, enable, and disable runtime scanning endpoints.
- NONE: NONE indicates runtime scanning is disabled; no agent is enforced.
- WIZ: WIZ indicates runtime scanning is enforced using the Wiz agent.
Available options:
NONE, WIZ