Balrog/Admin API

Balrog's Admin app provides an API that allows for retrieval and modification of Rules, Releases, and Permissions. This page documents all of the available endpoints, their parameters, and responses.

POST and PUT requests may submit parameters as multipart form data or json.

Rules

/rules

GET

Returns all of the Rules in Balrog's database inside of a JSON Object in the following format:

{
  "count": 2,
  "rules": [
    {
      "rule_id": 1,
      ...
    },
    {
      "rule_id": 2,
      ...
    }
  ]
}

POST

Creates a new rule with the provided values. The following parameters are supported:

• priority (required)
• backgroundRate (required)
• mapping
• alias
• product
• version
• buildID
• channel
• locale
• distribution
• buildTarget
• osVersion
• distVersion
• whitelist
• comment
• headerArchitecture

For detailed information on parameters see [| the Rule table documentation].

/rules/<id_or_alias>

GET

Returns the entire rule identified by the id or alias given in JSON format. Eg:

{
  "rule_id": 3,
  "product": "Firefox",
  ...
}

POST

Modifies the rule identified by the id or alias given according to the parameters given. The following parameters are supported:

• data_version (required)
• priority
• backgroundRate
• mapping
• alias
• product
• version
• buildID
• channel
• locale
• distribution
• buildTarget
• osVersion
• distVersion
• whitelist
• comment
• headerArchitecture

DELETE

Deletes the rule identified by the id or alias given. The following parameters are supported:

• data_version (required)