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

Unleash Operational API

Endpoints related to the operational status of this Unleash instance.

Unleash Operational API is one of 36 APIs that Unleash publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Operational. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 4 operations across 4 paths, and defines 5 schemas. It is described by OpenAPI 3.0.3, at version 7.4.1.

Requests are made against a single base URL, https://app.unleash-instance.example.com.

4 operations 4 paths 5 schemas 4 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
7.4.1
Base URL
https://app.unleash-instance.example.com
Authentication
API Key, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Unleash Operational API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (apiKey). It accepts HTTP bearer tokens (bearerToken). By default, every request must be authenticated.

  • apiKey — API key needed to access this API
  • bearerToken — API key needed to access this API, in Bearer token format

Paths & Operations 4

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

Operational 4

Endpoints related to the operational status of this Unleash instance.

GET
/api/admin/invoices
Enterprise feature undefined
getInvoices → 200
GET
/api/admin/invoices/list
Enterprise feature undefined
getDetailedInvoices → 200
GET
/ready
Get Instance Readiness Status
getReady → 200503
GET
/health
Get Instance Operational Status
getHealth → 200500

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are detailedInvoicesLineSchema (10 properties), detailedInvoicesSchema (3 properties), readyCheckSchema (1 property), healthCheckSchema (1 property). Each schema is shown below with its type and property counts.

healthCheckSchema
object
Used by service orchestrators to decide whether this Unleash instance should be marked as healthy or unhealthy
1 property 1 required
invoicesSchema
array
A list of invoices
readyCheckSchema
object
Used by service orchestrators to decide whether this Unleash instance should be considered ready to serve requests.
1 property 1 required
detailedInvoicesSchema
object
Detailed invoices response with nested line items
3 properties 1 required
detailedInvoicesLineSchema
object
10 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

unleash-operational-api-openapi.yml Raw ↑

Other APIs Unleash publishes across the network.

Unleash Client API
Unleash Addons API
Unleash Admin UI API
Unleash API tokens API
Unleash Archive API
Unleash Auth API
Unleash Banners API
Unleash Change Requests API
Unleash Context API
Unleash Dependencies API
Unleash Environments API
Unleash Events API
Where this information came from

This is an independent, third-party profile of Unleash Operational 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.