Views:

When troubleshooting errors, you can refer to the HTTP status code, error code, and error message in the API response body.

The following table provides information about the common error types.

 

Authentication Errors

Authorization Errors

Request Not Found Errors

Problem

These errors occur when an authentication token is invalid.

These errors occur when an authentication token is not permitted to perform an action or access a resource.

These errors occur when a request is made to perform an action on a specific resource and the resource is not found.

Cause

The authentication token in the API request is typed incorrectly.

The role that is assigned to the API key does not have access rights for the resource, the operation, or both.

The resource has been deleted.

HTTP status code

401 Unauthorized

403 Forbidden

404 Not Found

Response header

  • Key: Content-Type

  • Value: application/json

  • Key: Content-Type

  • Value: application/json

  • Key: Content-Type

  • Value: text/plain

Response body example

{
  "code": 4010000,
  "msg": "[svp] unauthorized",
  "data": {
    "reason": "invalid_token",
    "detail": "invalid signature"
  }
}
{
  "code": 1,
  "message": "Permission denied for the role"
}
Not Found