Outbound traffic management

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}/networking/egress-rules/egress-traffic-policy

cURL

cURL

curl --request POST \
  --url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/networking/egress-rules/egress-traffic-policy \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "allow_all": true
}
'

200

{}

{
  "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

cluster_id identifies the cluster whose egress policy will be updated.

Body

application/json

allow_all · boolean · required

allow_all, if true results in unrestricted egress traffic. If false, egress traffic is set to default-deny and is managed via the Egress Rule Management API.

idempotency_key · string

idempotency_key uniquely identifies this request. If not set, it will be set by the server.

Response

200

application/json

A successful response.

The response is of type object.