GET /licensing/status/{uuid}

GET /licensing/status/{uuid}

/licensing/status/{uuid}/{uuid}

Request
URI
GET
https://{api_host}/api/licensing/status/{uuid}
COPY
Path Parameters
string
uuid
Required  

UUID of the object to fetch

Query Parameters
string
name
Optional

object name

string
fields
Optional

List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.

boolean
include_name
Optional

All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.

boolean
skip_default
Optional

Default values are not set.

string
join_subresources
Optional

It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Header Parameters
string
X-Avi-Tenant
Optional

Avi Tenant Header

string
X-Avi-Tenant-UUID
Optional

Avi Tenant Header UUID

string
X-Avi-Version
Required  

The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version.

string
X-CSRFToken
Optional

Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns LicenseStatus of type(s) application/json 
{
    "_last_modified": "string",
    "cls_status": {
        "cls_id": "string",
        "cls_ref": "string",
        "connected": false,
        "enabled": false,
        "message": "string",
        "refreshed_at": "string",
        "usage_uploaded_at": "string"
    },
    "legacy_license_grace_period": "string",
    "saas_status": {
        "connected": false,
        "enabled": false,
        "expired": false,
        "last_refreshed_at": "string",
        "message": "string",
        "name": "string",
        "pool": {
            "available_service_units": "number",
            "pool_id": "string",
            "pool_name": "string",
            "used_service_units": "number"
        },
        "public_key": "string",
        "refresh_status": false,
        "refreshed_at": "string",
        "reserve_service_units": "number",
        "state": "string"
    },
    "service_update": {
        "name": "string",
        "service_units": {
            "available_service_units": "number",
            "org_id": "string",
            "used_service_units": "number"
        }
    },
    "support_legacy_license": false,
    "tenant_uuid": "string",
    "url": "string",
    "uuid": "string"
}
string
_last_modified
Read-Only  

UNIX time since epoch in microseconds. Units(MICROSECONDS).

object
cls_status
Optional

cls_status

string
legacy_license_grace_period
Optional

Legacy license grace period, when controller upgrades with existing legacy licenses. Field introduced in 32.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

object
saas_status
Optional

saas_status

object
service_update
Optional

service_update

boolean
support_legacy_license
Optional

Indicates if legacy licenses are supported. When false, legacy licenses have been cleaned up after grace period expiry. Field introduced in 32.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

string
tenant_uuid
Optional

Tenant uuid. Field introduced in 30.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

string
url
Read-Only  

url

string
uuid
Optional

Uuid. Field introduced in 21.1.3. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.


401

log in failed

Operation doesn't return any data structure

404

object not found

Operation doesn't return any data structure

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/licensing/status/{uuid}
On This Page
License Status Operations
GET
GET /licensing/status
POST
POST /licensing/status
GET
GET /licensing/status/{uuid}
PUT
PUT /licensing/status/{uuid}
PATCH
PATCH /licensing/status/{uuid}
DELETE
DELETE /licensing/status/{uuid}