Skip to navigation
API Referenceegress-rules

Create a new egress rule

Authentication

X-API-Client-IDstring
API Client ID
X-API-Client-Secretstring
API Client Secret

Request

This endpoint expects an object.
protocolstringRequired

Protocol the rule applies to. One of TCP, UDP, ICMP, or ALL.

startPortintegerOptional1-65535
Start of the port range the rule applies to.
endPortintegerOptional1-65535
End of the port range the rule applies to.
sourceCidrListstringOptional

Source CIDR within the network’s CIDR — which senders inside the network the rule matches. Omit to match the entire network.

destCidrListstringOptionalDefaults to 0.0.0.0/0

Destination CIDR the rule matches — where the outbound traffic is headed. Defaults to 0.0.0.0/0 (anywhere). Whether matching traffic is permitted or blocked depends on the network: see action on the created rule.

networkIdstringOptionalformat: "uuid"
Identifier of the network the egress rule applies to.

Response

The egress rule has been created
idstringformat: "uuid"
Unique identifier for the egress rule.
protocolstring

Protocol the rule applies to. One of TCP, UDP, ICMP, or ALL.

networkIdstringformat: "uuid"
Identifier of the network this rule belongs to.
statestring
Current lifecycle state of the rule.
sourceCidrListstring
Source CIDR within the network's CIDR.
startPortintegerOptional
Start of the port range the rule applies to.
endPortintegerOptional
End of the port range the rule applies to.
actionenumOptional

allow permits the traffic this rule matches; deny blocks it. Which one applies is set by the rule’s network, not by the rule, and is the opposite of that network’s defaultEgressPolicy. Omitted when unknown.

Allowed values:
destCidrListstringOptional

Destination CIDR this rule matches. Whether matching traffic is permitted or blocked depends on action.

createdAtdatetimeOptional
When the rule was created.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error