Troubleshooting the Connector Appliance APIs

This article includes some of the common error codes that you might get when using the Connector Appliance API and suggestions of how to resolve the error.

401 Unauthorized

You see this error when there are issues with the authorization token used in your requests.

Error detail Resolution
“Missing authentication details” Ensure that your request includes the header Authorization: Bearer <token>. To get a valid token, log in with your user name and password. For more information, see Getting started.
“Invalid authentication details” Ensure that your authorization token is valid and that it has not expired. Authorization tokens expire 15 minutes after they are requested. After this time, you must get a new token to continue using the API. For more information, see Getting started.

Example

HTTP/1.1 401 Unauthorized
...
Content-Type: application/json; charset=utf-8
...

{
    "type": "https://errors-api.cloud.com/common/authentication",
    "detail": "Invalid authentication details",
    "parameters": [
        {
            "name": "reason",
            "value": "invalid"
        }
    ]
}
<!--NeedCopy-->

404 Not Found

You see this error when the content of your request is missing required parameters or those parameters are invalid.

Error detail Resolution
“Field <field-name> is missing.” Ensure that the field <field-name> is included in your request.
“Field <field-name> has an invalid value.” Ensure that the value of <field-name> is of the correct type and in the required format.

Example

HTTP/1.1 404 Not Found
...
Content-Type: application/json; charset=utf-8
...

{
    "type": "https://errors-api.cloud.com/common/missing",
    "detail": "Field \"key\" is missing.",
    "parameters": [
        {
            "name": "property",
            "value": "key"
        }
    ]
}
<!--NeedCopy-->
Resources
Connector Appliance APIs OpenAPI Specification
Copy Download
Troubleshooting the Connector Appliance APIs