cURL
curl --request POST \
--url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/runtime-scanning \
--header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
--json '{"type":"WIZ"}'{
"type": "WIZ"
}{
"code": 123,
"details": [
{
"@type": "<string>"
}
],
"message": "<string>"
}Enable runtime scanning on a cluster.
Can be used by the following roles assigned at the organization, folder or cluster scope:
- CLUSTER_ADMIN
- CLUSTER_OPERATOR_WRITER
POST
/
api
/
v1
/
clusters
/
{cluster_id}
/
runtime-scanning
cURL
curl --request POST \
--url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/runtime-scanning \
--header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
--json '{"type":"WIZ"}'{
"type": "WIZ"
}{
"code": 123,
"details": [
{
"@type": "<string>"
}
],
"message": "<string>"
}This endpoint is in Limited Access and may not be available to all users. Refer to the API support policy for more details.
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.
Body
application/json
EnableClusterRuntimeScanningRequest is used to enable runtime scanning on a cluster.
- 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 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