Generate API keys

Soda Cloud uses API keys to securely communicate with other entities such as Soda Core and self-hosted Soda Runners, and to provide secure access to Soda Cloud via API.

There are two sets of API keys that you can generate and use with Soda Cloud:

• API keys for communicating with Soda Core and Soda Cloud API,
• API keys for communicating with a self-hosted Soda Runner

Note that you can use other authentication methods to access Soda Cloud metadata via the Rest API, such as HTTPBasic authentication with username and password, or authentication using tokens; use API keys to authenticate access if your organization employs Single Sign On (SSO) to access Soda Cloud.

Nomenclature change: "Agent" is now "Runner"

The Soda Agent has been renamed to Soda Runner across all Soda products and interfaces. This change affects terminology throughout the platform, including:

• Soda Cloud UI labels
• API permission names: MANAGE_DATASOURCES_AND_AGENTS → MANAGE_DATASOURCES_AND_RUNNERS
• CLI flags: --use-agent → --use-runner
• Python API methods: verify_contract_on_agent → verify_contract_on_runner

The underlying functionality is unchanged, and both runner/agent nomenclatures are backward compatible at present. If you are following older documentation or have existing scripts and automation that reference "agent", we recommend to gradually replace every occurrence of "agent" / "Agent" with "runner" / "Runner".

Generate API keys for use with Soda Core or a Soda Cloud API

1. In your Soda Cloud account, navigate to your avatar > Profile and the API Keys tab. Click the "" icon to generate new API keys.

   
2. Copy the syntax for the soda_cloud configuration, including the values API Key ID and API Key Secret, then apply the keys according to how you intend to use them

Generate API keys for use with a Soda Runner

1. In your Soda Cloud account, navigate to Data Sources, then navigate to the Runners tab. Click New Soda Runner.

   
2. Copy the values of the API Key ID and API Key Secret to a secure location, then apply the keys according to the instructions in the Deploy a Soda Runner documentation.

---

You are not logged in to Soda and are viewing the default public documentation. Learn more about Documentation access & licensing.

If you do have a Soda license, make sure to log in to Soda Cloud in this same browser.