API docs by Redocly

NVIDIA Licensing Service Virtual Appliance APIs (production)

Download OpenAPI specification:Download

URL: https://www.nvidia.com/en-us/support/enterprise/ Terms of Service

Enterprise

APIs with Enterprise access support. Works with API Key(s) of Access Type - Enterprise. Based on sub-category and API to call use below servers

NLL : https://{DLS_IP_ADDRESS_OR_FQDN}/nll/leasing/v1

Auth : https://{DLS_IP_ADDRESS_OR_FQDN}/auth/v1

[NLL] Request NLL license file

Authorizations:
bearerAuth
Request Body schema: application/json

request body for node locked license file generation

Array of objects (NllLease)

Responses

Request samples

Content type
application/json
{
  • "lease_list": [
    ]
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "text",
  • "prompts": [
    ],
  • "sync_timestamp": "2099-12-31T23:59:59+00:00"
}

[NLL] Delete NLL leases for associated NLL zip file

Authorizations:
bearerAuth
Request Body schema: application/json

request body for node locked license leases release

required
object (NllReleaseRequest)

Responses

Request samples

Content type
application/json
{
  • "nll_release_request": {
    }
}

Response samples

Content type
application/json
{
  • "transaction_id": "00112233-4455-6677-8899-aabbccddeeff"
}

[Auth] Get Auth token for lease APIs using a valid API key

header Parameters
x-api-key
string <uuid>

API Key generated from Nvidia Licensing Portal. This API Key should be "Enterprise" type.

Responses

Response samples

Content type
application/json
{
  • "auth_token": "xxxxxxx.yyyyyyyyy.zzzzzzzzz",
  • "expires": "2099-12-31T23:59:59+00:00",
  • "prompts": [
    ],
  • "sync_timestamp": "2099-12-31T23:59:59+00:00"
}

License Usage

APIs to retrieve Licensing usage details. Works with API Key(s) of Access Type - Licensing State. Use Server https://{DLS_IP_ADDRESS_OR_FQDN}/admin/v1/ for APIs in this category

List all License Servers

Authorizations:
X-API-KEY
path Parameters
org-name
required
string
Example: lic-radioshack

org name

virtual-group-id
required
integer
Example: 123

virtual group id

query Parameters
page_number
integer
Default: 0

page number of result

page_size
integer
Default: 100000

page size of a result

Responses

Response samples

Content type
application/json
{
  • "licenseServers": [
    ]
}

Get License Server details

Authorizations:
X-API-KEY
path Parameters
org-name
required
string
Example: lic-radioshack

org name

virtual-group-id
required
integer
Example: 123

virtual group id

server-id
required
string <uuid>
Example: 00112233-4455-6677-8899-aabbccddeeff

license server id

Responses

Response samples

Content type
application/json
{
  • "licenseServer": {
    }
}

List Fulfillment Conditions for a License Server

Authorizations:
X-API-KEY
path Parameters
org-name
required
string
Example: lic-radioshack

org name

virtual-group-id
required
integer
Example: 123

virtual group id

server-id
required
string <uuid>
Example: 00112233-4455-6677-8899-aabbccddeeff

license server id

Responses

Response samples

Content type
application/json
{
  • "fulfillmentConditions": {
    }
}

Get Fulfillment Condition details

Authorizations:
X-API-KEY
path Parameters
org-name
required
string
Example: lic-radioshack

org name

virtual-group-id
required
integer
Example: 123

virtual group id

server-id
required
string <uuid>
Example: 00112233-4455-6677-8899-aabbccddeeff

license server id

fulfillment-condition-id
required
string <uuid>
Example: 00112233-4455-6677-8899-aabbccddeeff

xid to fulfillment condition

Responses

Response samples

Content type
application/json
{
  • "fulfillmentConditionResponse": {
    }
}

List License Pools in a License Server

Authorizations:
X-API-KEY
path Parameters
org-name
required
string
Example: lic-radioshack

org name

virtual-group-id
required
integer
Example: 123

virtual group id

server-id
required
string <uuid>
Example: 00112233-4455-6677-8899-aabbccddeeff

license server id

query Parameters
page_number
integer
Default: 0

page number of result

page_size
integer
Default: 100000

page size of a result

Responses

Response samples

Content type
application/json
{
  • "licensePools": [
    ],
  • "paginationInfo": {
    }
}

Get License Pool details

Authorizations:
X-API-KEY
path Parameters
org-name
required
string
Example: lic-radioshack

org name

virtual-group-id
required
integer
Example: 123

virtual group id

server-id
required
string <uuid>
Example: 00112233-4455-6677-8899-aabbccddeeff

license server id

pool-id
required
string <uuid>
Example: 00112233-4455-6677-8899-aabbccddeeff

license pool id

Responses

Response samples

Content type
application/json
{
  • "licensePool": {
    }
}

List active leases

Authorizations:
X-API-KEY
path Parameters
org-name
required
string
Example: lic-radioshack

org name

virtual-group-id
required
integer
Example: 123

virtual group id

query Parameters
license_server_ids
string
Example: license_server_ids=00112233-4455-6677-8899-aabbccddeeff

comma separated list of license server ids to filter the active leases

license_server_feature_ids
string
Example: license_server_feature_ids=00112233-4455-6677-8899-aabbccddeeff

comma separated list of license server feature ids to filter the active leases

license_pool_ids
string
Example: license_pool_ids=00112233-4455-6677-8899-aabbccddeeff

comma separated list of license pool ids to filter the active lieases

license_pool_feature_ids
string
Example: license_pool_feature_ids=00112233-4455-6677-8899-aabbccddeeff

comma separated list of license pool feature ids to filter the active leases

hostname
string
Example: hostname=myhost

comma separated list of hostnames to filter the active leases

ip_addresses
string
Example: ip_addresses=10.124.168.9

comma separated list of ip addresses to filter the active leases

mac_addresses
string
Example: mac_addresses=oo:ee:ab:13:44:de

comma separated list of mac addresses to filter the active leases

feature_name
string

feature name to filter the active leases

page_number
integer
Default: 0

page number of result

page_size
integer
Default: 100000

page size of a result

Responses

Response samples

Content type
application/json
{
  • "clients": [
    ],
  • "paginationInfo": {
    }
}