GET /api/v1/license
# Licenses
These are a collection of endpoints that allow you query your existing Bird licenses attached to your Console.
Endpoints
# Bird Licenses
GET /api/v1/license
Retrieve a summary of available Bird licenses.
Required Parameters
auth_token string
A valid auth token
Response
A JSON structure containing a list of Canary license information.
Example
Response
{
"cloud": {
"total": 5,
"used": 0
},
"devices": {
"total": 0,
"used": 1
},
"vm": {
"total": 5,
"used": 0
},
"result": "success",
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
2
3
4
5
6
7
8
9
10
11
12
13
14
15
# Detailed Bird License Information
GET /api/v1/license/detailed/info
Retrieve a list of Cloud / Virtual license details including limits and URLs to images.
Required Parameters
auth_token string
A valid auth token
Response
A JSON structure containing detailed Canary license information.
Example
Response
{
"azurecanary_details": {},
"canaryvm_details": {
"canaryvm_count": 0,
"canaryvm_license_count": 5,
"canaryvm_remaining_licenses": 5,
"canaryvm_version_details": [
{
"commit": "8a06e02",
"link": "<unique_link>",
"ovalink": "<unique_link>",
"password": "<password>",
"seedlink": "<unique_link>",
"version": "2.2.1"
}
]
},
"cloudcanary_details": {
"cloudcanary_count": 0,
"cloudcanary_license_count": 5,
"cloudcanary_remaining_licenses": 5
},
"gcpcanary_details": {},
"hypervcanary_details": {},
"result": "success"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
← Global Search Testing →