Skip to main content
GET
/
v1
/
rules
List Rules
curl --request GET \
  --url https://tracer.lerian.io/v1/rules \
  --header 'Content-Type: <content-type>' \
  --header 'X-API-Key: <x-api-key>'
{
  "rules": [
    {
      "ruleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "description": "<string>",
      "expression": "<string>",
      "action": "ALLOW",
      "scopes": [
        {
          "segmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "portfolioId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "merchantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "transactionType": "CARD",
          "subType": "<string>"
        }
      ],
      "status": "DRAFT",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "activatedAt": "2023-11-07T05:31:56Z",
      "deactivatedAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "hasMore": true,
  "nextCursor": "<string>"
}

Headers

​
Content-Type
string
required

The type of media of the resource. Must be application/json.

​
X-API-Key
string
required

The API Key for authentication. This header is required for all endpoints except health checks.

​
X-Request-Id
string<uuid>

A unique identifier used to trace and track each request.

Query Parameters

​
limit
integer
default:10

The maximum number of items to include in the response. Default: 10, Max: 100

Required range: 1 <= x <= 100
​
cursor
string

Pagination cursor from previous response.

​
name
string

Filter by name (case-insensitive partial match).

Maximum string length: 255
​
status
enum<string>

Filter by status (DRAFT, ACTIVE, INACTIVE). DELETED rules are not listable.

Available options:
DRAFT,
ACTIVE,
INACTIVE
​
action
enum<string>

Filter by action (ALLOW, DENY, REVIEW).

Available options:
ALLOW,
DENY,
REVIEW
​
sortBy
enum<string>
default:createdAt

The field used to sort the results.

Available options:
createdAt,
name
​
sortOrder
enum<string>
default:DESC

The order used to sort the results.

Available options:
ASC,
DESC

Response

Indicates that the request was successful and the response contains the expected data.

Paginated list of rules.

​
rules
object[]

List of rule records.

​
hasMore
boolean

Whether there are more results available.

​
nextCursor
string | null

Cursor for fetching the next page. Null if no more results.