@unkey/api/dist/esm/funcs/keysDeleteKey.d.ts

Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@unkey/api* API.

import { UnkeyCore } from "../core.js";
import { RequestOptions } from "../lib/sdks.js";
import * as components from "../models/components/index.js";
import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../models/errors/httpclienterrors.js";
import * as errors from "../models/errors/index.js";
import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
import { UnkeyError } from "../models/errors/unkeyerror.js";
import { APIPromise } from "../types/async.js";
import { Result } from "../types/fp.js";
/**
 * Delete API keys
 *
 * @remarks
 * Delete API keys permanently from user accounts or for cleanup purposes.
 *
 * Use this for user-requested key deletion, account deletion workflows, or cleaning up unused keys. Keys are immediately invalidated. Two modes: soft delete (default, preserves audit records) and permanent delete.
 *
 * **Important**: For temporary access control, use `updateKey` with `enabled: false` instead of deletion.
 *
 * **Required Permissions**
 *
 * Your root key must have one of the following permissions:
 * - `api.*.delete_key` (to delete keys in any API)
 * - `api.<api_id>.delete_key` (to delete keys in a specific API)
 *
 * If set, this operation will use {@link Security.rootKey} from the global security.
 */
export declare function keysDeleteKey(client: UnkeyCore, request: components.V2KeysDeleteKeyRequestBody, options?: RequestOptions): APIPromise<Result<components.V2KeysDeleteKeyResponseBody, errors.BadRequestErrorResponse | errors.UnauthorizedErrorResponse | errors.ForbiddenErrorResponse | errors.NotFoundErrorResponse | errors.TooManyRequestsErrorResponse | errors.InternalServerErrorResponse | UnkeyError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
//# sourceMappingURL=keysDeleteKey.d.ts.map