api

This method returns an array of all rules that are stored in the backend. This is useful if you want to get a full view of what rules you have currently in place.

get/rules

Request

  • The document declares no server URL.
  • Auth
    none declared

Query parameters

limitinteger

The maximum amount of rules returned.

offsetinteger

The offset from where to start looking.

Response

A list of rules

descriptionstring

Description is a human readable description of this rule.

idstring

ID is the unique id of the rule. It can be at most 190 characters long, but the layout of the ID is up to you. You will need this ID later on to update or delete the rule.

Changes

    • breaking

      the /// response's property type changed from object to no type for status

    • breaking

      the // response's property type changed from object to no type for status

    • breaking

      the /// response's property type changed from object to no type for status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status