Licenses

This article describes how to manage Aidbox licenses

Create license

Create self-hosted license

  1. 1.
    On the main navigation sidebar of the portal , click on the project name
  2. 2.
    On the menu that opens, click Assets
  3. 3.
    In the upper right corner of the page, click New Aidbox
  4. 4.
    Select the license type: Dev or Prod
  5. 5.
    Enter the Aidbox instance License name
  6. 6.
    Select Goal: Development, Research, or Evaluation
  7. 7.
    Specify Hosting as Self-hosted
  8. 8.
    Click Create

This quickstart guide explains how to run Aidbox locally using docker compose

Create a hosted Aidbox instance

  1. 1.
    On the main navigation sidebar of the portal , click on the project name
  2. 2.
    On the menu that opens, click Assets
  3. 3.
    In the upper right corner of the page, click New Aidbox
  4. 4.
    Select the license type: Dev or Prod
  5. 5.
    Enter the Aidbox instance License name
  6. 6.
    Select Goal: Development, Research, or Evaluation
  7. 7.
    Specify Hosting as Sandbox
  8. 8.
    Specify Aidbox version
    • Latest
    • Edge
  9. 9.
    Specify FHIR Version (we recommend using 4.0.1 by default)
  10. 10.
    Click Create

Create AWS license

Run Aidbox on AWS

Delete license

  1. 1.
    On the main navigation sidebar of the portal , click on the project name
  2. 2.
    On the menu that opens, click Assets
  3. 3.
    Click on a license in the list
  4. 4.
    Information about the selected license will appear on the right side of the screen. Click Delete this License
  5. 5.
    In the confirmation window, type the license name and click Delete this License

Manage Aidbox licenses via API

Licences API on Aidbox portal allows you to issue Aidbox licenses on-premise installation (self-hosted) and automate the process of deploying new Aidbox instances locally or in your infrastructure.

To run queries present below, you can use some tool to run http requests (e.g. Postman).

Issue token

To access the API, you have to issue a token, bound with the project, through the Aidbox portal :

  1. 1.
    On the main navigation sidebar, click on the project name.
  2. 2.
    On the menu that opens, click Settings.
  3. 3.
    Click button Issue Token.

Create license

POST https://aidbox.app/rpc
content-type: text/yaml
accept: text/yaml

method: portal.portal/issue-license
params: 
  token: <your-token>
  name: <license-name>
  product: aidbox 
  # production | development | ci
  type: production

Delete license

There are two options for deleting a license:

by license id

POST https://aidbox.app/rpc
content-type: text/yaml
accept: text/yaml

method: portal.portal/remove-license
params: 
  token: <your-token>
  id: <license-id>

by license string

POST https://aidbox.app/rpc
content-type: text/yaml
accept: text/yaml

method: portal.portal/remove-license
params: 
  token: <your-token>
  license: <license-string>

Get license

Retrieve license:

by license id

POST https://aidbox.app/rpc
content-type: text/yaml
accept: text/yaml

method: portal.portal/get-license
params: 
  token: <your-token>
  id: <license-id>

by license string

POST https://aidbox.app/rpc
content-type: text/yaml
accept: text/yaml

method: portal.portal/get-license
params: 
  token: <your-token>
  license: <license-string>

Get list of licenses

Retrieve all licenses associated with a project.

POST https://aidbox.app/rpc
content-type: text/yaml
accept: text/yaml

method: portal.portal/get-licenses
params: 
  token: <your-token>

References

Licensing and Support

This page covers types of Aidbox licenses and describes Aidbox Support tiers.

Run Aidbox locally

This quickstart guide explains how to run Aidbox locally using docker compose

Aidbox as a SaaS on AWS

Run Aidbox on AWS

PreviousProjects
NextMembers