icon-unified.svg
Experience Center

Managing Digital Experience Monitoring API Keys

After your API subscription is enabled, the API Key Management page is accessible to an admin role. From there, the admin can provision and display available API keys.

The API Key Management page allows you to perform the following actions:

  • The Create API Key action allows you to create API keys that are assigned to an admin role. An API key must be created for authentication to make API calls.

    To create a new API key:

    1. Go to Administration > API Configuration > Legacy API > Digital Experience API.
    2. Click Create API Key.
    3. Enter the required information:
    • Name: Enter the API key name.
    • Select Role: Select an admin role to be assigned the API key.

    Create API key

    1. Click Create Key to confirm and the API Key window pops up.
    2. Click Copy to copy the API Key ID or Key Secret, or click Download to download the JSON file. You need both the API Key ID and Key Secret for authentication.

    Copy API Key ID or Secret or Download API Key

    1. Close the window.
    Close

  • The View action allows you to copy either the API Key ID or Key Secret or download a JSON file of the API key.

    To view a specific API key:

    1. Go to Administration > API Configuration > Legacy API > Digital Experience API.
    2. Click the View icon for a specific API key to open the API Key window.
    3. You can:
    • Copy the API Key ID.
    • Copy the API Key Secret.
    • Download a JSON file of the API key.

    View the API Key window to copy API Key information or download a JSON file.

    Close

  • The Edit action allows you to edit the API key name or reassign the key to another role.

    To edit a specific API key:

    1. Go to Administration > API Configuration > Legacy API > Digital Experience API.
    2. Click the Edit icon for a specific API key to open the Edit API Key window.
    3. Edit the Name or Select Role.
    4. Click Save to confirm the changes.

    Edit the API key name or role.

    Close

  • The Delete action allows you to delete the specified API key.

    To delete a specific API key:

    1. Go to Administration > API Configuration > Legacy API > Digital Experience API.
    2. Click the Delete icon for a specific API key to open the Delete API Key window.
    3. Click Delete to confirm the deletion.

    Delete API Key

    Close

To learn more, see About API Key Management.

Related Articles
About API Key ManagementManaging Digital Experience Monitoring API Keys