Morpheus API Gateway LogoMorpheus API Gateway
Auth

Delete Api Key

Deactivate an API key. Requires JWT Bearer authentication with the token received from the login endpoint.

DELETE
/api/v1/auth/keys/{key_id}

Authorization

AuthorizationRequiredBearer <token>

Enter the JWT token you received from the login endpoint (without 'Bearer' prefix)

In: header

Path Parameters

key_idRequiredKey Id

Response Body

Schema for API key in database response.

TypeScript Definitions

Use the response body type in TypeScript.

idRequiredId
key_prefixRequiredKey Prefix
namestring | null | null
created_atRequiredCreated At
Format: "date-time"
is_activeRequiredIs Active
curl -X DELETE "http://api.mor.org/api/v1/auth/keys/0" \
  -H "Authorization: Bearer <token>"
{
  "id": 0,
  "key_prefix": "string",
  "name": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "is_active": true
}

How is this guide?