How to Configure API Keys and Secret Providers

Learn how to securely configure API keys, assign security level permissions, and manage secret providers in the platform gateway.

July 28, 2026 By Arthur Rocha

This guide walks you through setting up an API key, configuring security permissions, and securing the key within a Secret Provider. Completing these steps ensures that external integrations have properly scoped, securely stored credentials for interacting with your system.

This process is intended for system administrators and security operators responsible for managing platform credentials and access configurations.

Create a Security Level

Step #1: Click Security Levels in the left sidebar. — Click **Security Levels** in the left sidebar.

Step #2: Click the Add Level button. — Click the **Add Level** button.

Step #3: Type API_Key in the Level Name field. — Type **API_Key** in the **Level Name** field.

Step #4: Click Save Changes in the top right corner. — Click **Save Changes** in the top right corner.

Assign General Permissions

Step #5: Click General under the Security section in the left sidebar. — Click **General** under the Security section in the left sidebar.

Step #6: Check the API_Key and Default boxes across the Gateway Read and Gateway Access permission trees to grant the necessary permissions. — Check the **API_Key** and **Default** boxes across the **Gateway Read** and **Gateway Access** permission trees to grant the necessary permissions.

Step #7: Click Save Changes. — Click **Save Changes**.

Generate an API Key

Step #8: Click API Keys in the left sidebar. — Click **API Keys** in the left sidebar.

Step #9: Click Create API Key. — Click **Create API Key**.

Step #10: Click Next to proceed past the initial selection step. — Click **Next** to proceed past the initial selection step.

Step #11: Enter or select a name for your key, such as Edit_API. — Enter or select a name for your key, such as **Edit_API**.

Step #12: Click Create API Key. — Click **Create API Key**.

Step #13: Click the copy icon inside the API Key field to copy your new key. — Click the copy icon inside the API Key field to copy your new key.

Store this key in a secure location immediately. It will not be visible again once you close this window.

Step #14: Check the box confirming you have stored your API Key for future reference. — Check the box confirming you have stored your API Key for future reference.

Step #15: Click Done to dismiss the modal. — Click **Done** to dismiss the modal.

Configure a Secret Provider

Step #16: Click Secret Providers in the left sidebar. — Click **Secret Providers** in the left sidebar.

Step #17: Click Create Secret Provider. — Click **Create Secret Provider**.

Step #19: Enter Keys (or your preferred identifier) into the Name field. — Enter **Keys** (or your preferred identifier) into the Name field.

Step #20: Click Create Secret Provider. — Click **Create Secret Provider**.

Step #21: From the actions menu of your new provider, click Manage Secrets. — From the actions menu of your new provider, click **Manage Secrets**.

Step #22: Click Create Secret. — Click **Create Secret**.

Enter a name for the secret, such as Edit_API.

Step #24: Paste your copied API key into the Secret Value text field. — Paste your copied API key into the **Secret Value** text field.

Step #25: Click Create Secret. — Click **Create Secret**.

Step #26: Close the secret management window. — Close the secret management window.

Link the API Key to the Secret

Step #27: Navigate back to API Keys in the left sidebar. — Navigate back to **API Keys** in the left sidebar.

Step #28: Click the vertical ellipsis menu next to your key and select Edit. — Click the vertical ellipsis menu next to your key and select **Edit**.

Step #29: Make your configuration updates and click Save Changes. — Make your configuration updates and click **Save Changes**.

Term	Definition
Ignition Gateway	The central service that manages connections, configuration, and security for the platform.
Security Level	A hierarchical access control tag used to define authorization requirements within the system.
API Key	A unique token used to securely authenticate external systems or scripts interacting with the platform.
Secret Provider	A secure storage mechanism designed to encrypt and manage sensitive credentials like API keys and passwords.

How to Configure API Keys and Secret Providers

Learn how to securely configure API keys, assign security level permissions, and manage secret providers in the platform gateway.

July 28, 2026 By Arthur Rocha

This process is intended for system administrators and security operators responsible for managing platform credentials and access configurations.

Create a Security Level

Assign General Permissions

Generate an API Key

Store this key in a secure location immediately. It will not be visible again once you close this window.

Configure a Secret Provider

Enter a name for the secret, such as Edit_API.

Link the API Key to the Secret

Term	Definition
Ignition Gateway	The central service that manages connections, configuration, and security for the platform.
Security Level	A hierarchical access control tag used to define authorization requirements within the system.
API Key	A unique token used to securely authenticate external systems or scripts interacting with the platform.
Secret Provider	A secure storage mechanism designed to encrypt and manage sensitive credentials like API keys and passwords.