This article is also available in:

Create and manage API Keys

Create and manage API Keys


Summary


Flokzu allows you to create and manage multiple API Keys to consume services from the public API from external systems. Each API Key will have a name, description, expiration date (optional), and specific permissions based on the endpoints it grants access to.


This feature allows you to separate and limit access to the public API by integration, application, provider, or use case, enabling the use of more controlled, auditable credentials aligned with security best practices.


Before you start


Before creating an API Key, check the following:


  • You must be an organization administrator.
  • You must know which endpoints the integration will need to consume.
  • If it will provide access to instances, identify the corresponding processes.
  • If it will provide access to databases, identify the corresponding databases.
  • If the key will expire, define the expiration date.
  • Keep in mind that the key will be shown only once.


For security reasons, Flokzu shows the API Key value only once; when it is created.


Step by step


View existing API Keys


  1. Go to Settings > Advanced > API Keys.
  2. Select View API-Keys.
  3. The organization’s API Keys list will open.


In the list, you will see information such as:


Information

Description

Name or alias

API Key identifier.

Creation date

Date when it was created.

Expiration

Expiration date or indication that it does not expire.

Last use

Date when it was last used.

Scopes

Permissions assigned to the key.

Status

Active, revoked, or expired.



Create a new API Key


  1. From the API Keys list, select Create new API Key.
  2. Enter a name or alias to identify it.
  3. Add a description if you need to document what it will be used for.
  4. Define whether the key will have an expiration date or no expiration.
  5. Configure the permissions or scopes.
  6. Select the resource types:
  • Instances
  • Databases
  • User management
  1. Select the allowed endpoints for that resource type.
  2. If applicable, select the processes or databases the key will have access to.
  3. Generate the API Key.
  4. Copy and store the key in a secure location.







Save the API Key before closing the creation screen. Flokzu will not show it again, and it will not be possible to recover it from the platform.


Edit an API Key


  1. Go to the API Keys list.
  2. Find the API Key you want to modify.
  3. Select Edit.
  4. Modify the data.
  5. Save the changes.


Revoke an API Key


  1. Go to the API Keys list.
  2. Find the key you want to revoke.
  3. Select Revoke.
  4. Confirm the action.


When an API Key is revoked:


  • It stops working immediately - integrations using it will no longer be able to authenticate correctly.
  • It cannot be reactivated.
  • If you need to restore access, you must create a new API Key.


Before revoking an API Key, check which integration is using it. Revocation will interrupt API calls that use that key.


API Key expiration


The expiration date is optional. If you define an expiration date, Flokzu will automatically invalidate the API Key when that date is reached.


Before and at the time of expiration, administrators will receive email notifications.


When an API Key expires:


  • Its status changes to Expired.
  • Integrations using it will no longer be able to authenticate correctly.
  • To restore access, you must create a new API Key or use an active one with the required permissions.


Activity audit


Actions performed on API Keys are recorded in the activity audit and can be reviewed by administrators.


This includes:


  • Creation.
  • Editing the description or scopes.
  • Revocation.
  • Expiration.



Updated on: 24/06/2026

Was this article helpful?

Share your feedback

Cancel

Thank you!