licenses.md

description
This article describes how to manage Aidbox licenses

Licenses

Create license

Create self-hosted license

1. On the main navigation sidebar, click on the project name
2. On the menu that opens, click Licenses
3. In the upper right corner of the page, click New _license_
4. Choose Aidbox
5. Enter the Aidbox instance name
6. Specify Hosting as Self-hosted
7. Click Create

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

{% content-ref url="../../getting-started-1/run-aidbox/run-aidbox-locally-with-docker.md" %} run-aidbox-locally-with-docker.md {% endcontent-ref %}

Create a hosted Aidbox instance

1. On the main navigation sidebar, click on the project name
2. On the menu that opens, click Licenses
3. In the upper right corner of the page, click New _license_
4. Specify FHIR Platform
   • Aidbox
5. Enter the Aidbox instance name
6. Specify Hosting as Google Cloud Platform
7. Specify Aidbox version
   • Latest
   • Edge
8. Specify Сonfiguration projects
9. Click Create

Create AWS license

{% content-ref url="../../getting-started-1/run-aidbox/run-aidbox-as-a-saas/aidbox-as-a-saas-on-aws.md" %} aidbox-as-a-saas-on-aws.md {% endcontent-ref %}

Delete license

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

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. On the main navigation sidebar, click on the project name.
2. On the menu that opens, click Settings.
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 
  # standard | development | ci
  type: standard

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.

{% content-ref url="../../getting-started/editions-and-pricing.md" %} editions-and-pricing.md {% endcontent-ref %}

Run Aidbox locally

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

{% content-ref url="../../getting-started-1/run-aidbox/run-aidbox-locally-with-docker.md" %} run-aidbox-locally-with-docker.md {% endcontent-ref %}

Aidbox as a SaaS on AWS

{% content-ref url="../../getting-started-1/run-aidbox/run-aidbox-as-a-saas/aidbox-as-a-saas-on-aws.md" %} aidbox-as-a-saas-on-aws.md {% endcontent-ref %}