You can use these API calls to manage licenses for your database.
| POST licenses | Uploads and applies a new license to this cluster. |
| GET licenses | Returns the license field that databases created on this cluster use. |
This is the multi-page printable view of this section. Click here to print.
Licenses
You can use these API calls to manage licenses for your database.
- 1: POST licenses
- 2: GET licenses
1 - POST licenses
Uploads and applies a license file to this cluster.
Uploads and applies a license file to this cluster.
You must provide the license file as an HTTP POST form upload, identified by the name license. For example, you can use cURL:
curl -k --request POST -H "VerticaApiKey:ValidAPIKey" \
https://v_vmart_node0001:5444/licenses --form "license=@vlicense.dat"
Resource URL
https://<NODE>:5444/licenses
Authentication
Requires a VerticaAPIKey in the request header.
The API key must have admin level security.
Parameters
None.
Example request
| POST |
https://<NODE>:5444/licenses |
Response:
There is no HTTP body response for successful uploads. A successful upload returns an HTTP 200/OK header.
2 - GET licenses
Returns any license files that are used by this cluster when creating databases.
Returns any license files that are used by this cluster when creating databases. License files must reside in /opt/vertica/config/share.
Resource URL
https://<NODE>:5444/licenses
Authentication
Requires a VerticaAPIKey in the request header.
The API key must have restricted level security or higher.
Parameters
None.
Example request
| GET |
https://<NODE>:5444/licenses |
Response:
{
"body": [
{
"comment": "Vertica license is valid",
"end": "Perpetual",
"grace": "0",
"size": "1TB CE Nodes 3",
"start": "2011-11-22",
"status": true,
"vendor": "Vertica Community Edition"
}
],
"href": "/license",
"links": [],
"mime-type": "application/vertica.license.json-v2"
}