Licence Manager

Vault

Documentation Tutorials Try Cloud!

List terms

get

Query parameters

liststring · enumrequired

Must be set to true

Available options:

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v1/lm/terms/?list=true'

200

{
  "auth": {},
  "data": {
    "keys": [
      {}
    ]
  }
}

Read terms

get

Path parameters

uuidstringrequired

Identifier for the terms

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v1/lm/terms/{uuid}'

200

{
  "auth": {},
  "data": {
    "configuration": {},
    "created": 1,
    "description": "text",
    "name": "text",
    "uuid": "text"
  }
}

Delete terms

delete

Path parameters

uuidstringrequired

Identifier for the terms

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/v1/lm/terms/{uuid}'

200

No body

List products

get

Query parameters

liststring · enumrequired

Must be set to true

Available options:

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v1/lm/products/?list=true'

200

{
  "auth": {},
  "data": {
    "keys": [
      {}
    ]
  }
}

Read product

get

Path parameters

uuidstringrequired

Identifier for the product

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v1/lm/products/{uuid}'

200

{
  "auth": {},
  "data": {
    "created": 1,
    "description": "text",
    "name": "text",
    "uuid": "text"
  }
}

Delete product

delete

Path parameters

uuidstringrequired

Identifier for the product

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/v1/lm/products/{uuid}'

200

No body

List licences

get

Query parameters

liststring · enumrequired

Must be set to true

Available options:

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v1/lm/licences/?list=true'

200

{
  "auth": {},
  "data": {
    "keys": [
      {}
    ]
  }
}

Read licence

get

Path parameters

uuidstringrequired

Licence identifier

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v1/lm/licences/{uuid}'

200

{
  "auth": {},
  "data": {
    "activated": 1,
    "created": 1,
    "description": "text",
    "instances": [
      "text"
    ],
    "name": "text",
    "product": "text",
    "terms": "text",
    "uuid": "text"
  }
}

Delete licence

delete

Path parameters

uuidstringrequired

Licence identifier

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/v1/lm/licences/{uuid}'

200

No body

Poll licence

get

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v1/lm/poll'

200

{
  "auth": {},
  "data": {
    "instance": "text",
    "licence": "text",
    "product": {},
    "terms": {},
    "time": 1
  }
}

List logs

get

Query parameters

liststring · enumrequired

Must be set to true

Available options:

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v1/lm/logs/?list=true'

200

{
  "auth": {},
  "data": {
    "keys": [
      {}
    ]
  }
}

Read logs

get

Path parameters

datestringrequired

Date of the log file

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v1/lm/logs/{date}'

200

{
  "auth": {},
  "data": {
    "date": "text"
  }
}

Delete logs

delete

Path parameters

datestringrequired

Date of the log file

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/v1/lm/logs/{date}'

200

No body

Create terms

put

Body

configurationobject · map · default: {"expiration_days":365,"max_instances":3}required

A map of configuration options for this term

createdinteger · int64optional

Creation timestamp

descriptionstringrequired

Description for the terms

namestringrequired

Name of the terms

uuidstringoptional

Identifier for the terms

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/v1/lm/terms' \
  --header 'Content-Type: application/json' \
  --data '{
    "configuration": {},
    "created": 1,
    "description": "text",
    "name": "text",
    "uuid": "text"
  }'

200

{
  "auth": {},
  "data": {
    "configuration": {},
    "created": 1,
    "description": "text",
    "name": "text",
    "uuid": "text"
  }
}

Update terms

post

Body

configurationobject · map · default: {"expiration_days":365,"max_instances":3}required

A map of configuration options for this term

createdinteger · int64optional

Creation timestamp

descriptionstringrequired

Description for the terms

namestringrequired

Name of the terms

uuidstringoptional

Identifier for the terms

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/v1/lm/terms' \
  --header 'Content-Type: application/json' \
  --data '{
    "configuration": {},
    "created": 1,
    "description": "text",
    "name": "text",
    "uuid": "text"
  }'

200

{
  "auth": {},
  "data": {
    "configuration": {},
    "created": 1,
    "description": "text",
    "name": "text",
    "uuid": "text"
  }
}

Create product

put

Body

createdinteger · int64optional

Creation timestamp

descriptionstringrequired

Description for the product

namestringrequired

Name of the product

uuidstringoptional

Identifier for the product

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/v1/lm/products' \
  --header 'Content-Type: application/json' \
  --data '{
    "created": 1,
    "description": "text",
    "name": "text",
    "uuid": "text"
  }'

200

{
  "auth": {},
  "data": {
    "created": 1,
    "description": "text",
    "name": "text",
    "uuid": "text"
  }
}

Update product

post

Body

createdinteger · int64optional

Creation timestamp

descriptionstringrequired

Description for the product

namestringrequired

Name of the product

uuidstringoptional

Identifier for the product

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/v1/lm/products' \
  --header 'Content-Type: application/json' \
  --data '{
    "created": 1,
    "description": "text",
    "name": "text",
    "uuid": "text"
  }'

200

{
  "auth": {},
  "data": {
    "created": 1,
    "description": "text",
    "name": "text",
    "uuid": "text"
  }
}

Create licence

put

Body

activatedinteger · int64optional

Activation timestamp

createdinteger · int64optional

Creation timestamp

descriptionstringrequired

Description for the licence

instancesstring[]optional

Registered instances

namestringrequired

Name of the licence

productstringrequired

Product for this licence

termsstringrequired

Terms for this licence

uuidstringoptional

Licence identifier

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/v1/lm/licences' \
  --header 'Content-Type: application/json' \
  --data '{
    "activated": 1,
    "created": 1,
    "description": "text",
    "instances": [
      "text"
    ],
    "name": "text",
    "product": "text",
    "terms": "text",
    "uuid": "text"
  }'

200

{
  "auth": {},
  "data": {
    "activated": 1,
    "created": 1,
    "description": "text",
    "instances": [
      "text"
    ],
    "name": "text",
    "product": "text",
    "terms": "text",
    "uuid": "text"
  }
}

Update licence

post

Body

activatedinteger · int64optional

Activation timestamp

createdinteger · int64optional

Creation timestamp

descriptionstringrequired

Description for the licence

instancesstring[]optional

Registered instances

namestringrequired

Name of the licence

productstringrequired

Product for this licence

termsstringrequired

Terms for this licence

uuidstringoptional

Licence identifier

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/v1/lm/licences' \
  --header 'Content-Type: application/json' \
  --data '{
    "activated": 1,
    "created": 1,
    "description": "text",
    "instances": [
      "text"
    ],
    "name": "text",
    "product": "text",
    "terms": "text",
    "uuid": "text"
  }'

200

{
  "auth": {},
  "data": {
    "activated": 1,
    "created": 1,
    "description": "text",
    "instances": [
      "text"
    ],
    "name": "text",
    "product": "text",
    "terms": "text",
    "uuid": "text"
  }
}

Licence Manager

Terms

Products

Licences

Licence activation

Logs

Terms

Products

Licences

Licence activation

Logs

List terms

Read terms

Delete terms

List products

Read product

Delete product

List licences

Read licence

Delete licence

Poll licence

List logs

Read logs

Delete logs

Create terms

Update terms

Create product

Update product

Create licence

Update licence