Preview the breaking changes between two versions
const url = 'http://localhost:8000/cluster-types/keycloak/upgrade-preview';
const options = {
method: 'GET',
headers: {'API-Version': '2026-06-01.beta', 'API-Key': '<API-Key>'}
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}curl --request GET \
--url http://localhost:8000/cluster-types/keycloak/upgrade-preview \
--header 'API-Key: <API-Key>' \
--header 'API-Version: 2026-06-01.beta'Returns the breaking changes recorded between from (exclusive) and to (inclusive) for the given cluster type. Both query parameters are required and must be version numbers such as 26.4.0; a missing or malformed one returns 400.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Query Parameters
Section titled “Query Parameters”Version the upgrade starts from, exclusive. Required.
Version the upgrade ends at, inclusive. Required.
Header Parameters
Section titled “Header Parameters”Responses
Section titled “Responses”The request has succeeded.
A breaking change recorded for a version of a cluster type, taken from the product’s own migration guide.
object
Title of the change, as published in the migration guide.
Plain-language summary of what changes.
How disruptive the change is: breaking, config-change or deprecation.
Concrete steps to take before upgrading, or null when none are recorded.
Example generated
[
{
"title": "example",
"summary": "example",
"severity": "example",
"action_required": "example"
}
]The server could not understand the request due to invalid syntax.
RFC 9457 Problem Details object.
object
Example generated
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"instance": "https://example.com"
}Access is unauthorized.
RFC 9457 Problem Details object.
object
Example generated
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"instance": "https://example.com"
}The server cannot find the requested resource.
RFC 9457 Problem Details object.
object
Example generated
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"instance": "https://example.com"
}Client error
object
object
Example generated
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"instance": "https://example.com",
"errors": [
{
"field": "example",
"detail": "example",
"code": "example",
"value": "example"
}
]
}Client error
RFC 9457 Problem Details object.
object
Example generated
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"instance": "https://example.com"
}Headers
Section titled “Headers”Server error
RFC 9457 Problem Details object.
object
Example generated
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"instance": "https://example.com"
}Server error
RFC 9457 Problem Details object.
object
Example generated
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"instance": "https://example.com"
}