> For the complete documentation index, see [llms.txt](https://docs.nalpeiron.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.nalpeiron.com/zentitle2-docs/developers/licensing-and-management-apis/api-versioning.md). # API Versioning Learn how Zentitle2's date-based API versioning works and how to select or check the API version used in a request. ## Versioning Strategy Our APIs utilize date-based versioning to identify the version with the specific date on which they were released. Our initial API version for both the Licensing and Management APIs is **2024-01-01**. However, both of these APIs are being versioned independently. The new version is introduced when a **backward-incompatible** change is made to the API. We consider the following changes to be **backward-compatible**: * Adding new API resources and API methods * Adding new optional request parameters to the existing API methods * Adding new properties to the existing API responses * Changing the order of properties in the existing API responses ## Selecting the API version When making an HTTP request to the API, the API version can be specified via the '**N-Api-Version'** **header** or the '**n-api-version' query parameter**. If the API version is not specified in the HTTP request, the [**default API version**](#default-api-version) is used instead. Inspect the '**N-Api-Version'** response header to verify which version of the API has been used when processing the API request. ### Default API Version The initial API call made from your account sets the default API version to the latest stable version available at that moment. To see and edit the default API versions for both the Management and the Licensing API, visit the **API Credentials** page. ## Changelog * [Licensing API](https://license.nalpeiron.io/docs#section/Changelog) * [Management API](https://api.nalpeiron.io/docs#section/Changelog) --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.nalpeiron.com/zentitle2-docs/developers/licensing-and-management-apis/api-versioning.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.