---
updatedAt: 2026-07-28T19:57:20.000Z
---
# Get the upgrade readiness for an event broker service
Get the upgrade readiness for an event broker service using the service’s unique identifier. You can optionally define other properties to specify the maintenance window and time.
Token Permissions: [ event_broker_versions:get ]
# OpenAPI definition
```json
{
"openapi": "3.0.1",
"info": {
"title": "MISSION CONTROL",
"description": "Documentation for Mission Control API",
"version": "2.2.1"
},
"servers": [
{
"url": "https://api.solace.cloud",
"description": "Solace Cloud US EAST Region"
},
{
"url": "https://api.solacecloud.com.au",
"description": "Solace Cloud AU Region"
},
{
"url": "https://api.solacecloud.eu",
"description": "Solace Cloud EU Region"
},
{
"url": "https://api.solacecloud.sg",
"description": "Solace Cloud SG Region"
}
],
"security": [
{
"bearerAuth": []
}
],
"paths": {
"/api/v2/missionControl/eventBrokerServices/{serviceId}/upgradeReadiness": {
"get": {
"tags": [
"Event Broker Upgrade Readiness"
],
"summary": "Get the upgrade readiness for an event broker service",
"description": "Get the upgrade readiness for an event broker service using the service’s unique identifier. You can optionally define other properties to specify the maintenance window and time.
Token Permissions: [ event_broker_versions:get ]",
"operationId": "getUpgradeReadiness",
"parameters": [
{
"name": "maintenanceWindowId",
"in": "query",
"description": "The specific maintenance window you want to get event broker service upgrade readiness for. You must specify the maintenanceTimeOrdinal parameter when defining this parameter.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "maintenanceTimeOrdinal",
"in": "query",
"description": "The time range of the maintenance window you want to get event broker service upgrade readiness for. You must specify the maintenanceWindowId parameter when defining this parameter.",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "serviceId",
"in": "path",
"description": "The unique identifier of the event broker service.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/upgradeReadinessResponse"
}
}
}
},
"400": {
"description": "Bad Request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"message": "An authentication error occurred.",
"errorId": "618e2fb0-a198-4d9d-9219-13e51ef0ecec"
}
}
}
},
"403": {
"description": "Forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/upgradeReadinessResponse"
}
}
}
},
"404": {
"description": "Not found.",
"content": {}
},
"409": {
"description": "Conflict.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/upgradeReadinessResponse"
}
}
}
},
"422": {
"description": "Unprocessable content.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/upgradeReadinessResponse"
}
}
}
},
"429": {
"description": "Too many requests.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/upgradeReadinessResponse"
}
}
}
},
"502": {
"description": "Bad Gateway - Marketplace integration error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"503": {
"description": "Service unavailable.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/upgradeReadinessResponse"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"ErrorResponse": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "A user-friendly message that describes the error.",
"example": "An error occurred."
},
"errorId": {
"type": "string",
"description": "The UUID (Universally Unique Identifier) that is logged with an appropriate stack trace for a WARN or ERROR log that allows support to better determine what cause the error.",
"example": "123e4567-e89b-12d3-a456-426655440000"
},
"meta": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "The metadata about the error. This provides additional information about the error that occurred.",
"example": "'object': { 'field': 'description' }"
},
"description": "The metadata about the error. This provides additional information about the error that occurred.",
"example": "'object': { 'field': 'description' }"
},
"validationDetails": {
"type": "object",
"additionalProperties": {
"type": "array",
"description": "When applicable, these are the details of issues with the fields provided for the REST call.",
"example": "'name': ['Not unique']",
"items": {
"type": "string",
"description": "When applicable, these are the details of issues with the fields provided for the REST call.",
"example": "'name': ['Not unique']"
}
},
"description": "When applicable, these are the details of issues with the fields provided for the REST call.",
"example": "'name': ['Not unique']"
}
}
},
"UpgradeReadiness": {
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/UpgradeReadinessStatus"
},
"message": {
"type": "string",
"description": "Describes the status of the upgrade readiness check."
},
"jobExpiryInMinutes": {
"type": "integer",
"description": "Describes the job expiry time in minutes.",
"format": "int64"
}
}
},
"UpgradeReadinessStatus": {
"type": "string",
"description": "Indicates the status of the upgrade readiness.",
"enum": [
"OK",
"UNAVAILABLE"
]
},
"upgradeReadinessResponse": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/UpgradeReadiness"
},
"meta": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
}
},
"securitySchemes": {
"bearerAuth": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT"
}
}
}
}
```