API key management

Manage API keys

You can create and manage your API keys in Project settings > API keys. The list of API keys shows you the API keys you can access.

Delivery API keys

• Get published content from environments with secure access enabled. If secure access is disabled, your content is publicly accessible without an API key.
• Preview the latest content from environments. You always need an API key to preview content.

Management API keys

• With Management API keys, you’ll see the API key’s name.
• With Personal API keys, you’ll see the API key’s owner name.

Who can manage API keys?

• Delivery API keys are managed by project managers. Project managers can specify additional users who can view the API key value.
• Management API keys are managed by project managers. Project managers can specify additional users who can view the API key value.
• Personal API keys are managed by their owners. These can be project managers and users with the Create a personal API key permission. Project managers can revoke other users’ personal API keys, but cannot see the API key value.

Create Delivery API keys

1. In Project settings > API keys > Delivery API keys, click Create Delivery API key.
2. (Optional) In Expiration date, choose when you want the API key to expire. By default, the API key expires in one year.
3. In Name, type the name of the API key.
4. (Optional) In Users with access to this API key, allow specific users to view and copy the API key. By default, all project managers can view the API key.
5. In Delivery API access, specify the access granted by the API key.
   • For retrieving published content from environments with secure access enabled, select Secure access.
   • For previewing the latest and unpublished content, select Content preview.
6. In Limitations, adjust the API key scope to specific environments.
7. Click Save changes.
8. In API key, click to copy the API key value.

Create Management API keys

1. In Project settings > API keys > Management API keys, click Create Management API key.
2. (Optional) In Expiration date, choose when you want the API key to expire. By default, the API key expires in six months.
3. In Name, type a human-friendly name describing the API key’s purpose. For example, Translation management or Team notifications.
4. (Optional) In Users with access to this API key, allow specific users to view and copy the API key. By default, only project managers can view the API key.
5. In Limitations, adjust the API key scope to specific environments.
6. In Permissions, select at least one permission for the API key.
7. Click Save changes.
8. In API key, click to copy the API key value.

Management API key permissions

• Get content items.
• Get content item variants.
• Validate content

• Add content items.
• Change workflow of content item variants.
• Create new versions of content item variants.
• Delete content items.
• Delete content item variants.
• Publish, schedule, and unpublish content item variants.
• Upsert content items.

• Get assets.
• Get asset folders.
• Get asset renditions of an asset.

• Add assets and files.
• Add asset folders.
• Add asset renditions.
• Delete assets.
• Delete asset folders.
• Modify asset folders.
• Modify asset renditions.
• Upsert assets.

• Add, get, modify, and delete content types.
• Add, get, modify, and delete content type snippets.
• Add, get, modify, and delete taxonomy groups.

• Add, get, and modify languages.
• Add, get, modify, and delete spaces.
• Get and modify collections.
• Get and modify preview URLs.
• Add, get, and delete webhooks.
• Add, get, and delete legacy webhooks.
• Add, get, modify, and delete workflows.

• Clone environments.
• Delete environments.
• Get information about environments and their cloning status.
• Mark environments as production.
• Rename environments.

Create Personal API keys

1. In Project settings > API keys > Management API keys, click Create Personal API key.
2. (Optional) In Expiration date, choose when you want the API key to expire. By default, the API key expires in six months.
3. Click Save changes.
4. In API key, click to copy the API key value.

Set API key expiration

• For Management API keys, the default expiration length is six months. The expiration length can vary from 1 minute to 2 years.
• For Delivery API keys, the default expiration length is one year. The expiration length can vary from 1 minute to 5 years.

Regenerate API keys

• You suspect unauthorized API key usage, for example, after a user leaves your company. In such cases, switch to a new API key in your apps and regenerate your existing API key.
• Users are removed from your project’s environment or subscription. Depending on the user’s access level, you might want to regenerate the shared Delivery API keys.
• You receive a notification about an upcoming expiration of your API key.

1. In Project settings > API keys.
2. On either the Delivery API keys or Management API keys tab, choose an API key to view its details.
3. In API key, click .

Revoke API keys

When you revoke an API key, the API key becomes invalid and is removed from the list of API keys. The revocation process can take up to a couple of minutes. Any requests made with a revoked API key result in the 401 Unauthorized error.

1. In Project settings > API keys.
2. On either the Delivery API keys or Management API keys tab, choose an API key to view its details.
3. Click Revoke.
4. In the confirmation dialog, click Revoke.

• Docs
• Account
• APIs
• Architecture
• AI accelerators
• Assets
• Collections
• Content items
• Content model
• Custom elements
• Innovation Lab
• Environments
• Keyboard shortcuts
• Languages
• Mission Control
• Preview
• Projects
• Security
• Spaces
• Subscriptions & Payments
• Task management
• Terminology
• Users & Roles
• Web Spotlight
• Webhooks
• Workflows & Publishing

• APIs overview
• API keys
• Custom elements JS API
• Delivery REST API
• Delivery GraphQL API
• Image transformation API
• Management API v2
• Subscription API
• Sync API

• Web
• Privacy policy
• Cookies policy
• Consent settings
• Security
• GDPR

• Management API keys with a static set of customizable permissions. Use unique Management API keys when integrating with third-party services or for continuous usage in production.
• Personal API keys with a dynamic set of inherited permissions. The API key has the same permissions as its owner. Use personal API keys in your personal projects for testing. Don’t share your personal API keys with anyone else.

• If the expiration date is less than a day apart from the API key's creation date, the email notification is sent immediately.
• If the expiration date is between 1–7 days apart form the API key's creation date, the email notification is sent 1 day before the expiration date.
• If the expiration date is more than a week apart from the API key's creation date, the email notification is sent 1 week before the expiration date. 

• Explore Kontent.ai’s API landscape and manage your API keys securely.