Licenses

These are a collection of endpoints that allow you to query your existing Bird licenses attached to your Console.

Endpoints

GET /api/v1/license

GET /api/v1/license/detailed/info

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

curl https://EXAMPLE.canary.tools/api/v1/license \
  -d auth_token=EXAMPLE_AUTH_TOKEN \
  -G

import requests

url = 'https://EXAMPLE.canary.tools/api/v1/license'

payload = {
  'auth_token': 'EXAMPLE_AUTH_TOKEN',
}

r = requests.get(url, params=payload)

print(r.json())

Response

{
  "cloud": {
    "total": 5,
    "used": 0
  },
  "devices": {
    "total": 0,
    "used": 1
  },
  "vm": {
    "total": 5,
    "used": 0
  },
  "result": "success",
}

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

curl https://EXAMPLE.canary.tools/api/v1/license/detailed/info \
  -d auth_token=EXAMPLE_AUTH_TOKEN \
  -G

import requests

url = 'https://EXAMPLE.canary.tools/api/v1/license/detailed/info'

payload = {
  'auth_token': 'EXAMPLE_AUTH_TOKEN',
}

r = requests.get(url, params=payload)

print(r.json())

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
  },
  "containercanary_details": {
    "containercanary_count": 1, 
    "containercanary_image_details": {
      "docker": [
        {
          "arch": "amd64", 
          "namespace": "<Docker Hub namespace>",
          "pull_credentials": {
            "token": "<Docker Hub token>", 
            "username": "<Docker Hub username>"
          }, 
          "registry": "https://index.docker.io/v1/", 
          "repo": "<Docker Hub repo>", 
          "sha256": "<Container digest>", 
          "tags": [
            "<Container version>", 
            "latest"
          ], 
          "version": "<Container version>"
        }
      ]
    }
  },
  "gcpcanary_details": {},
  "hypervcanary_details": {},
  "result": "success"
}