Unkey keys API is one of 8 APIs that Unkey publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 3 JSON Schema definitions.
Tagged areas include Keys. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 3 JSON Schemas.
This API exposes
15 operations
across 15 paths,
and defines 66 schemas.
It is described by OpenAPI 3.1.0, at version 2.0.0.
Requests are made against a single base URL, https://api.unkey.com.
The identity and technical contract details declared by the specification.
V2KeysVerifyKeyResponseData
object
12 properties
2 required
V2KeysSetPermissionsResponseData
array
Complete list of all permissions now directly assigned to the key after the set operation has completed. The response includes: - The comprehensive, updated se…
V2KeysRemovePermissionsResponseData
array
Complete list of all permissions directly assigned to the key after the removal operation (remaining permissions only). Notes: - This list does NOT include per…
UpdateKeyCreditsRefill
objectnull
Configuration for automatic credit refill behavior.
3 properties
2 required
ValidationError
object
Individual validation error details. Each validation error provides precise information about what failed, where it failed, and how to fix it, enabling efficie…
3 properties
2 required
KeyCreditsData
object
Credit configuration and remaining balance for this key.
2 properties
1 required
Meta
object
Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. Th…
1 property
1 required
V2KeysMigrateKeyData
object
10 properties
1 required
BadRequestErrorDetails
Extended error details specifically for bad request (400) errors. This builds on the BaseError structure by adding an array of individual validation errors, ma…
V2KeysMigrateKeysMigration
object
2 properties
2 required
EmptyResponse
object
Empty response object by design. A successful response indicates this operation was successfully executed.
V2KeysUpdateKeyResponseBody
object
2 properties
2 required
V2KeysRemovePermissionsRequestBody
object
2 properties
2 required
UnauthorizedErrorResponse
object
Error response when authentication has failed or credentials are missing. This occurs when: - No authentication token is provided in the request - The provided…
2 properties
2 required
NotFoundErrorResponse
object
Error response when the requested resource cannot be found. This occurs when: - The specified resource ID doesn't exist in your workspace - The resource has be…
2 properties
2 required
V2KeysVerifyKeyResponseBody
object
2 properties
2 required
V2KeysGetKeyResponseBody
object
2 properties
2 required
V2KeysMigrateKeysResponseData
object
2 properties
2 required
V2KeysSetRolesResponseData
array
Complete list of all roles now directly assigned to the key after the set operation has completed. The response includes: - The comprehensive, updated set of r…
KeyResponseData
object
15 properties
4 required
VerifyKeyRatelimitData
object
8 properties
8 required
V2KeysRerollKeyRequestBody
object
2 properties
2 required
V2KeysRemoveRolesResponseBody
object
2 properties
2 required
V2KeysDeleteKeyResponseBody
object
2 properties
2 required
Identity
object
4 properties
2 required
V2KeysAddPermissionsResponseData
array
Complete list of all permissions directly assigned to the key (including both newly added permissions and those that were already assigned). This response incl…
TooManyRequestsErrorResponse
object
Error response when the client has sent too many requests in a given time period. This occurs when you've exceeded a rate limit or quota for the resource you'r…
2 properties
2 required
V2KeysWhoamiResponseBody
object
2 properties
2 required
V2KeysMigrateKeysResponseBody
object
2 properties
2 required
V2KeysCreateKeyResponseData
object
2 properties
2 required
V2KeysDeleteKeyRequestBody
object
2 properties
1 required
V2KeysCreateKeyRequestBody
object
13 properties
1 required
V2KeysSetRolesResponseBody
object
2 properties
2 required
V2KeysRerollKeyResponseBody
object
2 properties
2 required
V2KeysSetPermissionsRequestBody
object
2 properties
2 required
V2KeysRemoveRolesResponseData
array
Complete list of all roles directly assigned to the key after the removal operation completes. The response includes: - The remaining roles still assigned to t…
RatelimitRequest
object
4 properties
4 required
V2KeysAddPermissionsResponseBody
object
2 properties
2 required
BadRequestErrorResponse
object
Error response for invalid requests that cannot be processed due to client-side errors. This typically occurs when request parameters are missing, malformed, o…
2 properties
2 required
Permission
object
4 properties
3 required
Role
object
4 properties
2 required
V2KeysCreateKeyResponseBody
object
2 properties
2 required
ForbiddenErrorResponse
object
Error response when the provided credentials are valid but lack sufficient permissions for the requested operation. This occurs when: - The root key doesn't ha…
2 properties
2 required
V2KeysMigrateKeysRequestBody
object
3 properties
3 required
V2KeysRerollKeyResponseData
object
2 properties
2 required
UpdateKeyCreditsData
objectnull
Credit configuration and remaining balance for this key.
2 properties
V2KeysSetRolesRequestBody
object
2 properties
2 required
V2KeysRemovePermissionsResponseBody
object
2 properties
2 required
V2KeysWhoamiRequestBody
object
1 property
1 required
KeysVerifyKeyRatelimit
object
4 properties
1 required
V2KeysUpdateCreditsResponseBody
object
2 properties
2 required
KeyCreditsRefill
object
Configuration for automatic credit refill behavior.
3 properties
2 required
V2KeysVerifyKeyRequestBody
object
6 properties
1 required
V2KeysAddRolesRequestBody
object
2 properties
2 required
V2KeysAddRolesResponseBody
object
2 properties
2 required
V2KeysAddRolesResponseData
array
Complete list of all roles directly assigned to the key after the operation completes. The response includes: - All roles now assigned to the key (both pre-exi…
InternalServerErrorResponse
object
Error response when an unexpected error occurs on the server. This indicates a problem with Unkey's systems rather than your request. When you encounter this e…
2 properties
2 required
KeysVerifyKeyCredits
object
Controls credit consumption for usage-based billing and quota enforcement. Omitting this field uses the default cost of 1 credit per verification. Credits prov…
1 property
1 required
V2KeysRemoveRolesRequestBody
object
2 properties
2 required
RatelimitResponse
object
5 properties
5 required
V2KeysUpdateCreditsRequestBody
object
3 properties
2 required
BaseError
object
Base error structure following Problem Details for HTTP APIs (RFC 7807). This provides a standardized way to carry machine-readable details of errors in HTTP r…
4 properties
4 required
V2KeysGetKeyRequestBody
object
2 properties
1 required
V2KeysUpdateKeyRequestBody
object
10 properties
1 required
V2KeysSetPermissionsResponseBody
object
2 properties
2 required
V2KeysAddPermissionsRequestBody
object
2 properties
2 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Unkey publishes across the network.
