Skip to main content

Troubleshooting the API

Common errors and how to fix them.

400 Errors

400 bad request

The server would not process the request due to something the server considered to be a client error.

Causes


The JSON body to see if there are any typos or errors in this section.

Error example can be:

  • Missing brackets, spelling errors.

  • Missing information, that is a mandatory section.

  • The URL could contain some errors like typos or incorrect characters.

  • Headers are too large or incorrectly structured.

What to check

  • Check URL for typos

  • Check JSON syntax for missing brackets, spelling errors or missing information

  • Confirm the required fields are included.

401 Unauthorized access

401 Client error response status code, request is not successful because it lacks valid authentication credentials.

Causes

The credentials can either be missing, invalid or expired.

What to check:

  • Check the login credentials to see if these are correct

  • Confirm the token hasn’t expired (Auth02) or the API key hasn’t changed.

  • Confirm using the correct authentication type (Bearer, Basic or API Key)

403 Forbidden do not have permissions to access the requested page or resource

Server has understood the request but refuses to allow you access.

Causes

This can be caused by an authentication error.

What to check:

  • Check the login credentials to see if these are correct.

  • Try logging back out and logging back in

  • Clear cache/cookies

  • Check URL isn’t invalid

  • A user with admin permissions has created the credentials.


To log in you will need:

X-SUB-DOMAIN: subdomainname

Authentication Token:
For the authentication token you will need alongside the subdomain:
X-AUTH-TOKEN: authenticationtoken

To get authenticator token go to:
System Setup > API > Enable API toggle YES

This will generate an API Key to use for X-AUTH-TOKEN.

To create a new API key select "Issue a new API key".

For OAuth2 Applications:
System Setup > API > Custom OAuth2 Applications > Add Application

This will generate a Client ID and a Client Secret once the application has been created.

For more information about OAuth2 login is available in the API documentation:
https://api.current-rms.com/doc


404 Not Found

The web page resource you are trying to access does not exist. Common cause is the URL is incorrect.


What to check:
Check the URL link that you are using with your requests. When using the API you will need to point the URL to the API instead of your subdomain.

URL is:
https://api.current-rms.com/api/v1/

For more information about the endpoints check the API documentation.
https://api.current-rms.com/doc

413 Request Entity Too Large Query

If you are getting a 413 this means the character limit has been exceeded.

For more information on API limits check out the document below:

System Limitations

What to check:

  • Consider breaking down the query into smaller queries.

  • Reduce the file size.

500 Errors

503 Service Unavailable


The server is currently unable to handle the incoming request. Server is too busy or temporarily down for maintenance.


504 Gateway Timeout

The server acting as a gateway or proxy didn’t receive a response in time to complete the request


Causes:

Common causes for this is the backend server is down, overloaded or slow.

Checks to perform:

  • Check if the site is experiencing an outage or slowness.

  • Check internet connection

  • Clear cache and cookies

  • Try again later

  • Avoid repeating the heavy action immediately.

Did this answer your question?