Update an IP allowlist entry

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

• CLUSTER_ADMIN
• CLUSTER_OPERATOR_WRITER

PATCH /api/v1/clusters/{cluster_id}/networking/allowlist/{cidr_ip}/{cidr_mask}

cURL

cURL

curl --request PATCH \
  --url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/networking/allowlist/{cidr_ip}/{cidr_mask} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sql": true,
  "ui": true
}
'

200

{
  "cidr_ip": "192.168.1.1",
  "cidr_mask": 32,
  "name": "Example",
  "sql": true,
  "ui": true
}

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

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

cidr_ip · string · required

cidr_mask · integer<int32> · required

Body

application/json

AllowlistEntry

sql · boolean · required

ui · boolean · required

name · string

Response

200

application/json

A successful response.

cidr_ip · string · required

cidr_mask · integer<int32> · required

sql · boolean · required

ui · boolean · required

name · string