You are here

You are here

REST API Rate Limits

The SpringCM REST API has rate limits that are currently set high enough that they should not be reached under normal usage of the API.  In the case that a rate limit is exceeded, a 429 response code will be sent back along with some additional information.  There are two different ways to exceed an API rate limiter: too many requests for a SpringCM account within a given time period of time and too many concurrent requests for a single user.  Sample JSON responses for each type of limit are shown below.

Exceed the concurrent number of request for a given user

{
   "Error":
   {
      "HttpStatusCode":429,
      "UserMessage":"You may only have XX concurrent requests open.",
      "DeveloperMessage":"User request forbidden due to XX concurrently open requests.",
      "ErrorCode":103,
      "ReferenceId":"7b45dd15-9dff-4d8a-a08d-4fe5df8e950a"
   }
}

Exceed the number of requests for an account in a given time period

{
   "Error":
   {
      "HttpStatusCode":429,
      "UserMessage":"Rate limit exceeded.",
      "DeveloperMessage":"Rate limit exceeded.",
      "ErrorCode":103,
      "ReferenceId":"5594dbc0-5e55-48a9-b31e-9721d441a1aa"
   }
}

When the number of requests for an account is exceeded the customer header X-RateLimit-Reset will be returned that will hold the date/time of when requests for the account can resume.