@unkey/api/dist/commonjs/funcs/keysVerifyKey.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";
/**
 * Verify API key
 *
 * @remarks
 * Verify an API key's validity and permissions for request authentication.
 *
 * Use this endpoint on every incoming request to your protected resources. It checks key validity, permissions, rate limits, and usage quotas in a single call.
 *
 * **Important**: Returns HTTP 200 for all verification outcomes — check the `valid` field in response data to determine if the key is authorized. A 429 may be returned if the workspace exceeds its API rate limit.
 *
 * **Common use cases:**
 * - Authenticate API requests before processing
 * - Enforce permission-based access control
 * - Track usage and apply rate limits
 *
 * **Required Permissions**
 *
 * Your root key needs one of:
 * - `api.*.verify_key` (verify keys in any API)
 * - `api.<api_id>.verify_key` (verify keys in specific API)
 *
 * **Note**: If your root key has no verify permissions at all, you will receive a `403 Forbidden` error. If your root key has verify permissions for a different API than the key you're verifying, you will receive a `200` response with `code: NOT_FOUND` to avoid leaking key existence.
 *
 * If set, this operation will use {@link Security.rootKey} from the global security.
 */
export declare function keysVerifyKey(client: UnkeyCore, request: components.V2KeysVerifyKeyRequestBody, options?: RequestOptions): APIPromise<Result<components.V2KeysVerifyKeyResponseBody, errors.BadRequestErrorResponse | errors.UnauthorizedErrorResponse | errors.ForbiddenErrorResponse | errors.NotFoundErrorResponse | errors.TooManyRequestsErrorResponse | errors.InternalServerErrorResponse | UnkeyError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
//# sourceMappingURL=keysVerifyKey.d.ts.map