> For the complete documentation index, see [llms.txt](https://docs.fusion.vectra.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.fusion.vectra.ai/settings/user-management/index/api-shared-secret.md).

# API Shared Secret

## Getting Here <a href="#getting-here" id="getting-here"></a>

**Settings > API Keys**

***

## API Shared Secret Button <a href="#api-shared-secret-button" id="api-shared-secret-button"></a>

The **API Shared Secret** button allows administrators to view, regenerate, and manage the shared secret used for encoding and validating API keys.

***

### Fields <a href="#fields" id="fields"></a>

1. **Shared Secret**
   * **Description**: Displays the current shared secret.
   * **Purpose**:
     * Used to encode and validate API keys.
     * Ensures secure communication for API integrations.
   * **Action**:
     * **Copy Button**: Copies the shared secret to the clipboard for use in API integrations.

***

### Actions <a href="#actions" id="actions"></a>

1. **REGENERATE**
   * **Description**: Generates a new shared secret.
   * **Behavior**:
     * Invalidates all current API integrations immediately.
     * Requires updating existing API integrations to use the new shared secret.
2. **CANCEL**
   * **Description**: Closes the modal without making any changes to the shared secret.

***

### Notes <a href="#notes" id="notes"></a>

* **Regeneration Impact**:\
  Regenerating the shared secret will render all existing API keys invalid until they are updated with the new shared secret.
* **Usage**: Use the **Copy Button** to ensure accuracy when updating API integrations with the shared secret.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.fusion.vectra.ai/settings/user-management/index/api-shared-secret.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.