API Reference
Log In
API Reference

Get compiled enforcement rules for a team, or one rule of it

Returns the cost control rules currently in force for the specified team. Sending 'ruleId' narrows the read to that one rule, so you do not need to fetch the team's whole list. A rule that is not in the current set answers 200 with an empty rules list and the set's own compiledAt timestamp.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Query Params
string

Optional short string ID of one rule, which is the ID of the cost control it was compiled from (such as mN3xpQz). The numeric ruleId in the response is not accepted here. When it is sent, the answer carries at most that one rule. When it is left out, every compiled rule on the team is returned.

string

Send advisory to also receive the team's notify-only per-person budgets as rows whose action is NOTIFY and whose source is ANOMALY, after the cost-control rows. Such a row never blocks. Ignored when ruleId is sent. Without it the answer carries cost-control rows only.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/hal+json
*/*