Start using the Back-End REST APIs

Before integrating our back-end REST APIs, read through the following information to help you get started:


Authentication for all of our back-end REST APIs occurs via HTTP Basic Authentication (Basic Auth). The authentication string should be “username:password”. For example, if your username is “johndoe” and your password is “password1234”, your authentication string would be “johndoe:password1234”. And in this case your base64-encoded credentials will be “am9obmRvZTpwYXNzd29yZDEyMzQ=”, as shown in the following example:

curl --request POST \
  --url '' \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --header 'authorization: Basic am9obmRvZTpwYXNzd29yZDEyMzQ=' \
  --data '{
    "TargetUrl": "


To use your username and password to authenticate, your Cleverbridge user must have the following privilege - API User. For more information about user account privileges, see Users ✱.

Header Values

The most relevant REST request header values for our back-end REST APIs are the following:

Field Name Description Example
Accept Format of the function call response that is desired. application/json or application/xml Setting a value is required.
Content-Type Format of the request content. application/json or application/xml Required for POST but not for GET.

In the following example, the requested resource is a json object:

curl --request POST \
  --url '' \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --header 'authorization: Basic xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
  --data '{
    "TargetUrl": "

Status Codes

The following describes the status codes that result from successful and unsuccessful calls to our REST APIs.

Testing Your Connection

To test your connectivity with our back-end REST APIs, use the Test Connection resource:

curl --request GET \
  --url \
  --header 'accept: application/json'

This resource validates that:

  • You can connect with
  • Your API user credentials (authentication) are valid.

Rate Limits

To guarantee a stable and reliable performance of our platform, Cleverbridge places limits on the amount of data that can be consumed. API users are limited to a maximum of 150 requests per second from an IP address or range. All API requests count towards the rate limit.

Developer Guides

In the following guides, you can find additional information about each of the back-end REST APIs, including descriptions of how to implement particular use cases:

Reference Documentation

In the following reference documentation, you can find request and response examples, an API explorer, and parameter definitions for each of the back-end REST APIs: