Skip to main content
Framed content
API keys allow you to authenticate to the Miru Server-Side API as well as the Miru CLI in your CI pipeline. Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.

Create an API key

You must be an user to create an API key.
To create an API key, navigate to the API Keys page in the dashboard and click New API Key in the top right corner.
Provide a name for the API key, select the desired scopes, then click Create. Once an API key has been created, it can never be retrieved again. If you lose your API key, you must create a new one.

View API keys

To view your existing API keys, navigate to the API Keys page.
To see the scopes of an API key, click the scopes icon in the Scopes column of the API key you want to view.

Delete an API key

Deleting an API key immediately revokes it. Attempting to authenticate with a deleted API key will fail. Furthermore, deleting an API key is irreversible. Once an API key is deleted, it cannot be recovered. To delete an API key, click the ellipsis (…) on the API key you want to delete and select Delete.
A confirmation dialog will appear. Hit Delete to confirm the deletion.
Last modified on February 12, 2026