Skip to main content
Browse Documentation

Create an API key

Created by Contensis product team, last modified by r.saunders on 30 Mar 2021

If you want to use the Delivery API outside of a Contensis published site, or use the Management API, you'll need to generate an API key. Only users within the API Key Administrators security group can create API keys.

To create an API key:

  1. Press the Settings button in the sidebar. The Settings menu will open, revealing a number of options.
  2. Select API keys to open the API Keys list.
  3. Press New API Key. The Create a new API key window will be displayed.
  4. Give the API key a name by filling in the Name field. Provide a description to help other administrators understand what the key is used for by populating the Description field.
  5. By default all new keys are enabled – use the toggle button to disable the key if required.
  6. Press Create API Key. The key will be generated and the API Keys list will display your new key.

Note: Once an API key has been created it needs to be assigned to a role to grant permission to the resources you want it to have access to.

Necessary Cookies
These cookies are necessary for this website to function correctly. They are set when you perform certain actions on the site, such as creating an account, logging in, changing your privacy preferences or submitting a form. You can block these cookies in your browser, but this will stop parts of the site from working properly.
Functional Cookies
These cookies allow the website to provide extra functionality and more personalised experiences. They may be set by us or by third party providers whose services we have added to our pages. If you choose not to allow these cookies, these services may not work correctly.
Analytical Cookies
These cookies record anonymous data on how visitors use our website to help us monitor how well our website works. This data includes how many people have looked at specific pages, how long visitors stay on the site, and what devices they use. We use this data to identify changes that we could make to improve your experience and make our website more efficient.
Marketing Cookies
We set some cookies so you are shown more relevant marketing content. These include cookies from third-party advertising networks to show you different adverts on their services if you have previously visited our site. If you choose not to allow these cookies, you may experience less relevant advertising on other sites.