Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Keygen Releases API

Distributable, semver-tagged releases.

Keygen Releases API is one of 12 APIs that Keygen publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 6 operations across 3 paths, and defines 6 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against a single base URL, https://api.keygen.sh/v1/accounts/{account}.

6 operations 3 paths 6 schemas 1 DELETE3 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://api.keygen.sh/v1/accounts/{account}
Authentication
HTTP Bearer, HTTP Bearer, HTTP Basic
Terms of Service
Resource Areas
1

Authentication & Security 3

Keygen Releases API declares 3 security schemes for authenticating requests. It accepts HTTP bearer tokens (token) (bearerAuth). It accepts HTTP bearer tokens (license-key) (licenseKeyAuth). It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • bearerAuth — Admin, environment, product, user, or license bearer token in the Authorization: Bearer header.
  • licenseKeyAuth — A license key passed as Authorization: License for license validation and self-service actions.
  • basicAuth — HTTP Basic (email:password) used only to generate a user token.

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 3 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Releases 6

Distributable, semver-tagged releases.

POST
/releases
Create a release
createRelease body → 201
GET
/releases
List all releases
listReleases → 200
GET
/releases/{id}
Retrieve a release
retrieveRelease 1 param → 200
PATCH
/releases/{id}
Update a release
updateRelease 1 param → 200
DELETE
/releases/{id}
Delete a release
deleteRelease 1 param → 204
GET
/releases/{id}/actions/upgrade
Upgrade a release
upgradeRelease 1 param → 200204

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are PageLinks (5 properties), ReleaseResource (4 properties), ReleaseCollectionDocument (2 properties), ResourceIdentifier (2 properties). Each schema is shown below with its type and property counts.

ReleaseResource
object
4 properties
Relationship
object
2 properties
ResourceIdentifier
object
2 properties 2 required
PageLinks
object
5 properties
ReleaseCollectionDocument
object
2 properties
ReleaseDocument
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

keygen-releases-api-openapi.yml Raw ↑

Other APIs Keygen publishes across the network.

Keygen Artifacts API
Keygen Components API
Keygen Entitlements API
Keygen Licenses API
Keygen Machines API
Keygen Policies API
Keygen Processes API
Keygen Products API
Keygen Tokens API
Keygen Users API
Keygen Webhooks API