Create API Key

Create an API Key

  • Evoq Engage
Warning: Verify that you are at the site that will be associated with the API key before creating the key.


  • A host / super user account. Hosts have full permissions to all sites in the DNN instance.
  • Microservices must be enabled for your site.


  1. Go to Persona Bar > Content > Content Library.
    Persona Bar > Content > Content Library
  2. Go to the API Keys tab.
    API Keys
  3. Click/Tap Add New API Key.

    Add New API Key button
  4. Enter the properties of the API key.

    API key name and permissions
    1. Enter a human-friendly name for the API key.
    2. Choose the permissions to grant to the app that uses the API key.
      Note: An API key is associated with the content items of a specific site; i.e., the site that was current when the key was created.
  5. Click/Tap Create.
  6. Search for the API key in the list.

    API key list
  7. To copy the API key to your clipboard, click/tap the clipboard icon in the API Key column.

    API key list > clipboard icon

Note: Only content items or content types can be queried when using a key that is created through this method.




Please sign in to leave a comment.