API Responses During Maintenance

During maintenance intervals, the REST API is unable to satisfy the original request and instead returns a message stating that the site is undergoing maintenance. The best practice is to add the necessary logic to your application to detect this condition and wait for 5 minutes before reissuing the same request.

Example Response

  <?xml version="1.0" encoding="UTF-8"?>
  <rsp status="failed">
    <msg>The API is currently down for maintenance.</msg>
  </rsp>