Revoke API Key

Beta

DELETE/v1/auth/api-keys/{id}

This endpoint is idempotent. Learn more

Revokes an API key.

Revocation takes effect immediately and cannot be undone; any request still presenting the key is rejected. The key record is kept, so it stays visible in the key list with a revoked status. To replace a key without an interruption in access, use Rotate API Key instead.

Role type requiredValues:admin

Only API keys or agents whose role has this type can call this endpoint.

idstring

API key ID.

Responses

200

Successful response for Revoke API Key

Revoke API Key

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const apiKey = await client.auth.apiKeys.delete('apke_eiylmwr6q7oz');

console.log(apiKey);

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const apiKey = await client.auth.apiKeys.delete('apke_eiylmwr6q7oz');

console.log(apiKey);

200 example

{}

{}

Revoke API Key

Authorization

Path Parameters

Responses