Create API keys

API keys are used to request a token to authenticate with the CMS (SaaS) REST API.  To create an API key with code, see Create API Client.

You can add one or more keys if you have the name. Keys display in the list at the bottom of the API Keys page.

1. Go to Settings > API Keys in your CMS (SaaS) instance.

2. Click Create API Key.

   
   • Address – The URL or endpoint where the API can be accessed. It is the location on the web where requests are sent to interact with the API.
   • Single key – A unique identifier that authenticates a client making a request to an API. It is often a token or string that grants access to the API's services or data, ensuring that only authorized users or applications can interact with the API.
   • App key – A publicly exposed string that is used by the server to identify the application making the request. The App key associates API requests with your application.
   • Secret – A secret known only to the application and the authorization server to authenticate the identity of the application to the authorization server when the application requests to access a protected resource. 

3. Enter a Name and click Create API Key. The Name can only contain letters, numbers, hyphens, and underscores.

   

4. Save the Client ID and Secret that automatically populate in a secure location.

   🚧

   Important

   You cannot view the Client ID and Secret again after you close the Save your Secret window, so ensure you save them to use later.

   
   

5. Click Done.

You can restrict what operations the API Key can execute. See the Authorization section.