This is the reference for the Automation REST API. This API is the primary way to get and modify data in Automation across products. Use it to interact with Automation entities, like rules.

Authentication: Authentication requires an API token or browser session cookies.

Authorization: Authorization is based on the user making the request and the product-level permissions they have that relate to the entities they are interacting with.

See Authentication or Authorization for more details.

The Automation REST API uses the standard HTTP status codes.

Responses that return an error status code (400 or 5xx) will include a standard error response body, similar to the following:

1
2
{
  "errors": [
      {
          "id": "298f9da7-93e0-40d7-8a2d-e8e158996abc",
          "status": 400,
          "code": "some.error.code",
          "title": "Some error message",
          "field": "some[1].field"
      }
  ]
}

The Automation REST API uses cursor-based pagination: a method that returns a response with multiple objects can only return a limited number at one time. This limits the size of responses and conserves server resources.

Use the 'limit' parameter to specify the desired number of results per page.

If more results are available after the initial page a links section will include an opaque cursor that can be used request the next page of results.

Cursors are opaque and not intended to be constructed by an API consumer. Consumers must treat them as opaque strings. The format of a cursor may change at any time and is not part of our API contract.

Cursors have a TTL after which they will not be valid for use. For most APIs this is 1 hour.

The Automation REST API path-based versioning.

The API version is included in the request path e.g. /rest/v1/rule/manual/search.

A special version latest is an alias to the most recent version of a particular operation e.g. /rest/latest/rule/manual/search.