License API

ENTERPRISE

Using the License API to manage your DC/OS license

Routes

Access to the License API is proxied through the Admin Router on each master node using the following route:

/licensing/v1
Copy

To determine the URL of your cluster, see Cluster Access.

Format

The License API request and response bodies are formatted in JSON.

Requests must include the accept header:

Accept: application/json
Copy

Responses include the content type header:

Content-Type: application/json
Copy

or

Content-Type: application/x-tar
Copy

Authentication

All License API routes require authentication to use.

To authenticate API requests, see Obtaining an authentication token and Passing an authentication token.

The License API also requires authorization via the following permissions:

Resource ID Action
dcos:adminrouter:licensing full

All routes can also be reached by users with the dcos:superuser permission.

To assign permissions to your account, see the permissions reference.

API reference

The License API allows you to manage license operations on your DC/OS cluster.

DC/OS Licensing Component
 1.0.0 

[ Base URL: /licensing/v1 ]
/mesosphere/dcos/2.0/api/dcos-licensing-component-spec.yaml

default

GET/ping
Return 'pong' if service is up.
GET/version
Return service version.
GET/licenses
Read all licenses.
POST/licenses
Post a new license.
GET/licenses/{id}
Read a license document by id.
GET/licenses/active
Read the active license document.
GET/status
Returns summary of licensing state.
GET/audit
Get all audit data in an archive tar file.
GET/audit/{id}
Get license audit file by Id.
GET/audit/active
Get license audit file for active license.

Models

#/definitions/LicenseLicense{...}
Licenses[...]
#/definitions/StatusStatus{...}