🎫 Support

We provide support, including technical issues, billing, and key management concerns through our Service Tickets system. In the Client Console, under the Support section users can create service tickets and track the status of the ticket through FreshDesk. Users will need to set up a new FreshDesk account or link an existing account to create and manage tickets.

⚠️ Error Codes

Learn more about common error codes of Interplai API and how to resolve them.

Interplai uses standard HTTP response status codes to indicate the success or failures of API requests. If the request fails, an error is returned using the appropriate status code.

There are three status code ranges you can expect:

✅ 2XX success status codes confirm that your request worked as expected.
❌ 4XX error response codes depict issues that could be handled programmatically.
✖️ 5XX error response codes indicate errors with Interplai’s Server.

Success Status Code

✅ 200 OK

The HTTP 200 OK success status response code indicates that the request was successful. A 200 response is cacheable by default.

The meaning of success depends on the HTTP request method:

Method	Description
GET	The resource has been fetched and is transmitted in the message body.
HEAD	The representation headers are included in the response without any message body.
POST	The resource describing the result of the action is transmitted in the message body.
PATCH	The message body contains the request message as received by the server.

✅ 201 Created

The HTTP 201 Created success status response code indicates that the request was successful and has led to the creation of an element.

✅ 207 Multi-Status

The HTTP 207 Multi-Status status code provides status for multiple independent processes and it indicates that multiple operations have taken place and that the status for each operation can be viewed in the body of the response.

Handling Errors

Error codes are returned using standard HTTP error code syntax. Depending on the response code, the response body may be in JSON or plaintext.

❌ 400 Bad Request

Description
The HTTP 400 Bad Request response status code indicates that the server cannot process the request due to a client error.

Example
Malformed request syntax or invalid request message framing.

Causes

Bad URL syntax – incorrectly typed URLs.
Lack of required fields and unmatched datatype.
Invalid cookies – cookies containing the authentication data are no longer valid.

Fixes

Recheck the URL
A malformed URL is the most common cause of the 400 Bad request error. Make sure that there are no typing errors or syntax errors in the URL.
Lack of required fields and unmatched datatypes.
Please check the body of the request if the required are missing and if the fields are having the defined datatype. Kindly go through the API Specification Documentation.
Clear browser cookies
Consider clearing your browser cookies and cache to avoid running into a 400 Bad request error.

❌ 401 Unauthorized

Description
The HTTP 401 Unauthorized response status code indicates that the client request has not been completed because it lacks valid authentication credentials for the Interplai API service.

Example
Invalid API key.

Causes

Invalid API key.
Plugin incompatibility – when firewall or security plugin has malicious activity.
Outdated browser cookies or cache.

Fixes

Check your API key.
Check whether the entered API key is valid or not.
Generate a new API key.
Generate a new API key with the help of the Client Console and re-create a previous zone.

❌ 404 Not Found

Description
The HTTP 404 Not Found response status code indicates that the Interplai server cannot find the requested resource.

Example
The requested zone is not found.

Causes

The requested content is either deleted or moved.
The requested endpoint is not available, or the connection is broken.
The entered domain name does not exist.

Fixes

Check the URL
Regardless of whether the URL was entered manually or directed via a link, there could be a mistake that has been made. For this reason, check the specified path of the website to make sure nothing has been mistyped. Apart from spelling mistakes, it could also be that forward slashes have been left out or misplaced or that backward slashes have been used instead of forwarding slashes.
Check the body of the request
Make sure the requested resources are available.

❌ 422 Unprocessable Entity

The HTTP 422 Unprocessable Entity status code indicates the request was well-formed but was unable to be followed due to semantic errors.

✖️ 500 Internal Server Error

Description
The HTTP 500 Internal Server Error response code indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

Causes
The server encountered an internal error or misconfiguration and was unable to complete your request. Please contact Interplai and inform them of the time the error occurred and any relevant information.

Fixes
Please feel free to submit a ticket through FreshDesk to contact the Interplai Team