API docs by Redocly

NVIDIA Licensing Service (production)

Download OpenAPI specification:Download

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

License Usage

APIs to retrieve Licensing usage details. Works with API Key(s) of Access Type - Licensing State. Use https://api.licensing.nvidia.com as Server base address for APIs listed here

List virtual group

Returns list of virtual group in the org.To avoid resource details pass detailedView=false.To fetch details only about the org i.e. default vg,pass only-default=true.

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

Organization name

query Parameters
page-number
integer <int32>

The page number of result

page-size
integer <int32>

The page size of result

only-default
boolean

Parameter to fetch only default vg in the response

detailedView
boolean
Default: false

Parameter to fetch child entities against each VG

Responses

Response samples

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

Get Virtual group

Get Virtual Group in the specified org.

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

Organization name

virtual-group-id
required
integer <int32>

Virtual Group

query Parameters
detailedView
boolean
Default: false

Parameter to fetch child entities against each VG

Responses

Response samples

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

List license server

Returns paginated license server list.

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

Organization name

virtual-group-id
required
integer <int32>

virtual-group-id

query Parameters
namespace
string

Product namespace

page-number
integer <int32>

The page number of result

page-size
integer <int32>

The page size of result

Responses

Response samples

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

List license pools

Get List of License Pool for input License Server ID

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

Organization name

virtual-group-id
required
integer <int32>

virtual-group-id

server-id
required
string <uuid>

license-server-id

Responses

Response samples

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

Retrieve license pool

Get a License Pool for input id.

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

Organization name

virtual-group-id
required
integer <int32>

virtual-group-id

server-id
required
string <uuid>

license-server-id

pool-id
required
string <uuid>

pool-id

Responses

Response samples

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

List fulfillment conditions

Get List of FulfillmentCondition for input server id.

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

Organization name

virtual-group-id
required
integer <int32>
server-id
required
string <uuid>

Responses

Response samples

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

Retrieve fulfillment condition

Retrieve FulfillmentCondition

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

Organization name

virtual-group-id
required
integer <int32>
server-id
required
string <uuid>
fulfillment-condition-id
required
string <uuid>

Responses

Response samples

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

Retrieve license server

Retrieve license server. To generate license file for Legacy license server, pass regenerateLicenseFile query param to true.

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

Organization name

virtual-group-id
required
integer <int32>

virtual-group-id

id
required
string <uuid>

license server id

query Parameters
regenerate-license-file
boolean
Default: false

Parameter to regenerate the Legacy license server file.

Responses

Response samples

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

Download NLS license file.

Gets license file for specified license server.

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

Organization name

virtual-group-id
required
integer <int32>

virtual-group-id

id
required
string <uuid>

license server id.

Responses

Response samples

Content type
application/json
{
  • "license": "string"
}

Retrieve license servers having features of the pkid.

Retrieves license servers having features of the input pkId.

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

Organization name

virtual-group-id
required
integer <int32>

virtual-group-id

pkId
required
string

PkId of the feature to which the associated License Servers to be retrieved.

query Parameters
namespace
string

product namespace

page-number
integer <int32>

page number

page-size
integer <int32>

page size

Responses

Response samples

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

Retrieves legacy license server list having conflicting mac address

Retrieves all the legacy license server having same mac address.

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

Organization name

virtual-group-id
required
integer <int32>

virtual-group-id

Responses

Response samples

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

Retrieve active leases..

Returns list of active leases in the context of service instance. Service instance details is passed in header

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

Organization name

virtual-group-id
required
integer <int32>

Virtual Group Id

query Parameters
license_server_ids
string

comma separated list of license server ids

license_server_feature_ids
string
license_pool_ids
string
license_pool_feature_ids
string
hostname
string
ip_addresses
string
mac_addresses
string
feature_name
string

feature name to filter the leases on.

page_number
integer <int32>

The page number of result

page_size
integer <int32>

The page size of result

header Parameters
X-NV-SERVICE-INSTANCE-ID
required
string

Service Instance ID for which to fetch active leases

Responses

Response samples

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

Search entitlement by product key id

Gets details of an entitlement with specified pkId.

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

Organization name

virtual-group-id
required
integer <int32>

Virtual Group Id

pkId
required
string

Entitlement eId whose details need to be retrieved. This is not the EMS eId.

query Parameters
enforcement
string

Enforcement value. AllowableValues RTU, FLEXERA, NVIDIA

