Secrets

​

Overview

​

Navigating the Secrets Settings Menu

To access the Secrets section:

1. Click on the Settings icon in the main navigation sidebar.
2. Select Secrets from the vertical navigation drawer on the left.
3. The Secrets management interface will display in the main content area.

Main Components The Secrets section interface includes the following key elements:

• Search Field: Located in the header, allows you to filter secrets by name
• + Button: Creates new secret entries (visible when you have secret creation permissions)
• Secrets Table: Displays all project secrets with columns for Name, Value, and Actions
• Pagination Controls: Located at the bottom of the table for navigating through secrets lists (supports 5, 10, 50, or 100 secrets per page)
• Action Icons: Show/Hide, Edit, and Delete options for individual secret management

​

Secrets Table

The Secrets section displays a table with the following information for each secret:

• Name: The identifier for the secret (cannot be edited after creation)
• Value: The masked secret value (displayed as hidden by default for security)
• Actions: Show/Hide, Edit, and Delete options for managing secrets

​

Creating a Secret

To add a new secret to your project:

1. Click the + button in the top-right corner of the Secrets section.
2. A new editable row will appear at the current pagination position:
   • Enter a unique name for the secret in the Name field
   • Enter the secret value (password, token, API key, etc.) in the Value field
3. Click the ✓ (checkmark) icon to save the secret, or click the ✗ (close) icon to cancel.

​

Managing Secrets

The Secrets table provides several actions for managing your configured secrets:

​

Viewing Secrets

To reveal a secret’s value:

1. Click the 👁 (eye) icon in the Actions column.
2. The secret value will be revealed in place of the masked value.
3. Click the 👁‍🗨 (eye with slash) icon to hide the secret value again.

​

Copying Secrets

To copy a secret value to your clipboard:

1. Click the masked secret value in the Value column.
2. The secret will be automatically copied to your clipboard.

​

Editing Secrets

To update a secret’s value:

1. Click the ⋮ (three dots) icon in the Actions column.
2. Select Edit value from the menu.
3. The Value field becomes editable (the Name field cannot be edited).
4. Enter the new secret value.
5. Click the ✓ (checkmark) icon to save, or click the ✗ (close) icon to cancel.

​

Hiding Secrets

To permanently hide a secret from the UI:

1. Click the ⋮ (three dots) icon in the Actions column.
2. Select Hide from the menu.
3. In the confirmation dialog, type the secret name to confirm.
4. Click Confirm to hide the secret.

What Happens When You Hide a Secret:

• UI Removal: The secret is completely removed from the Secrets table and will no longer be visible in the interface
• Dropdown Availability: Hidden secrets will not appear in the secret selection dropdown when creating or editing credentials
• Existing Credentials: Credentials that already reference the hidden secret continue to function normally - the secret value continues to be used as a password for authentication

​

Deleting Secrets

To remove a secret from the project:

1. Click the ⋮ (three dots) icon in the Actions column.
2. Select Delete from the menu.
3. In the confirmation dialog, type the secret name to confirm deletion.
4. Click Delete to confirm, or Cancel to abort.

What Happens When You Delete a Secret:

• Complete Removal: Both the secret and its value are permanently deleted from the system
• Existing Credentials Affected: All credentials referencing the deleted secret will fail authentication immediately
• Cannot Be Recovered: Deletion is permanent and cannot be undone

​

Hide vs Delete: Understanding the Difference

It’s important to understand the distinction between hiding and deleting secrets, as they have different impacts on your credentials and integrations:

​

Using Secrets in Credentials

Secrets can be referenced in credentials to securely store authentication details for integrations and toolkits. This approach provides centralized management and enhanced security compared to storing values directly in each credential. When creating or editing a credential:

1. Navigate to the Credentials page from the main navigation.
2. Create a new credential or edit an existing one.
3. For authentication fields (tokens, API keys, passwords), toggle between:
   • Password: Direct value entry (plain text)
   • Secret: Select from existing secrets dropdown
4. Select your desired secret from the dropdown.

​

Best Practices

Hide Before Delete

Before deleting a secret, consider hiding it first to prevent new usage while verifying that removing it won’t break existing integrations. Once you’ve confirmed no active credentials depend on it, you can proceed with deletion.

Use Descriptive Secret Names

Choose clear, descriptive names for your secrets that indicate their purpose and where they’re used. For example, use names like github_api_token or database_password_production rather than generic names like token1 or secret2.

Avoid Copying Secrets with Trailing Spaces

When copying secret values, ensure no trailing spaces or hidden characters are included. Use the copy functionality provided in the interface rather than manually selecting and copying text to avoid formatting issues.

Regular Secret Rotation

Periodically rotate sensitive credentials to maintain security. Update secret values when team members leave, after suspected compromises, or according to your organization’s security policies.

Verify Secret Access Before Deletion

Before deleting a secret, verify that it’s not being used by any agents, toolkits, or other components in your project. Deleting an active secret may cause functionality issues.

Document Secret Usage

Maintain documentation about which secrets are used by which components or integrations. This helps prevent accidental deletion and makes troubleshooting easier.