--- updatedAt: 2026-07-28T19:57:20.000Z --- # (Beta) Update a connection endpoint Update a connection endpoint for a given event broker service.

Token Permissions: [ mission_control:access or service_connection_endpoint:put ] # 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": [] } ], "tags": [ { "name": "Connection Endpoints", "description": "APIs for managing the connection endpoints of event broker services." } ], "paths": { "/api/v2/missionControl/eventBrokerServices/{serviceId}/connectionEndpoints/{connectionEndpointId}": { "patch": { "tags": [ "Connection Endpoints" ], "summary": "(Beta) Update a connection endpoint", "description": "Update a connection endpoint for a given event broker service.

Token Permissions: [ mission_control:access or service_connection_endpoint:put ]", "operationId": "updateConnectionEndpoint", "parameters": [ { "name": "serviceId", "in": "path", "description": "The unique identifier of the event broker service.", "required": true, "schema": { "type": "string" } }, { "name": "connectionEndpointId", "in": "path", "description": "The unique identifier of the connection endpoint.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateConnectionEndpoint" } } }, "required": true }, "responses": { "202": { "description": "Accepted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "Unauthorized response": { "description": "The response for unauthorized requests.", "value": { "message": "Your permissions have changed.", "subCode": "4000_215", "errorId": "10238f1c3fb677ac", "traceId": "10238f1c3fb677ac" } } } } } }, "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": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "message": "Could not find the connection endpoint with id 4o5kyf4x5504.", "errorId": "618e2fb0-a198-4d9d-9219-13e51ef0ecec" } } } }, "409": { "description": "Conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "message": "A job is already in progress for this service", "errorId": "550e8400-e29b-41d4-a716-446655440002" } } } }, "502": { "description": "Bad Gateway - Marketplace integration error.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Service Unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": "Gateway Timeout", "message": "Timeout waiting 28000 ms for.... " } } } } } } } }, "components": { "schemas": { "ConnectionEndpointAccessType": { "type": "string", "description": "The connectivity for the connection endpoint. This can be through private IP addresses (PRIVATE) or public internet (PUBLIC).\nFor event brokers deployed to self-managed containers, only PRIVATE is supported: public ingress is not provided, so reaching the event broker from the internet must be arranged on your own network. PUBLIC is rejected for those services.\n", "example": "PUBLIC", "enum": [ "PUBLIC", "PRIVATE" ] }, "CreationState": { "type": "string", "description": "The creation state of the connection endpoint.", "readOnly": true, "enum": [ "pending", "inProgress", "completed", "failed", "migrating", "waitingForDeployment" ] }, "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']" } } }, "Link": { "type": "object", "properties": { "href": { "type": "string", "description": "The location of the related resource, relative to the API root.", "readOnly": true, "example": "/api/v2/missionControl/eventBrokerServices/abc123/deploymentInstructions" } }, "description": "A link to a related resource.", "readOnly": true }, "Operation": { "type": "object", "properties": { "id": { "type": "string", "description": "Operations requiring time to complete provide an operation identifier so you can query their progress." }, "type": { "type": "string", "description": "The type of object for informational purposes.", "readOnly": true, "example": "operation" }, "operationType": { "$ref": "#/components/schemas/jobOperationTypes" }, "createdBy": { "type": "string", "description": "The unique identifier representing the user who created the operation." }, "createdTime": { "type": "string", "description": "The time the operation was created, in ISO 8601 date/time format.", "example": "2022-03-14T15:01:34.000Z" }, "completedTime": { "type": "string", "description": "The completion time, whether it was successful or failed, in ISO 8601 date/time format.", "example": "2022-03-14T15:01:34.000Z" }, "resourceId": { "type": "string", "description": "The resource ID that the operation belongs to.", "readOnly": true, "example": "abcd1234" }, "resourceType": { "type": "string", "description": "The resource type that the operation belongs to.", "readOnly": true, "example": "service" }, "progressLogs": { "type": "array", "description": "The progress logs for the operation, if available. Not all operations provide progress logs. If the operation provides progress logs, you will see them listed below.", "items": { "$ref": "#/components/schemas/OperationProgressLog" } }, "status": { "type": "string", "description": "The status of the operation.", "readOnly": true, "example": "PENDING", "enum": [ "PENDING", "INPROGRESS", "SUCCEEDED", "FAILED" ] }, "error": { "$ref": "#/components/schemas/OperationError" }, "_links": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Link" }, "description": "Links to resources related to this operation, keyed by link relation. Present only for operations that have related resources to point at.", "readOnly": true } } }, "OperationError": { "type": "object", "properties": { "message": { "type": "string", "description": "A user-friendly message describing the reason for the error or what went wrong." }, "errorId": { "type": "string", "description": "A universally unique identifier (UUID) is useful for debugging. You can provide this code as part of the information you send to our support team." } } }, "OperationProgressLog": { "type": "object", "properties": { "step": { "type": "string" }, "message": { "type": "string" }, "timestamp": { "type": "string" }, "stepId": { "type": "string" }, "status": { "type": "string" } }, "description": "The progress logs for the operation, if available. Not all operations provide progress logs. If the operation provides progress logs, you will see them listed below." }, "OperationResponse": { "required": [ "data", "meta" ], "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Operation" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } } } }, "ServiceConnectionEndpointPort": { "required": [ "protocol" ], "type": "object", "properties": { "protocol": { "type": "string", "description": "Messaging or management protocol.", "enum": [ "serviceSmfPlainTextListenPort", "serviceSmfCompressedListenPort", "serviceSmfTlsListenPort", "serviceWebPlainTextListenPort", "serviceWebTlsListenPort", "serviceAmqpPlainTextListenPort", "serviceAmqpTlsListenPort", "serviceMqttPlainTextListenPort", "serviceMqttWebSocketListenPort", "serviceMqttTlsListenPort", "serviceMqttTlsWebSocketListenPort", "serviceRestIncomingPlainTextListenPort", "serviceRestIncomingTlsListenPort", "serviceManagementTlsListenPort", "managementSshTlsListenPort" ] }, "port": { "maximum": 65535, "minimum": 0, "type": "integer", "description": "Port number. Use '0' to disable the port.", "format": "int32" } }, "description": "

The protocols and port numbers of the connection endpoint. The serviceManagementTlsListenPort and serviceSmfTlsListenPort protocols\nalong with the port numbers must be specified in the request.

\n

Connection specific protocols.

\n