Error handling

👍

If you are using the Platform Management API v2, please read this Error Codes article.

Whenever the API is unable to process a call, it will return an error. This happens e.g. when required parameters are missing, when authentication fails or when parameters are out of bounds.

Error Messages

If an API call succeeds, it always returns data in the following structure:

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>ok</status>
  ...
</response>

If an API call fails, an error message is returned. Errors are always structured as follows:

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>error</status>
  <code>ParameterInvalid</code>
  <title>Invalid Parameter</title>
  <message>video_key: Video with the key aT2u4xRa does not exist</message>
</response>

The error message has the following parameters:

In addition to returning an error message, the API sets the HTTP Status Code of the call response to the error specific code, instead of the regular status 200 OK.

Error codes

Here is a full list of error codes that can be returned if an API call fails:

📘

NOTE:

Sending strings that contain colons (for example, in URLs) will cause SignatureInvalid errors. Please refer to API signature generation documentation.