Skip to main content
GET
/
api
/
admin
/
rulesets
Get rulesets
curl --request GET \
  --url https://{instance}.{env}.on-hellgate.cloud/api/admin/rulesets \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "activated_at": "2023-11-07T05:31:56Z",
      "context": "checkout",
      "created_at": "2023-11-07T05:31:56Z",
      "created_by": "<string>",
      "description": "<string>",
      "rules": [
        {
          "enabled": true,
          "id": "r1",
          "async": true,
          "backend": "vdm",
          "condition": {},
          "description": "<string>",
          "fields": [
            "<string>"
          ],
          "live": true,
          "members": [
            {
              "backend": "vdm",
              "live": true,
              "weight": 60
            }
          ],
          "name": "Block USD",
          "populate_on": [],
          "ttl_seconds": 123
        }
      ],
      "version": 1
    }
  ],
  "links": {
    "next": "<string>"
  }
}

Authorizations

Authorization
string
header
required

HS256-signed JWT bearer token, obtained via the OAuth2 client-credentials grant (see Authentication).

Query Parameters

after
string

Pagination cursor

limit
integer

Page size (default 20)

Response

Ruleset list

data
Ruleset · object[]
required