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 Licenses API

Issue, validate, and manage license keys.

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

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

This API exposes 9 operations across 6 paths, and defines 12 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}.

9 operations 6 paths 12 schemas 1 DELETE2 GET1 PATCH5 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 Licenses 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 9

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

Licenses 9

Issue, validate, and manage license keys.

POST
/licenses
Create a license
createLicense body → 201
GET
/licenses
List all licenses
listLicenses 3 params → 200
GET
/licenses/{id}
Retrieve a license
retrieveLicense 1 param → 200404
PATCH
/licenses/{id}
Update a license
updateLicense 1 param body → 200
DELETE
/licenses/{id}
Delete a license
deleteLicense 1 param → 204
POST
/licenses/{id}/actions/validate
Validate a license (by ID)
validateLicenseById 1 param body → 200
POST
/licenses/actions/validate-key
Validate a license (by key)
validateLicenseByKey body → 200
POST
/licenses/{id}/actions/check-out
Check-out a license
checkoutLicense 1 param → 200
POST
/licenses/{id}/actions/check-in
Check-in a license
checkinLicense 1 param → 200

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are PageLinks (5 properties), Error (4 properties), LicenseResource (4 properties), LicenseCollectionDocument (3 properties). Each schema is shown below with its type and property counts.

LicenseDocument
object
1 property
ErrorDocument
object
1 property 1 required
Error
object
4 properties
Relationship
object
2 properties
ResourceIdentifier
object
2 properties 2 required
LicenseResource
object
4 properties
PageLinks
object
5 properties
LicenseFileDocument
object
1 property
ValidationResultDocument
object
2 properties
ValidationScopeDocument
object
1 property
LicenseCollectionDocument
object
3 properties
ValidateKeyDocument
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

keygen-licenses-api-openapi.yml Raw ↑

Other APIs Keygen publishes across the network.

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