# API Keys

Panomics supports 2 types of API keys: `internal` and `external`. Only users whose role includes the *Manage API Keys* permission can access this functionality.

<table><thead><tr><th width="237">Type</th><th>Use</th></tr></thead><tbody><tr><td><a href="#internal">Internal</a></td><td>Internal API keys are used to interact programatically with the Panomics platform via the REST API (pre-release) and the CLI.</td></tr><tr><td><a href="#external">External</a></td><td>External API keys enable the ingestion of samples from remote sources such as AWS and DNAnexus.</td></tr></tbody></table>

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.

<div align="center" data-full-width="false"><figure><img src="https://3894776587-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUZMYHWMJyvkxhr9s6Lm5%2Fuploads%2FsKtDqU9E6p2wMIXb2zDG%2FScreenshot%202024-05-03%20at%2023.48.32.png?alt=media&#x26;token=a7652675-7c46-46a5-97d6-fc5e043840dd" alt="" width="563"><figcaption></figcaption></figure></div>

### Internal

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.

<figure><img src="https://3894776587-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUZMYHWMJyvkxhr9s6Lm5%2Fuploads%2FlFGZFdGR3SBz0Lhk5G4c%2FScreenshot%202024-05-04%20at%2009.15.48.png?alt=media&#x26;token=054ef2eb-2052-452a-b380-ba8cf4d5bead" alt=""><figcaption><p>Create API Key modal dialog</p></figcaption></figure>

<figure><img src="https://3894776587-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUZMYHWMJyvkxhr9s6Lm5%2Fuploads%2FoEkfOya0QWBQe0fKFT8I%2FScreenshot%202024-05-04%20at%2009.13.06.png?alt=media&#x26;token=12bb6860-77ec-44f1-a4a2-c0e51b8d709b" alt=""><figcaption><p>API Key grid immediately after creation</p></figcaption></figure>

{% hint style="info" %}
Click the copy icon next to the clear text API key before leaving or refreshing the page.
{% endhint %}

<figure><img src="https://3894776587-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUZMYHWMJyvkxhr9s6Lm5%2Fuploads%2FLcw4IDsLVAJ8u9Goo04y%2FScreenshot%202024-05-04%20at%2009.13.22.png?alt=media&#x26;token=4d995333-1a39-4459-97f7-2179d7f8f955" alt=""><figcaption><p>API Key grid after page refresh</p></figcaption></figure>

To delete API keys, select them using the corresponding checkboxes in the grid and click the `Delete` button in the toolbar.

### External

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](https://documentation.panomics.bio/documentation/samples/sample-ingestion) for more details.

{% hint style="info" %}
You can have only 1 external API key per provider.
{% endhint %}

<figure><img src="https://3894776587-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUZMYHWMJyvkxhr9s6Lm5%2Fuploads%2F1Qw38kpzz11VmZMrolOw%2FScreenshot%202024-05-04%20at%2009.24.48.png?alt=media&#x26;token=f0a237f2-1629-49b8-a482-737aa072bf70" alt=""><figcaption><p>External API Keys list</p></figcaption></figure>

To create an external API key, click on the `Create` button in the toolbar. A modal dialog will open.

<figure><img src="https://3894776587-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUZMYHWMJyvkxhr9s6Lm5%2Fuploads%2Fv82XU5ObBaPUuVJtJiSs%2FScreenshot%202024-05-04%20at%2009.29.18.png?alt=media&#x26;token=a5b9a62f-6a85-4e7d-8b17-1a66a1727716" alt=""><figcaption><p>Create external API key dialog</p></figcaption></figure>

Fill in the label and select the provider: `Amazon Web Services` or `DNAnexus`

#### Amazon Web Services

<figure><img src="https://3894776587-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUZMYHWMJyvkxhr9s6Lm5%2Fuploads%2FnKfc8olWjcWCkILDY48p%2FScreenshot%202024-05-04%20at%2009.30.04.png?alt=media&#x26;token=c5fb58b9-8b2a-491a-bde9-5a366390d339" alt=""><figcaption><p>Create an AWS key</p></figcaption></figure>

Fill in the key, secret, region, and duration, then click the `Submit` button.

#### DNAnexus

<figure><img src="https://3894776587-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUZMYHWMJyvkxhr9s6Lm5%2Fuploads%2FCZPKKMVIMAplA2R0YK9c%2FScreenshot%202024-05-04%20at%2009.34.57.png?alt=media&#x26;token=5eee811c-d788-4054-9735-0364a91e9641" alt=""><figcaption><p>Create a DNAnexus key</p></figcaption></figure>

Fill in the key and duration, then click the `Submit` button.

Your external API key listing should display the created external API keys.

<figure><img src="https://3894776587-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUZMYHWMJyvkxhr9s6Lm5%2Fuploads%2F8LdO4L7Z2liMYv9ZUISd%2FScreenshot%202024-05-04%20at%2009.33.57.png?alt=media&#x26;token=32b6785a-718c-45d3-8f21-bf976483e5cc" alt=""><figcaption><p>External API Key listing</p></figcaption></figure>

To delete one or more external API keys, select their corresponding checkboxes and click the `Delete` button in the toolbar.