namespace
string

Product namespace

expired
string

Expired value - 0(not expired), 1(expired)

network-products
boolean

boolean query parameter to show legacy network products

Responses

Response samples

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

Export entitlements in csv/xlsx

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

Organization name

virtual-group-id
required
integer <int32>

Virtual Group Id

query Parameters
file-format
string
Default: "xlsx"

This parameter is used to specify format of file either csv/xlsx

Responses

Response samples

Content type
application/json
"string"

Get data for dashboard.

It fetches various data displayed on dashboard for NLP portal

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

Organization name

virtual-group-id
required
integer <int32>

Virtual Group Id

Responses

Response samples

Content type
application/json
{
  • "entitlements": {
    },
  • "licenseServers": {
    },
  • "users": {
    },
  • "serviceInstances": {
    },
  • "flexeraMigrations": {
    }
}

Get the Bright product key

This api return Bright product-key if available otherwise return the attempt details with the errors received in each attempt

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

organization name

virtual-group-id
required
integer <int32>

Virtual group id

query Parameters
entitlementFeatureId
required
string <uuid>

Entitlement feature id.

Responses

Response samples

Content type
application/json
{
  • "entitlementFeatureId": "0293ef3c-f646-4c34-ac73-35bbbbc883c0",
  • "productKey": "string",
  • "createdBy": "string",
  • "createdAt": "string",
  • "error": [
    ]
}

Software Download

APIs to filter and retrieve downloads. Works with API Key(s) with Access Type - Software Downloads. Use https://api.licensing.nvidia.com as Server base address for APIs listed here

Search download

Fetch downloads using api-key.

Authorizations:
X-API-KEY
Request Body schema: application/json
fetchMetadata
boolean
Default: false

Used to fetch either metadata file or driver files. Default value is false

platformName
string

Platform Name

platformVersion
string

Platform Version

downloadVersion
string

Software download Version

type
string
Enum: "GUEST" "HOST"

Field to fetch Guest or Host driver

cpuArchitecture
string

CPU architecture

pageStartIndex
integer <int32>

Page Start Index. Starts with 0

pageSize
integer <int32>

Page Size

linkType
string
Enum: "Current" "Preferred" "Archived"

Link Type.

sortOrder
string

Sort Order

sortDirection
string
Enum: "Asc" "Desc"

Sort Direction

productName
required
string

Product Name

Responses

Request samples

Content type
application/json
{
  • "fetchMetadata": false,
  • "platformName": "string",
  • "platformVersion": "string",
  • "downloadVersion": "string",
  • "type": "GUEST",
  • "cpuArchitecture": "string",
  • "pageStartIndex": 0,
  • "pageSize": 0,
  • "linkType": "Current",
  • "sortOrder": "string",
  • "sortDirection": "Asc",
  • "productName": "string"
}

Response samples

Content type
application/json
{
  • "count": 0,
  • "downloads": [
    ],
  • "errorCode": 0,
  • "errorMessage": "string",
  • "fieldName": "string",
  • "fieldValues": [
    ],
  • "productFamily": [
    ],
  • "transactionId": 0
}

List compatible downloads

Fetch compatible downloads using api-key based on passed params

Authorizations:
X-API-KEY
Request Body schema: application/json
product
required
string

Name of product like vgpu

driverType
string

type of driver for filtering downloads. Supports 'guest' or 'host' value for vgpu product

osName
string

OS name supported by download for filtering

osVersion
string

OS version supported by download for filtering

releaseVersion
Array of strings

list of release versions that the output drivers must support or be supported by. Output drivers must be compatible with all values specified in this list

driverVersion
Array of strings

list of driver versions that the output drivers must support or be supported by. Output drivers must be compatible with all values specified in this list

gpuName
Array of strings

list of GPU names to be supported by download object

ltsb
boolean

whether download should be LTSB

latest
boolean

return latest release of download based on above filters

Responses

Request samples

Content type
application/json
{
  • "product": "string",
  • "driverType": "string",
  • "osName": "string",
  • "osVersion": "string",
  • "releaseVersion": [
    ],
  • "driverVersion": [
    ],
  • "gpuName": [
    ],
  • "ltsb": true,
  • "latest": true
}

Response samples

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

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://api.nodelocked.licensing.nvidia.com/nll/leasing/v1

Auth : https://api.cls.licensing.nvidia.com/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"
}