---
updatedAt: 2026-07-28T19:57:20.000Z
---

# Get a maintenance schedule

Get a maintenance schedule using its identifier.<br><br><a href="https://api.solace.dev/cloud/reference/authentication">Token Permissions</a>: [ <code>maintenance_schedules:read</code> ]

# 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/maintenanceSchedules/{maintenanceScheduleId}": {
      "get": {
        "tags": [
          "Maintenance Schedules"
        ],
        "summary": "Get a maintenance schedule",
        "description": "Get a maintenance schedule using its identifier.<br><br><a href=\"https://api.solace.dev/cloud/reference/authentication\">Token Permissions</a>: [ <code>maintenance_schedules:read</code> ]",
        "operationId": "getMaintenanceSchedule",
        "parameters": [
          {
            "name": "maintenanceScheduleId",
            "in": "path",
            "description": "The unique identifier of the maintenance schedule.",
            "required": true,
            "schema": {
              "minLength": 1,
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MaintenanceScheduleResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad request.",
            "content": {
              "application/json": {}
            }
          },
          "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/ErrorResponse"
                },
                "example": {
                  "message": "You do not have permissions to perform this operation.",
                  "errorId": "618e2fb0-a198-4d9d-9219-13e51ef0ecec"
                }
              }
            }
          },
          "404": {
            "description": "Not found.",
            "content": {
              "application/json": {}
            }
          },
          "502": {
            "description": "Bad Gateway - Marketplace integration error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        }
      }
    }
  },
  "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']"
          }
        }
      },
      "MaintenanceSchedule": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The unique identifier of the maintenance schedule."
          },
          "maintenanceType": {
            "type": "string",
            "description": "The type of maintenance schedule. <ul>\n\n<li>DATA_PATH: Maintenance affecting resources responsible for data operations, such as event broker services.</li>\n\n<li>CONTROL_PLANE: Maintenance affecting resources responsible for environment operations, such as the Mission Control Agent.</li>\n\n</ul>",
            "enum": [
              "DATA_PATH",
              "CONTROL_PLANE"
            ]
          },
          "environmentId": {
            "type": "string",
            "description": "The identifier of the environment the maintenance schedule belongs to."
          },
          "organizationId": {
            "type": "string",
            "description": "The identifier of the organization the maintenance schedule belongs to."
          },
          "createdBy": {
            "type": "string",
            "description": "The identifier of the user who created the maintenance schedule."
          },
          "createdTime": {
            "type": "string",
            "description": "When the maintenance schedule was created.",
            "format": "date-time"
          },
          "type": {
            "type": "string",
            "description": "The type of object for informational purposes."
          }
        }
      },
      "MaintenanceScheduleResponse": {
        "type": "object",
        "properties": {
          "data": {
            "$ref": "#/components/schemas/MaintenanceSchedule"
          },
          "meta": {
            "type": "object",
            "additionalProperties": {
              "type": "object",
              "description": "<p>The metadata about the response, which can include:</p><ul><li>Pagination data, such as page number, page size, etc. for GET operations that return large amount of response data. For more information, see <a href=\"./pagination\">Pagination</a>.</li><li>Timestamp information, such as current time, or the time create or update operation occurred for CREATE, PUT, POST operations.</li></ul>"
            },
            "description": "<p>The metadata about the response, which can include:</p><ul><li>Pagination data, such as page number, page size, etc. for GET operations that return large amount of response data. For more information, see <a href=\"./pagination\">Pagination</a>.</li><li>Timestamp information, such as current time, or the time create or update operation occurred for CREATE, PUT, POST operations.</li></ul>"
          },
          "included": {
            "type": "array",
            "items": {
              "type": "object"
            }
          }
        }
      }
    },
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    }
  }
}
```