Troubleshooting API⚓︎

API call errors return a response including the error status and additional details.

Error Code Samples⚓︎

Error Code 403 AccessDenied

In this example the API token did not allow access to existing endpoints.

{
 "status": 403,
 "error": "AccessDenied",
 "message": "The Security Framework denied access for this request. You are probably not allowed to access this resource.",
 "path": "/v1/account-roles",
 "timestamp": 1625896060372,
 "incident": "3245A2AC"
}

Error Code 404 Not Found

In this example, the endpoint path specified in the request does not exist.

{
 "status": 404,
 "error": "Not found",
 "message": "Not found",
 "path": "/v1/accounts/subs",
 "details": [],
 "timestamp": 1625785873772,
 "incident": "10F7E18D"
}

Error Code 406 Invalid Input

{
  "status": 406,
  "error": "Invalid input",
  "message": "The parameter 'subscriber' with value '3576730602192802' was not found",
  "path": "/v1/session-usage/search/findBySubscriber",
  "timestamp": 1625683231340,
  "incident": "1ECC1944"
}

Error Code 500 UNKNOWN

{
 "status": 500,
 "error": "Mapping",
 "message": "Sorry, an unexpected error occurred. Please report the details given here to Support for debug and analysis.",
 "path": "/v1/session-usage/search/findBySubscriber",
 "timestamp": 1625680929976,
 "incident": "65F1DA6A"
}

Error Codes⚓︎

Code	Status	Description
200	OK	The request was successfully completed.
201	Created	A new resource was successfully created.
400	Bad Request	The request was invalid.
401	Unauthorized	The request did not include an authentication token or the
403	Forbidden	The client did not have permission to access the requested resource.
404	Not Found	The requested resource was not found.
405	Method Not Allowed	The HTTP method in the request was not supported by the resource. For example, the DELETE method cannot be used with the Agent API.
406	Invalid Input	The value provided for the parameter is formatted incorrectly or cannot be found.
409	Conflict	The request could not be completed due to a conflict. For example, POST ContentStore Folder API cannot complete if the given file or folder name already exists in the parent location.
500	Internal Server Error	The request was not completed due to an internal error on the server side.
503	Service Unavailable	The server was unavailable.