Skip to content

API key expired

HTTP 401api_key_expired

When the API answers 401 api_key_expired, and how to fix it.

Version v1.1, updated

The type field of every api_key_expired response links to this page.

On this page

The key had an expiry date, and that date has passed. An expired key never works again.

At a glance

  • Status: 401 Unauthorized

  • Code: api_key_expired

  • Retry: No. Fix the cause first: the same request gets the same answer.

Causes and fixes

Likely cause

How to fix it

The key reached the expiry date chosen when it was created.

Create a new key and switch the system to it.

The switch to the next key did not happen in time.

Create the next key before the current one expires, and plan the date where your team plans its work.

Example

401 api_key_expiredJSON
{
  "code": "api_key_expired",
  "detail": "The API key has expired. Create a new key in BIRP settings.",
  "instance": "/v1/categories",
  "request_id": "a1b2c3d4-0000-4000-8000-0000000000ee",
  "status": 401,
  "title": "API key expired",
  "type": "https://birp.io/developers/errors/api_key_expired"
}

Related

  • first-key
  • keep-your-key-safe
  • api-key-revoked