human-readable description of this IP restriction. optional, max 255 bytes.
metadatastring
arbitrary user-defined machine-readable data of this IP restriction. optional, max 4096 bytes.
enforcedboolean
true if the IP restriction will be enforced. if false, only warnings will be issued
typestring required
the type of IP restriction. this defines what traffic will be restricted with the attached policies. four values are currently supported: dashboard, api, agent, and endpoints
ip_policy_idsstring[] required
the set of IP policy identifiers that are used to enforce the restriction
Response
Create a new IP restriction
idstring
unique identifier for this IP restriction
uristring
URI of the IP restriction API resource
created_atstring
timestamp when the IP restriction was created, RFC 3339 format
descriptionstring
human-readable description of this IP restriction. optional, max 255 bytes.
metadatastring
arbitrary user-defined machine-readable data of this IP restriction. optional, max 4096 bytes.
enforcedboolean
true if the IP restriction will be enforced. if false, only warnings will be issued
typestring
the type of IP restriction. this defines what traffic will be restricted with the attached policies. four values are currently supported: dashboard, api, agent, and endpoints