Common Error Codes

Common Error Codes

In this guide is a description of the most-common error codes and indications for remediation.

ACCESS_DENIED (403)
Caused by not providing an authorization token; not providing an authorization header to firefly; an invalid API key; an improperly set-up data provider service using CloudAuth, or if no token exists.

INTERNAL (500)
This is a default catch-all when the error doesn’t fit in any specified category. The details should be in the error itself. If not, view the FireFly logs.

THROTTLED (429)
All API keys have an associated rate limit. If your client’s rate limit is exceeded, this error is thrown. If you are testing, try making fewer requests. if this error is in production, contact the FireFly team using this ticket template and we will raise your rate limit.

SERVICE_TIMEOUT (408)
FireFly has reserved 3 seconds to call the upstream data provider service on a per-api level. If the service provides response that takes longer than 3 seconds, FireFly will abandon the call and return this error. Retry or investigate if the issue is with the data provider service.

AUTH_INVALID_CLIENT_ID (401)
AUTH_INVALID_CUSTOMER_ID (401)
AUTH_INVALID_DEVICE_ID (401)
These three codes have the same root cause: how the authorization token was generated. You may have specified an incorrect token or an incorrect API key. See Client Onboarding, make sure it’s formatted correctly and regenerate the token. Tokens are valid for 1 hour maximum.

To see other error codes not mentioned here, check out this file: https://gitlab.aws.dev/amazonmusic/musicfirefly/amu_webapi/-/blob/main/src/models/FFError.ts

To see all possible status codes, check out this file: https://gitlab.aws.dev/amazonmusic/musicfirefly/amu_webapi/-/blob/main/src/models/StatusCodes.ts