# Deployment Keys ### Deployment Key Use Cases Deployment Keys are shared keys that can be used to deploy mods without requiring end-user accounts. They can be used in enterprise use cases that don't require access to privileged resources: * Embedding an authenticated iframe via the PixieBrix sidebar * Retrieving information from public APIs * Compliance/governance use cases ### Creating a Deployment Key In the [Admin Console](https://app.pixiebrix.com/), click on `Deployment Keys` in the left side nav. {% hint style="info" %} If you do not see "Deployment Keys" in the Admin Console left side nav, contact your Account Executive or {% endhint %}

Deployment Keys item in the Admin Console Side Nav

Click `+ Create Deployment Key` and name your key. The key will appear in the Deployment Keys table:

### Adding the Deployment Key to a Deployment Deployment Keys can be added to permissions groups. See [](https://docs.pixiebrix.com/deploying-mods "mention") for information on adding the key to a Group and Deployment ### Testing the Deployment Key in the Browser Extension To test the deployment key in the browser extension, open the Extension Console and change the URL to include `#/settings` to force the Extension Console to show the settings page. Or, paste one of the following URLs into your URL bar: **Chrome Web Store (Stable)** ``` chrome-extension://mpjjildhmpddojocokjkgmlkkkfjnepo/options.html#/settings ``` **Chrome Web Store (Beta)** ``` chrome-extension://mpapkmgkphbggmlekkfnoilmafnbfile/options.html#/settings ``` Scroll the Advanced Settings at the bottom of the Settings screen. Click `Clear PixieBrix Token` to disconnect/logout:

Clear the PixieBrix Token to log out if the extension is connected

Then, paste the Deployment Key:

Paste the Deployment Key into Settings > Advanced Settings

Reload the browser extension for the new settings to take effect ### Configuring Deployment Key in the Extension Configuration Policy To use the deployment key automatically at scale, include the `deploymentKey` setting in your PixieBrix Extension Configuration Policy. For more information on configuring the policy, see [browser-extension-configuration-policy](https://docs.pixiebrix.com/enterprise-it-setup/browser-extension-installation-and-configuration/browser-extension-configuration-policy "mention") | Name | Type | Data | | ------------- | ------- | ------------------------------ | | deploymentKey | REG\_SZ | The deployment key you created | ### Frequently Asked Questions (FAQs) #### Are deployment keys secure? As a shared secret, deployment keys are best reserved for use cases that don't have access to privileged resources. --- # Agent Instructions: 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.pixiebrix.com/deploying-mods/deployment-keys.md?ask= ``` 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.