2021-01-19 11:09:05 -06:00
|
|
|
|
+++
|
|
|
|
|
|
title = "Licensing HTTP API "
|
2021-04-15 15:56:29 -05:00
|
|
|
|
description = "Enterprise Licensing HTTP API"
|
2021-01-19 11:09:05 -06:00
|
|
|
|
keywords = ["grafana", "http", "documentation", "api", "licensing", "enterprise"]
|
2021-04-12 02:42:10 -05:00
|
|
|
|
aliases = ["/docs/grafana/next/http_api/licensing/"]
|
2021-01-19 11:09:05 -06:00
|
|
|
|
+++
|
|
|
|
|
|
|
2021-04-15 15:56:29 -05:00
|
|
|
|
# Enterprise License API
|
|
|
|
|
|
|
|
|
|
|
|
Licensing is only available in Grafana Enterprise. Read more about [Grafana Enterprise]({{< relref "../enterprise" >}}).
|
2021-01-19 11:09:05 -06:00
|
|
|
|
|
|
|
|
|
|
## Manually force license refresh
|
|
|
|
|
|
|
|
|
|
|
|
> **Note:** Available in Grafana Enterprise v7.4+.
|
|
|
|
|
|
|
|
|
|
|
|
`POST /api/licensing/token/renew`
|
|
|
|
|
|
|
|
|
|
|
|
Manually ask license issuer for a new token.
|
|
|
|
|
|
|
|
|
|
|
|
**Example request:**
|
|
|
|
|
|
|
|
|
|
|
|
```http
|
|
|
|
|
|
POST /api/licensing/token/renew
|
|
|
|
|
|
Accept: application/json
|
|
|
|
|
|
Content-Type: application/json
|
|
|
|
|
|
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
|
|
|
|
|
|
|
|
|
|
|
|
{}
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
**Example response:**
|
|
|
|
|
|
|
|
|
|
|
|
```http
|
|
|
|
|
|
HTTP/1.1 200 OK
|
|
|
|
|
|
Content-Type: application/json
|
|
|
|
|
|
Content-Length: 357
|
|
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
|
"jti":"2",
|
|
|
|
|
|
"iss":"https://grafana.com",
|
|
|
|
|
|
"sub":"https://play.grafana.org/"
|
|
|
|
|
|
"lid":"1",
|
|
|
|
|
|
"included_admins":5,
|
|
|
|
|
|
"included_viewers":10,
|
|
|
|
|
|
"lic_exp_warn_days":30,
|
|
|
|
|
|
"tok_exp_warn_days":2,
|
|
|
|
|
|
"update_days":1,
|
|
|
|
|
|
"prod":["grafana-enterprise"],
|
|
|
|
|
|
"company":"Grafana Labs"
|
|
|
|
|
|
}
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
The response is a JSON blob available for debugging purposes. The
|
|
|
|
|
|
available fields may change at any time without any prior notice.
|
|
|
|
|
|
|
|
|
|
|
|
Status Codes:
|
|
|
|
|
|
|
|
|
|
|
|
- **200** - OK
|
|
|
|
|
|
- **401** - Unauthorized
|
|
|
|
|
|
- **403** - Access denied
|
|
|
|
|
|
|
|
|
|
|
|
## Remove license from database
|
|
|
|
|
|
|
|
|
|
|
|
> **Note:** Available in Grafana Enterprise v7.4+.
|
|
|
|
|
|
|
|
|
|
|
|
`DELETE /api/licensing/token`
|
|
|
|
|
|
|
|
|
|
|
|
Removes the license stored in the Grafana database.
|
|
|
|
|
|
|
|
|
|
|
|
**Example request:**
|
|
|
|
|
|
|
|
|
|
|
|
```http
|
|
|
|
|
|
DELETE /api/licensing/token
|
|
|
|
|
|
Accept: application/json
|
|
|
|
|
|
Content-Type: application/json
|
|
|
|
|
|
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
|
|
|
|
|
|
|
|
|
|
|
|
{"instance": "http://play.grafana.org/"}
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
JSON Body schema:
|
|
|
|
|
|
|
|
|
|
|
|
- **instance** – Root URL for the instance for which the license should be deleted. Required.
|
|
|
|
|
|
|
|
|
|
|
|
**Example response:**
|
|
|
|
|
|
|
|
|
|
|
|
```http
|
|
|
|
|
|
HTTP/1.1 202 Accepted
|
|
|
|
|
|
Content-Type: application/json
|
|
|
|
|
|
Content-Length: 2
|
|
|
|
|
|
|
|
|
|
|
|
{}
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
Status codes:
|
|
|
|
|
|
|
|
|
|
|
|
- **202** - Accepted, license removed or did not exist.
|
|
|
|
|
|
- **401** - Unauthorized
|
|
|
|
|
|
- **403** - Access denied
|
|
|
|
|
|
- **422** - Unprocessable entity, incorrect instance name provided.
|
