Skip to content

Create Ip Rule

POST /ip-rules
FieldTypeNotes
cidrstringrequiredmin length 1 max length 64
actionallow | denyrequired—
descriptionstring | nulloptionalmax length 300
scopeworkspace | organization | platformoptionalDefault "workspace".
StatusDescriptionBody
201Successful ResponseIpRuleView
422Validation ErrorHTTPValidationError

The body shows the fields the schema always carries. Which combination is legal is a service rule the schema cannot express, so read the description above before copying this.

Terminal window
curl -X POST https://your-deployment.example.com/ip-rules \
-H "Authorization: Bearer $COBRE_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"cidr": "string",
"action": "allow"
}'
FieldTypeNotes
idstring (uuid)required—
cidrstringrequired—
actionallow | denyrequired—
descriptionstring | nulloptional—
is_activebooleanrequired—
scopeworkspace | organization | platformrequired—
organization_idstring (uuid) | nulloptional—
workspace_idstring (uuid) | nulloptional—
created_atstring (date-time)required—