Send Requests

Every REST call to this API must be sent to a backend. Use the following guidelines when sending requests:

URL Structure

Access the API using the following URL structure:

https://<base-URL-for-backend>/<resource-path>

You can find a backend's base URL on its Settings page in the UI.

<resource-path> is the relative path that defines the resource. For a complete list of resources, see All Rest Endpoints.

Media Types

Unless specified otherwise by the operation, this API supports application/json.

Supported Headers

See Common Request Headers. For additional headers that are specific to that operation, see the REST API documentation for that operation.