Generate API keys

API keys in Paradime are generated at a workspace level.

Generate a new set of API keys

To generate API credentials for making API calls in Paradime, navigate to the Account Settings screen and select Workspace Settings from the left panel. Scroll to the bottom of the screen and click on Generate API Keys.

Here you will be able to:

  • Provide a human readable name to help identify what is the API key generated for

  • Set an optional lifetime in days for the API keys, after the credentials will expire those will not be valid

  • Grant a set of capabilities or scopes to the API keys

Capabilities

CapabilitiesDescription

Audit logs viewer

This permission grants access to view and export Audit Logs.

Bolt schedules admin

This permission grants access to trigger and cancel Bolt runs, as well as access to Bolt schedules and runs' metadata.

Bolt schedules metadata viewer

This permission grants access to access to Bolt schedules and runs' metadata.

Custom integrations admin

This permission grants access to create and manage custom integrations.

User management admin

This permission grants access to invite, disabling, updating users in a workspace, as well as listing users' metadata.

User metadata viewer

This permission grants access to view users' metadata.

Workspace metadata viewer

This permission grants access to view the account workspaces' metadata.

Make sure to store your API credentials securely in a password manager like Lastpass/Dashlane.

After refreshing/leaving this screen you wont be able to retrieve the API keys again.

View existing API keys details

To view all active API keys in the workspace, navigate to the Account Settings screen and select Workspace Settings from the left panel. Scroll to the bottom of the screen to find details of all API keys.

To view the capabilities assigned to a set of API keys, click on the name of the API key to view additional details.

Delete API keys

To delete a set of API keys, navigate to the Account Settings screen and select Workspace Settings from the left panel. Scroll to the bottom of the screen to find details of all API keys.

To delete an API key, click on the name of the API key to view and select the delete option.

Please note that this action is irreversible, and any API calls made using the deleted API key will fail.

Last updated