provod.ai / docs
API

Delete an API key

Permanently revoke an inference key in the management workspace.

Last updated on

DELETE /v1/keys/{hash}

Permanently revoke an inference key. To pause a key temporarily, use PATCH with disabled: true.

Authentication

Authorization: Bearer <MANAGEMENT_API_KEY>: a management key bound to the workspace. The key owner must retain the live permission apiKeys.revoke.

The credential determines the workspace. X-Org-Id is unsupported.

Path parameters

FieldTypeDescription
hashstring · requiredSHA-256 digest from data.hash on creation or listing. Not the secret or internal key ID.

Response · 200

FieldTypeDescription
deletedbooleanTrue after successful revocation.

Response example

Identifiers and amounts in these examples are illustrative.

Request example

Load the key into a server environment variable. TypeScript uses Node.js fetch; Python uses only the standard library.

Replace the example hash with your key’s data.hash.

const response = await fetch("https://api.provod.ai/v1/keys/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", {
  method: "DELETE",
  headers: {
    Authorization: `Bearer ${process.env.MANAGEMENT_API_KEY}`,
  },
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
console.log(await response.json());

Errors

HTTPErrorCause
401UnauthorizedMissing, invalid, disabled, revoked or expired key. The X-Org-Id header is also rejected.
403ForbiddenWrong key kind or insufficient workspace access.
404Not FoundKey not found, revoked or outside the workspace.

Authentication error example:

{
  "error": {
    "code": "invalid_api_key",
    "message": "Invalid API key",
    "metadata": {}
  }
}

Operation error example:

{
  "message": "API key not found",
  "error": "Not Found",
  "statusCode": 404
}

Next steps

On this page