Help Center

Menu

API keys

Squiz DXP API keys function as secure authentication tokens. These tokens allow third-party tools to connect to and integrate with Squiz DXP.

Each API key has specific access permissions, ensuring only authorized applications can interact with specific data and functionality within the Squiz DXP.

As part of Squiz DXP Configuration, the API keys UI allows appropriately-credentialed Squiz DXP users to create, manage, edit, and delete Squiz DXP API keys.

Create a Squiz DXP API key

Navigate to the Squiz DXP Dashboard, then follow these steps:

  1. Click the Configuration card.

  2. Click the API keys card.

    The API keys page loads.

    api keys page with no keys
    Figure 1. A Squiz DXP API keys home page with no extant API keys.

  1. Click the ⊕ Create API key button.

    The Create API key page loads.

    create api key page
    Figure 2. Squiz DXP Create API key page

  2. In the Details section, enter a

    1. Name (required).

      The Name field is limited to 50 characters.

    2. Expiry date.

      Leave this field blank to create an API key with no expiry date.

      API keys with no expiry date function forever, unless deleted or disabled.

    3. Description.

      The Description field is limited to 70 characters.

  3. From the Permissions section

    1. Select the permissions to add to this key.

      For example, the screenshot following shows an API key with permission to delete existing API keys one at a time.

      This key is also set to expire at midnight on 2026-04-02.

      example api key creation
      Figure 3. An API key being created.

  4. After selecting all required permissions, click the Create button.

  5. The API key has been created dialog presents, including the API key string.

  6. Copy and securely store the displayed API key before doing anything else.

    As the dialog notes, this dialog is the only time the new API key will be displayed.

    Copy and securely store the key before doing anything else.

    The copy button immediately adjacent the API key obviates the need to select the string before copying.

  7. Click the Close button.

    The dialog closes and the new API key’s status changes to Enabled.

    As soon as an API key is created, it can be used. To prevent an API key from being used, [change-the-status-of-an-api-key].

  8. Click the Save button.

Manage Squiz DXP API keys

Extant API keys are presented as a table on the API keys page.

api keys page with keys and callouts
Figure 4. API keys home page with three extant API keys listed.

The table sorts keys in the order of creation and presents the following information and options for each key.

1 Search API keys
2 Name

  • Click this to load the edit page for that key.

    A given API key’s edit page is functionally identical to the Create API key page.

    Edits to an existing key do not, however, generate a new API key.
3 User

  • The name of the person who created the listed API key.
4 Last used

  • The date and time the API key was last used.
5 Expiry

  • The date and time the API key will stop working.

  • API keys with no expiry date function forever, unless deleted or disabled.
6 Status

  • API keys have one of two statuses: Enabled or Disabled.

  • Disabled API keys cannot be used.
7 ⋯ (Meatball menu)

  • Opening the menu:[⋯] menu for an API key presents two options: Enable/Disable and Delete.

    meatballs menu disable delete
    Figure 5. An open ⋯ menu showing the Disable and Delete menu options.

Change the status of a Squiz API key

API keys have one of two statuses: Enabled or Disabled.

To change the status of a particular API key:

  1. Click the menu:[⋯] menu for that API key.

  2. The option presented depends on the API key’s current status.

    The menu presents the Disable option for an Enabled API key and an Enabled option for a Disabled API key.

  3. Click the presented option to change the API key’s Status from disabled to enabled or from enabled to disabled.

Search for Squix DXP API keys

The Search API keys field, available above the table of API keys searches the contents of the Name fields and Permissions fields of all extant API keys.

For example, given the example API keys page presented earlier, a search on Delete returns the following:

api keys page search term delete
Figure 6. Example API Keys page after searching on the term Delete.

However, a search on COMPONENT_DELETE returns the following:

api keys page search term component delete
Figure 7. Example API Keys page after searching on the term COMPONENT_DELETE.

The first search returns all API keys with the word Delete in their name.

The second search, however, returns the only API key with permission to use COMPONENT_DELETE from the Component Service section.

This can be useful for finding and editing the details of a particular key when the API name is the primary or even sole piece of information available (for example, an API name included in a configuration file).

Edit a Squiz DXP API key

Navigate to the Squiz DXP Dashboard, then follow these steps:

  1. Click the Configuration card.

  2. Click the API keys card.

    The API keys page loads.

    api keys page with keys no callouts
    Figure 8. A Squiz DXP API keys home page with five extant API keys.

  3. Click the name of the API key to be edited.

    The name-of-api-key-here page loads.

    edit api key page
    Figure 9. Squiz DXP Edit API key page

    This page functions identically to the Create a Squiz DXP API key page.

  4. Edit values and add or remove API permissions as required.

  5. Click the Save button.

Delete a Squiz DXP API key

To delete an API key:

  1. Click the menu:[⋯] menu for that API key.

  2. Click the Delete option

    The Delete API key dialog opens.

  3. Click the Delete button to delete the API key.

    Clicking the Delete button deletes the API key instantly and permanently.

    This action cannot be undone.

  4. The API keys page refreshes and the deleted key is no longer present in the list of API keys.