Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.envzero.com/llms.txt

Use this file to discover all available pages before exploring further.

As an organization admin, it is possible to create API keys that can use env zero without interacting with the UI. for example, you can use our API directly, work with our Terraform Provider or use our Private Module Registry.
Deleting an API keyWhen deleting an API key it might take up to 1 hour for it to completely expire.

How to create an API key

From Organization Settings navigate to API Keys tab: API Keys tab in Organization Settings listing existing keys with a button to add a new one Click the + button to see the create API key modal.
By default, the role of the key will be Admin, but you can also assign it to a user role, and provide specific project permission (just like when inviting a new user to the platform):
Create API Key modal with role selector set to Admin and optional project permissions

Admin API Key

With an admin API key, you can perform any request that requires admin permission: changing organization settings, deploying and approving environments, etc.
You can check our full API in the API reference.

Non-Admin API Key

With a non-admin (User) API key, you can provide members of your team with the ability to use our API, while maintaining your organization’s RBAC.
When creating a user API key, it can be configured with specific project permissions, assigned to a team, and treated like any other user in the system.
Non-Admin API Key creation showing user role selection and project permission assignment fields

Personal API Key

With a personal API key, members of your team can be provided with the ability to use our API with the same permissions they have configured in their env zero account. Every user can generate a personal API key, you can read more about it in our API docs.

Next steps