To work with the Management API, send your requests over HTTPS and authenticate using the Authorization header in the following format: Authorization: Bearer <YOUR_API_KEY>.

We offer a .NET SDK available as the Kentico.Kontent.Management NuGet package to help interact with the API. However, no SDK is required to use the API.

The state of the Management API may change in the future, however, the majority won't be breaking changes. To help you create more robust scripts and integrations, we've prepared a list of general changes to the API that we don't consider breaking. We recommend you read through the list to ensure you don't rely on a state that might change in the future.

In general, the non-breaking changes include adding functionality or changes in order of the returned data. More specifically, the following are NOT breaking changes:

• General:
  • Add a new endpoint.
  • Change the API behavior to fix a bug in the service.
  • Change rate limitation.
  • Change error message text.
• Responses:
  • Add a new property to JSON objects.
  • Change the order of JSON object properties.
  • Add a new type of element for content types or snippets.
  • Add a new HTML element to rich text elements.
  • Add a new attribute to HTML element in rich text elements.
  • Add a new value to HTML element attribute in rich text elements.
  • Change the order of HTML element attributes in rich text elements.
  • Represent some characters as HTML entities.
  • Add a new response header.
  • Add a body to a request that contained none.
• Requests:
  • Add a new optional property to JSON objects.
  • Add a new optional attribute to HTML element in rich text elements.
  • Add a new value to the HTML element attribute in rich text elements.
  • Add a new optional request header.
  • Add a new optional query string parameter.
  • Add an optional body to request that contained none.

The Management API returns standard HTTP status codes to indicate success or failure of a request. In general, status codes in the 2xx range indicate a successful request, status codes in the 4xx range indicate errors caused by an incorrect input (for example, providing incorrect API key), and status codes in the 5xx range indicate an error on our side.

For troubleshooting failed requests, the API provides error messages defined in a consumable format to help you identify and fix the issue.

If you cannot identify and resolve an issue with your API call, you can contact us with the response status and the request ID you get in the error response.

By default, the API keys for the Management API are valid for 4,000 days. The scope of the API keys is per project per user. This means you need a separate API key for each of your projects.

The API key inherits the identity of the user who generated it. Operations performed with the key will show in your version history as changes made by the specific user.

If you regenerate the API key before its expiration date, the system will revoke the previous API key after a short while. For requests made with a revoked API key, you'll receive the 403 Unauthorized error response.

JSON
{
    "request_id": "800000c0-0001-fc00-b63f-84710c7967bb",
    "error_code": 7,
    "message": "The provided API key was revoked. You can find a valid API key for this project in the Kentico Kontent app."
}

Rate limits specify the number of requests you or your application can make to the Management API within a specific time window. There are three separate time windows (second, minute, hour) allowing a different number of requests each.

By default, the Management API enforces the following rate limits:

• 10 requests per second
• 400 requests per minute
• 15000 requests per hour

These limits apply to each API key for the Management API.

When you reach the limit of a specific time window, the API will reject the request and respond with the 429 HTTP error.

JSON
{
    "request_id": "80000004-0002-fd00-b63f-84710c7967bb",
    "error_code": 10000,
    "message": "API rate limit exceeded. Please retry your request later."
}

The error response will include the Retry-After header that tells you how many seconds you need to wait before attempting further requests. Each failed request is perfectly safe to retry.

If you begin to receive 429 HTTP errors, reduce the frequency of your requests.

References identify objects within your project. For example, you can use references to specify content types, content items, languages, and more.

When specifying references to objects, the object can be identified by one of three properties:

1. Its internal ID, such as 18b43cc5-f4fd-0172-842b-3ae2c878cf6f
   • Generated by the system automatically.
   • Unique per object type such as content item, content type, and other.
   • Can be used to specify any object.
2. Its codename, such as object_codename
   • Initially generated from the object's display name.
   • Unique per object type such as content item, content type, and other.
   • Can be used to specify most objects.
3. Its external ID, such as custom-object-identifier
   • Specified manually when creating the object through the Management API. The external ID cannot be changed later.
   • Unique per object type and its subtype such as content type and its content elements, or multiple choice element and its options.
   • Can be used to specify user-created assets, content items, content types, content groups, elements, languages, taxonomy groups, and taxonomy terms.

The API uses internal IDs for referencing objects. This means that the reference objects in the API responses will always use internal IDs.

By using external IDs to reference other objects in your project, you can import your content in the order you prefer. For example, when importing multiple articles that contain images, you can reference these images with external IDs, such as roaster or coffee-cup, before uploading them. The referenced images will be visible in the UI only after you add them as assets via the Management API. With this approach, you can choose whether you want to create content items first and then upload binary files for assets, or vice versa.

This means you can use external IDs to reference objects that don't yet exist in the project and add the objects via the API later. References to non-existent objects will be stored and retrieved via the Management API as internal IDs.

To check whether your project contains any references to not-yet-created objects, see how to validate project content.

Missing objects in the UI

If you use external IDs to reference non-existent objects in your elements, the referenced objects won't be shown in the UI. This is because the system cannot find those objects. The referenced assets and content items will be displayed after you create them with their specific external IDs via the Management API.

To add the missing objects, see:

• Upsert a content item to create content items specified by external IDs.
• Upsert an asset to create assets specified by external IDs.

To manage content items via the Management API, you need to send requests to URIs based on the following patterns:

• Using internal IDs: <base_URL>/items/<content_item_id>
• Using codenames: <base_URL>/items/codename/<content_item_codename>
• Using external IDs: <base_URL>/items/external-id/<content_item_external_identifier>

To retrieve language variants of a specific content item, you can list the variants by specifying the internal ID, codename, or external ID of the content item.

The content item object contains metadata about your content, such as the name of the content item and when the item was last modified. The content item object does not store the content itself. The content for each language variant of a content item is saved in language variants, with each content item having as many variants as there are active languages in your project.