DELETEhttps://api.rankparse.com/v1/keys/:idFreeAPI key

Revokes a key in the workspace. Requests with that key fail with 401 invalid_api_key from then on. Owners and admins can revoke any key in the workspace; members can revoke only keys they created.

Path parameters

idstringrequired

The key id from List API keys or Create an API key. Not the raw key.

Response

successboolean

Always true.

You can revoke the key you are calling with. Every request after that returns 401. Create the replacement key first, deploy it, then revoke the old one.

Behavior

A notification email goes to the account email of the person revoking the key.

Errors

HTTP	Code	When
401	`invalid_api_key`	Missing, invalid or revoked API key.
403	`capability_missing`	Client roles may not manage keys.
404	`key_not_found`	The id does not exist in this workspace, is already revoked, or (for members) belongs to someone else's key.

List API keys

Find the id to revoke.

Create an API key

Create the replacement first.

curl -X DELETE "https://api.rankparse.com/v1/keys/9f2c1e5a7b3d4e8f0a1b2c3d4e5f60718293a4b5c6d7e8f90a1b2c3d4e5fc4d8" \
  -H "X-API-Key: rp_your_key"

Response

{ "success": true }

404 key_not_found

{
  "error": "Not Found",
  "code": "key_not_found",
  "message": "API key not found or already revoked"
}

Revoke an API key

Path parametersCopy Anchor Link

ResponseCopy Anchor Link

BehaviorCopy Anchor Link

ErrorsCopy Anchor Link

RelatedCopy Anchor Link

List API keys

Create an API key

Path parameters

Response

Behavior

Errors

Related