How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Unkey liveness API

Health check operations

Unkey liveness 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 Liveness. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 3 JSON Schemas.

This API exposes 1 operation across 1 path, and defines 5 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.

1 operations 1 paths 5 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0.0
Base URL
https://api.unkey.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Unkey liveness API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (root key) (rootKey). By default, every request must be authenticated.

  • rootKey — Unkey uses API keys (root keys) for authentication. These keys authorize access to management operations in the API. To authenticate, include your root key in…

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

liveness 1

Health check operations

GET
/v2/liveness
Health Check
liveness → 200412500

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are BaseError (4 properties), V2LivenessResponseBody (2 properties), InternalServerErrorResponse (2 properties), V2LivenessResponseData (1 property). Each schema is shown below with its type and property counts.

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
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
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
V2LivenessResponseBody
object
2 properties 2 required
V2LivenessResponseData
object
Response data for the liveness check endpoint. This provides a simple indication of whether the Unkey API service is running and able to process requests. Moni…
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

unkey-liveness-api-openapi.yml Raw ↑

Other APIs Unkey publishes across the network.

Unkey analytics API
Unkey apis API
Unkey deploy API
Unkey identities API
Unkey keys API
Unkey permissions API
Unkey ratelimit API
Where this information came from

This is an independent, third-party profile of Unkey liveness API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.