@unkey/api/dist/esm/funcs/ratelimitGetOverride.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";
/**
 * Get ratelimit override
 *
 * @remarks
 * Retrieve the configuration of a specific rate limit override by its identifier.
 *
 * Use this to inspect override configurations, audit rate limiting policies, or debug rate limiting behavior.
 *
 * **Important:** The identifier must match exactly as specified when creating the override, including wildcard patterns.
 *
 * **Permissions:** Requires `ratelimit.*.read_override` or `ratelimit.<namespace_id>.read_override`
 *
 * If set, this operation will use {@link Security.rootKey} from the global security.
 */
export declare function ratelimitGetOverride(client: UnkeyCore, request: components.V2RatelimitGetOverrideRequestBody, options?: RequestOptions): APIPromise<Result<components.V2RatelimitGetOverrideResponseBody, errors.BadRequestErrorResponse | errors.UnauthorizedErrorResponse | errors.ForbiddenErrorResponse | errors.NotFoundErrorResponse | errors.TooManyRequestsErrorResponse | errors.InternalServerErrorResponse | UnkeyError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
//# sourceMappingURL=ratelimitGetOverride.d.ts.map