List rulesets.

Return a paginated list of rulesets within the caller’s org. Supports filtering by q (case-insensitive name substring), active, is_template, categories, resource_type, and sorting via sort (prefix - for descending). By default, templates (admin-seeded fixtures) are excluded from the response. Pass ?is_template=true to fetch templates only, or ?is_template=false to explicitly request non-templates (same as the default).

GET /api/rulesets

List rulesets.

cURL

curl --request GET \
  --url https://{tenant}/api/rulesets \
  --header 'Authorization: Bearer <token>'

200

{
  "rulesets": [
    {
      "_id": "<string>",
      "ruleset_id": "<string>",
      "org_id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "active": true,
      "resource_type": "<string>",
      "action": "<string>",
      "categories": [
        "<string>"
      ],
      "owner": "<string>",
      "definition": "<string>",
      "is_template": true,
      "date_created": "2023-11-07T05:31:56Z",
      "last_updated": "2023-11-07T05:31:56Z"
    }
  ],
  "pages": 123
}

Authorizations

Authorization · string · header · required

The Tyk Dashboard API Access Credentials

Query Parameters

p · integer

Page number. Send -1 to return all results.

q · string

Case-insensitive substring filter on name.

active · boolean

Filter by active status. Omit to return rulesets regardless of active state.

is_template · boolean

Filter by template flag. When omitted, templates are excluded by default. Pass true to fetch templates only, or false to explicitly request non-templates.

categories · string

Filter rulesets that contain this category.

resource_type · enum<string>

Filter by resource type. One of oas-api or mcp-api.

Available options: oas-api, mcp-api

sort · string

Sort field; prefix - for descending. Sortable fields: name, date_created, last_updated. Default: -last_updated. Unknown fields fall back to the default rather than erroring.

Response

200

application/json

Rulesets fetched.

rulesets · object[]

Show child attributes

pages · integer