Fetch a single ruleset.

Look up a ruleset by id within the caller’s org. id may be either the MongoDB ObjectId hex or the custom ruleset_id string — the server tries ruleset_id first (so a custom id that happens to be 24 hex characters resolves correctly), and falls back to _id only when stage 1 misses. Soft-deleted rulesets and rulesets belonging to other orgs return 404.

GET /api/rulesets/{id}

Fetch a single ruleset.

cURL

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

200

{
  "_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",
  "applied_rules": [
    {
      "id": "operation-operationId",
      "description": "<string>",
      "message": "<string>",
      "severity": "warn",
      "type": "style",
      "recommended": true,
      "how_to_fix": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

The Tyk Dashboard API Access Credentials

Path Parameters

id · string · required

ObjectId hex or custom ruleset_id.

Response

200

application/json

Ruleset fetched.

_id · string

ruleset_id · string

Stable migration identifier. Same value across environments.

org_id · string

name · string

description · string

active · boolean

resource_type · string

action · string

categories · string[] | null

owner · string

ID of the user who created the ruleset. Set server-side from the session; cannot be supplied by the caller.

definition · string

Full Spectral ruleset definition stored as a JSON string.

is_template · boolean

date_created · string<date-time>

last_updated · string<date-time>

applied_rules · object[]

Full list of rules that would fire when this ruleset is evaluated, after resolving any extends directives. Computed at read time, never persisted. Empty when resolution fails.

Show child attributes