UNPKG

@unkey/api

Version:

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

29 lines 1.94 kB
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"; /** * Create API namespace * * @remarks * Create an API namespace for organizing keys by environment, service, or product. * * Use this to separate production from development keys, isolate different services, or manage multiple products. Each API gets a unique identifier and dedicated infrastructure for secure key operations. * * **Important**: API names must be unique within your workspace and cannot be changed after creation. * * **Required Permissions** * * Your root key must have one of the following permissions: * - `api.*.create_api` (to create APIs in any workspace) * * If set, this operation will use {@link Security.rootKey} from the global security. */ export declare function apisCreateApi(client: UnkeyCore, request: components.V2ApisCreateApiRequestBody, options?: RequestOptions): APIPromise<Result<components.V2ApisCreateApiResponseBody, errors.BadRequestErrorResponse | errors.UnauthorizedErrorResponse | errors.ForbiddenErrorResponse | errors.TooManyRequestsErrorResponse | errors.InternalServerErrorResponse | UnkeyError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>; //# sourceMappingURL=apisCreateApi.d.ts.map