API reference

Rule sets

Rule sets referenced by policies.

Create a rule set

POST/v1/rulesets

Scopes
policies:write
Required header
Idempotency-Key

Request bodyRuleSetCreate

FieldTypeRequired
namestringyes
rulesarray of Ruleyes
default_actionenum: inconclusive, request_evidence, route_review, rejectyes

Responses

  • 201RuleSet
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503

Get a rule set

GET/v1/rulesets/{ruleset_id}

Scopes
policies:read

Parameters

FieldTypeRequired
ruleset_idpathstring (uuid)yes

Responses

  • 200RuleSet
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503

Update a rule set

PUT/v1/rulesets/{ruleset_id}

Scopes
policies:write
Required header
If-Match

Parameters

FieldTypeRequired
ruleset_idpathstring (uuid)yes

Request bodyRuleSetCreate

FieldTypeRequired
namestringyes
rulesarray of Ruleyes
default_actionenum: inconclusive, request_evidence, route_review, rejectyes

Responses

  • 200RuleSet
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503