@unkey/api/dist/esm/funcs/apisDeleteApi.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 namespace
 *
 * @remarks
 * Permanently delete an API namespace and immediately invalidate all associated keys.
 *
 * Use this for cleaning up development environments, retiring deprecated services, or removing unused resources.
 * All keys in the namespace are immediately marked as deleted and will fail verification with `code=NOT_FOUND`.
 *
 * **Important**: This operation is immediate and permanent. Verify you have the correct API ID before deletion.
 * If delete protection is enabled, disable it first through the dashboard or API configuration.
 *
 * **Required Permissions**
 *
 * Your root key must have one of the following permissions:
 * - `api.*.delete_api` (to delete any API)
 * - `api.<api_id>.delete_api` (to delete a specific API)
 *
 * If set, this operation will use {@link Security.rootKey} from the global security.
 */
export declare function apisDeleteApi(client: UnkeyCore, request: components.V2ApisDeleteApiRequestBody, options?: RequestOptions): APIPromise<Result<components.V2ApisDeleteApiResponseBody, errors.BadRequestErrorResponse | errors.UnauthorizedErrorResponse | errors.ForbiddenErrorResponse | errors.NotFoundErrorResponse | errors.PreconditionFailedErrorResponse | errors.TooManyRequestsErrorResponse | errors.InternalServerErrorResponse | UnkeyError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
//# sourceMappingURL=apisDeleteApi.d.ts.map