- 03 Dec 2024
- 1 Minute to read
- Print
- PDF
Create an API Key
- Updated on 03 Dec 2024
- 1 Minute to read
- Print
- PDF
The API Keys feature lets you generate an API key that you can use to authenticate Qwilt API requests. Access to this feature is determined by your user permissions.
An API key is valid for up to 365 days. When it expires, it cannot be renewed. To avoid interruptions, make sure to create a new key before the expiration date.
Create a Key
To create an API key:
Navigate to the Site Delivery or Media Delivery application, and from the navigation pane, select Administration.
In the API Keys page, select Add API Key.
In the API Access Key dialog, define the key parameters.
Parameter Description Name The key name. Permission An API key grants either read-only access or read-and-write access, enabling all operations.
- Viewer: Grants access toget
andlist
endpoints.
- Editor: Grants access to all endpoints (get
,list
,create
,update
,delete
).Valid for Defines how long the API key remains valid, in days. The maximum allowed duration is 365 days. Description An optional key description, which will be displayed in the API Keys list. Select Submit. Keys require up to five minutes for propagation before they become active and are ready to use across all endpoints.
In the API Access Key dialog, download or copy the key for future use. Once you exit the API Access Key dialog, you will no longer have access to the key via the API Keys feature.
Revoke a Key
You may revoke a key at any time. Once a key is revoked, it cannot be re-enabled.
To revoke a key:
Navigate to the Site Delivery or Media Delivery application, and from the navigation pane, select Administration.
In the API Keys page, a list of all the API Keys created by users in your organization is displayed.
Hover over the key you want to revoke to display the Revoke icon.
Select the Revoke icon .
Confirm by selecting Revoke.