Skip to main content
POST
cURL
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 to which this egress rule applies.

Body

application/json

AddEgressRuleRequest is the input for the rpc AddEgressRule().

description
string
required

description is text that serves to document the rules purpose.

destination
string
required

destination is the endpoint (or subnetwork if CIDR) to which traffic is allowed.

name
string
required

name is the name of the egress rule.

type
string
required

type classifies the Destination field. Valid types include: "FQDN", "CIDR".

idempotency_key
string

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

paths
string[]

paths are the allowed URL paths. If empty, all paths are allowed. Only valid if Type="FQDN".

ports
integer<int32>[]

ports are the allowed ports for TCP protocol. If Empty, all ports are allowed.

Response

A successful response.

AddEgressRuleResponse is the response message of the AddEgressRule RPC.

Rule
EgressRule · object

EgressRule represents a network egress rule.