API Keys
Last updated
Last updated
Panomics supports 2 types of API keys: internal and external. Only users whose role includes the Manage API Keys permission can access this functionality.
Internal API keys are used to interact programatically with the Panomics platform via the REST API (pre-release) and the CLI.
External API keys enable the ingestion of samples from remote sources such as AWS and DNAnexus.
To get to the API key management pages, click on your avatar icon in the top right corner, then on the API Keys menu item. By default, you will be taken to the internal API keys management page.
Typically, you will require only 1 API key, but you can create as many as you need.
To create a new API key, click on the Create button in the toolbar. This will open a modal dialog where you can input the API key name and duration. After clicking in the Submit button, the API key will appear in the grid. Make sure to copy the key, as you won't be able to see it in clear text again.
Click the copy icon next to the clear text API key before leaving or refreshing the page.
To delete API keys, select them using the corresponding checkboxes in the grid and click the Delete button in the toolbar.
You can navigate to the external API keys page from your Profile page, Billing page, or API Keys page. External API keys are used to integrate with storage providers, such as AWS and DNAnexus. Panomics uses these keys to pull sample files. Refer to sample ingestion for more details.
You can have only 1 external API key per provider.
To create an external API key, click on the Create button in the toolbar. A modal dialog will open.
Fill in the label and select the provider: Amazon Web Services or DNAnexus
Fill in the key, secret, region, and duration, then click the Submit button.
Fill in the key and duration, then click the Submit button.
Your external API key listing should display the created external API keys.
To delete one or more external API keys, select their corresponding checkboxes and click the Delete button in the toolbar.
