API Keys

Create an API Key to access resources in Bindplane with CLI or REST API.

Availability

📘 API Keys are available in Bindplane Enterprise (Self-Hosted) and all Bindplane Cloud plans.

Creating an API Key

API Keys can be created from the UI by visiting the Project Settings page, found in the top-right hamburger menu.

Navigate to the API Keys section and click "Create API Key".

A modal will appear, allowing you to set an optional Description for the API Key, as well as set an expiration for the API Key. Click "Create" when you are ready.

A window will show you your new API Key. This will be the only time this key is available to you. If you do not copy the key now you will have to delete the key and generate another API key. window will show you your new API Key. This will be the only time this key is available to you. If you do not copy the key now you will have to regenerate another API key.

Important

📘 Each user can have one API key per project.

Audit Trail

Audit logs are generated when API Keys are created or deleted. These are visible by going to the project "Audit Log" in the top right hamburger menu.

Deleting an API Key

Users may remove a key that is no longer needed, or is expired. First navigate to the API Keys section of the Project Settings page.

Then click the trash can icon under Actions on the far right hand side. A dialog will appear to confirm the operation.