---
title: "Get the traffic rule catalog"
method: GET
path: "/v1/rules/catalog"
tags: ["Spaces"]
---

# Get the traffic rule catalog

`GET /v1/rules/catalog`

## Request

- Base URL: `https://api.spacefast.com`
- URL: `https://api.spacefast.com/v1/rules/catalog`
- Auth: HTTP bearer

Returns the request attributes a traffic rule can match on, the comparisons each one makes, and what the platform caps. The same for every space. Read this before you write a rule: a field only makes the comparisons listed for it.

## Response `200`

Response for status 200

- object
  - `$schema` string, uri: Canonical JSON Schema URL for this response body. The server also sends it in the `Link: rel="describedby"` response header.
  - `data` TrafficRuleCatalog, required: What a traffic rule may match on, compare with, and how large it may be.
    - `fields` object, required: The request attributes a rule can match on.
    - `operators` object, required: Every comparison, and what it does.
    - `limits` object, required: What the platform accepts. The edge may allow fewer rules than a space may declare.
      - `rulesPerSpace` integer, required: Rules one space may declare, per list.
      - `conditionsPerRule` integer, required: Comparisons one cache-bypass rule may make.
      - `firewallConditionsPerRule` integer: Comparisons one firewall rule may make.
      - `valuesPerCondition` integer, required: Values one `in` or `inCidr` may list.
      - `valueCharacters` integer, required: Characters one value may have.
      - `descriptionCharacters` integer, required: Characters a rule's description may have.

## Other responses

- `default`: Problem details (RFC 9457). Any 4xx/5xx response is one `application/problem+json` document.

---

[API](https://skmtc.dev/spacefast/apis/spacefast-api.md) · [All operations](https://skmtc.dev/spacefast/apis/spacefast-api/llms.txt) · [OpenAPI document](https://skmtc.dev/spacefast/apis/spacefast-api/revisions/bd165bc7c983?raw)