Skip to main content
Feedback

API keys

The API keys section on the User Settings page allows you to generate and manage API keys for authenticating with the API.

Flow is based on an API-first architecture, meaning that many of the operations performed within Boomi Flow can also be accessed through the Rest API.

  • You can authenticate with the API using an API key.

  • Once you have generated an API key, you can add a x-boomi-flow-api-key header to your API requests instead of an Authorization header, to authenticate as yourself. This header should contain only the apiKey value of the API key.

  • API keys are specific to a tenant, meaning that each API key only authenticates you for the tenant selected when generating the API key.

note

When making requests to the API, you may also need to include a manywhotenant header referencing the tenant ID value that the API key is associated with.

To learn more about using the REST API, refer to the Flow API documentation.

Managing API keys

The Generate a new API key section allows you to generate a new API key. Refer to Generating an API key.

The API keys table displays the existing API keys that you have generated from your user account. The table contains the following columns:

  • Actions: The Delete icon allows you to delete an API key. Refer to Deleting an API key.

  • Key Name: The name of the API key.

  • Tenant Name: The name of the tenant that the API key allows you to authenticate to.

  • Tenant ID: The ID of the tenant that the API key allows you to authenticate to.

  • Created: The date the API key was generated.

  • Key: Click Show to display the 32-character API key.

On this Page