Manage Licenses

Manage Licenses
API to manage the license file for disconnected mode.

API to manage the license file by Avi Cloud Console in disconnected mode. Please get the license file from Avi Cloud Console. All the earlier licenses will be removed and only the licenses from the given license file will be in effect after this API call.

Request
URI
POST
https://{api_host}/licensing/licenses
COPY
Query Parameters
string
action
Required

Action that needs to be taken on the license file. Supported action is 'import'

Request Body

Multipart file with license details by Avi Cloud Console.

LicenseFileUpload of type(s) multipart/form-data
Required 
{
    "file": "string",
    "secret_key": "string"
}
string As binary As binary
file
Optional

Multipart file with licenses. If secret_key is provided, this file is treated as encrypted.

string
secret_key
Optional

Optional. If provided, the file is treated as an encrypted license file that will be decrypted using this key.

Authentication
This operation uses the following authentication methods.
Responses
204

Licenses are saved successfully.

Operation doesn't return any data structure

400

Bad Request

Returns BadRequest of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required

Message describing the error.


401

Unauthorized

Returns Unauthorized of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required

Message describing the error.


403

Forbidden

Returns Forbidden of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required

Message describing the error.


412

Precondition Failed

Returns PreconditionFailed of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required

Message describing the error.


428

Precondition Required

Returns PreconditionRequired of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required

Message describing the error.


429

Too Many Requests

Returns TooManyRequests of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required

Message describing the error.


default

unexpected error

Returns Error of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required

Message describing the error.


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: multipart/form-data' -d '{}' https://{api_host}/licensing/licenses
On This Page
Licensing Service Operations
POST
Manage Licenses
GET
List Licenses
GET
Get License
GET
List License Endpoint Mappings
POST
Create License Endpoint Mapping
GET
Get License Endpoint Mapping
DELETE
Delete License Endpoint Mapping
POST
Bulk License Endpoint Mappings