API keys

Delete API key

Revoke an API key with the TypeScript SDK.

DEL/api-keys/{id}

Use blnk.ApiKeys.delete to revoke an API key by ID.

Call the method

const response = await blnk.ApiKeys.delete(
  'api_key_890bdbc4-467f-4670-8424-5667e41daf29',
  {
    owner: 'merchant_a',
  },
);
FieldTypeDescription
idstringID of the API key to revoke.
options.ownerstringOwner of the key. Required when authenticating with the master key.

Confirm the outcome

On success, Core returns 204 No Content and response.data is null. The key can no longer authenticate requests.

Response

{}

Returns 204 No Content on success with an empty body, so response.data is null.