v1

latestOpenAPI 3.1.02026-07-1324323188.8 KB

Rule

Retrieves a Rule resource

get/rules/{id}

Path parameters

idstring required

Rule identifier

Response

Rule resource

descriptionstring nullable required

This description field is used to describe the rule and share knowledge with other users

enabledboolean required

Set to false to disable this rule

idstring required

lastUsedAtstring date-time nullable required

The date and time when this rule was last used to handle a request

metadataobject required

priorityinteger required

A rule with higher priority takes precedence over lower priorities, which means that the actions defined in the higher priority rule will override the similar actions defined in a lower priority one

tagsstring[] required

Tags are useful to filter rules and retrieve them easily

usageCountinteger required

The total number of times this rule has been used to handle a request

Example response

{
  "actions": [
    {
      "mode": "default"
    }
  ],
  "markers": [
    {
      "description": "My enum marker that only allow \"dog\" or \"cat\"",
      "name": "MyEnum",
      "transformers": [
        {
          "something": "foo",
          "with": "bar"
        }
      ]
    }
  ],
  "trigger": {
    "date": [
      {
        "operator": "equals"
      }
    ],
    "datetime": [
      {
        "operator": "after"
      }
    ],
    "ipAddress": {
      "ip": "1.2.3.4"
    },
    "methods": [
      "GET",
      "POST"
    ],
    "requestHeaders": [
      {
        "name": "Accept",
        "operator": "isNotEqualTo",
        "value": "application/json"
      }
    ],
    "responseStatusCodes": [
      500,
      503
    ],
    "sampling": 47,
    "source": "/old-url",
    "time": [
      {
        "operator": "after"
      }
    ]
  },
  "variables": [
    {
      "marker": "markerName",
      "name": "myVariable",
      "transformers": [
        {
          "something": "foo",
          "with": "bar"
        }
      ]
    }
  ]
}