Get the details for a resource object using the unique identifier for the event broker service and the resource object path.
Note: The Try It! feature for this API does not work. To use this API, you must:\n
/** appended to the end of the URL.For more information, see Configuring OAuth Profiles for Management Access to Event Broker Services in the Solace documentation.
\nThis SEMP API supports the following SEMP objects only:\n
Your token must have one of the permissions listed in the Token Permissions.
mission_control:access or services:get or services:get:self ]","operationId":"getResource","parameters":[{"name":"serviceId","in":"path","description":"The unique identifier of the event broker service.","required":true,"schema":{"type":"string"}},{"name":"resourcePath","in":"path","description":"The resource path for the resource object you want to retrieve using the SEMP request, for example oauthProfiles/profile1.\nSee Objects for resource path formatting.","required":true,"schema":{"type":"string"}},{"name":"customQuery","in":"query","description":"The query parameters to pass as part of the SEMP request when retrieving resource objects from the event broker service. For example, you can build the URL as follows:\nbroker/SEMP/v2/config/oauthProfiles/testOAuth?select=msgVpnName,queueName&where=msgVpnName==test&count=25&cursor=1\nSee Objects for query parameters.","style":"form","explode":true,"schema":{"type":"object"}}],"responses":{"200":{"description":"A JSON object returned by the event broker service that describes the resource object’s attributes and contains requested metadata.","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad request.","content":{}},"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":{}},"409":{"description":"Conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service unavailable.","content":{}}},"security":[{"bearerAuth":[]}]},"put":{"tags":["Broker Configuration Using SEMP Proxy"],"summary":"(Beta) Replace a resource object on an event broker service using a SEMP PUT","description":"To replace a resource object on an event broker service using a SEMP PUT.
Note: The Try It! feature for this API does not work. To use this API, you must:\n
/** appended to the end of the URL.For more information, see Configuring OAuth Profiles for Management Access to Event Broker Services in the Solace documentation.
\nThis SEMP API supports the following SEMP objects only:\n
Your token must have one of the permissions listed in the Token Permissions.
mission_control:access or services:post ]","operationId":"replaceResource","parameters":[{"name":"serviceId","in":"path","description":"The unique identifier of the event broker service.","required":true,"schema":{"type":"string"}},{"name":"resourcePath","in":"path","description":"The resource path where you want to replace a resource object using the SEMP request, for example, oauthProfiles/profile1.\nSee Objects for resource path formatting.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The replacement resource object’s attributes and values in JSON format.","content":{"application/json":{"schema":{"type":"string"},"example":"{\"enabled\":true,\"oauthProfileName\":\"profile1\",\"oauthRole\":\"client\",\"resourceServerParseAccessTokenEnabled\":false,\"resourceServerValidateAudienceEnabled\":false,\"resourceServerValidateIssuerEnabled\":false,\"resourceServerValidateScopeEnabled\":false,\"resourceServerValidateTypeEnabled\":false,\"sempEnabled\":false}"}},"required":true},"responses":{"200":{"description":"A JSON object returned by the event broker service after replacing the resource object. The JSON object describes the replacement resource object’s attributes in name/value pairs.","content":{"application/json":{"schema":{"type":"string"},"example":"{\"data\":{\"description\":\"SolaceAdmin Group\",\"globalAccessLevel\":\"read-only\",\"groupName\":\"SolaceAdmin\",\"msgVpnAccessLevel\":\"read-write\",\"oauthProfileName\":\"profile1\"},\"links\":{\"msgVpnAccessLevelExceptionsUri\":\"https://mr-connection-cqifyqi5l0x.messaging.mymaas.net:943/SEMP/v2/config/oauthProfiles/profile1/accessLevelGroups/SolaceAdmin/msgVpnAccessLevelExceptions\",\"uri\":\"https://mr-connection-cqifyqi5l0x.messaging.mymaas.net:943/SEMP/v2/config/oauthProfiles/profile1/accessLevelGroups/SolaceAdmin\"},\"meta\":{\"request\":{\"method\":\"PUT\",\"uri\":\"https://mr-connection-cqifyqi5l0x.messaging.mymaas.net:943/SEMP/v2/config/oauthProfiles/profile1/accessLevelGroups/SolaceAdmin\"},\"responseCode\":200}}"}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrokerSempProxyError"},"example":{"meta":{"error":{"code":"0","description":"An entity of the type OAuth profile was passed in an invalid format.","status":"SOLACE_CLOUD_CUSTOM_OAUTH_VALIDATION_FAILURE"},"request":{"method":"PUT","uri":"/api/v2/missionControl/eventBrokerServices/v4qyo12tlvb/broker/SEMP/v2/config/oauthProfiles/profile1"},"responseCode":400}}}}},"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":{}},"409":{"description":"Conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service unavailable.","content":{}}},"security":[{"bearerAuth":[]}]},"post":{"tags":["Broker Configuration Using SEMP Proxy"],"summary":"(Beta) Create a resource object for an event broker service using a SEMP POST","description":"To create a resource object for event broker service using a SEMP POST.
Note: The Try It! feature for this API does not work. To use this API, you must:\n
/** appended to the end of the URL.For more information, see Configuring OAuth Profiles for Management Access to Event Broker Services in the Solace documentation.
\nThis SEMP API supports the following SEMP objects only:\n
Your token must have one of the permissions listed in the Token Permissions.
mission_control:access or services:post ]","operationId":"createResource","parameters":[{"name":"serviceId","in":"path","description":"The unique identifier of the event broker service.","required":true,"schema":{"type":"string"}},{"name":"resourcePath","in":"path","description":"The resource path where you want to create the resource object using the SEMP request, for example, oauthProfiles.\nSee Objects for resource path information.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The attributes of the resource object you want to create, and their values, in JSON format.","content":{"application/json":{"schema":{"type":"string"},"example":"{\"accessLevelGroupsClaimName\":\"groups\",\"clientId\":\"example123\",\"clientRedirectUri\":\"\",\"clientRequiredType\":\"JWT\",\"clientScope\":\"openid email\",\"clientSecret\":\"example456\",\"clientValidateTypeEnabled\":false,\"defaultGlobalAccessLevel\":\"none\",\"defaultMsgVpnAccessLevel\":\"none\",\"displayName\":\"\",\"enabled\":true,\"endpointAuthorization\":\"\",\"endpointDiscovery\":\"https://example.accounts.ondemand.com/.well-known/openid-configuration\",\"endpointDiscoveryRefreshInterval\":86400,\"endpointIntrospection\":\"\",\"endpointIntrospectionTimeout\":10,\"endpointJwks\":\"\",\"endpointJwksRefreshInterval\":86400,\"endpointToken\":\"\",\"endpointTokenTimeout\":10,\"endpointUserinfo\":\"\",\"endpointUserinfoTimeout\":10,\"interactiveEnabled\":true,\"interactivePromptForExpiredSession\":\"\",\"interactivePromptForNewSession\":\"select_account\",\"issuer\":\"\",\"oauthProfileName\":\"profile1\",\"oauthRole\":\"client\",\"resourceServerParseAccessTokenEnabled\":true,\"resourceServerRequiredAudience\":\"\",\"resourceServerRequiredIssuer\":\"\",\"resourceServerRequiredScope\":\"\",\"resourceServerRequiredType\":\"at+jwt\",\"resourceServerValidateAudienceEnabled\":true,\"resourceServerValidateIssuerEnabled\":true,\"resourceServerValidateScopeEnabled\":true,\"resourceServerValidateTypeEnabled\":true,\"sempEnabled\":false,\"usernameClaimName\":\"sub\"}"}},"required":true},"responses":{"200":{"description":"A JSON object returned by the event broker service after resource object creation. The JSON object describes the resource object’s properties in name/value pairs.","content":{"application/json":{"schema":{"type":"string"},"example":"{\"data\":{\"allowedHost\":\"mr-connection-cqifyqi5l0x.messaging.mymaas.net:943\",\"oauthProfileName\":\"profile1\"},\"links\":{\"uri\":\"https://mr-connection-cqifyqi5l0x.messaging.mymaas.net:943/SEMP/v2/config/oauthProfiles/profile1/clientAllowedHosts/mr-connection-cqifyqi5l0x.messaging.mymaas.net%3A943\"},\"meta\":{\"request\":{\"method\":\"POST\",\"uri\":\"https://mr-connection-cqifyqi5l0x.messaging.mymaas.net:943/SEMP/v2/config/oauthProfiles/profile1/clientAllowedHosts\"},\"responseCode\":200}}"}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrokerSempProxyError"},"example":{"meta":{"error":{"code":"0","description":"An entity of the type OAuth profile was passed in an invalid format.","status":"SOLACE_CLOUD_CUSTOM_OAUTH_VALIDATION_FAILURE"},"request":{"method":"POST","uri":"/api/v2/missionControl/eventBrokerServices/v4qyo12tlvb/broker/SEMP/v2/config/oauthProfiles"},"responseCode":400}}}}},"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":{}},"409":{"description":"Conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service unavailable.","content":{}}},"security":[{"bearerAuth":[]}]},"delete":{"tags":["Broker Configuration Using SEMP Proxy"],"summary":"(Beta) Delete a resource object on an event broker service by object path using a SEMP DELETE","description":"To delete a resource object on an event broker service using the unique identifier for the event broker service and the resource object path.
Note: The Try It! feature for this API does not work. To use this API, you must:\n
/** appended to the end of the URL.For more information, see Configuring OAuth Profiles for Management Access to Event Broker Services in the Solace documentation.
\nThis SEMP API supports the following SEMP objects only:\n
Your token must have one of the permissions listed in the Token Permissions.
mission_control:access or services:post ]","operationId":"deleteResource","parameters":[{"name":"serviceId","in":"path","description":"The unique identifier of the event broker service.","required":true,"schema":{"type":"string"}},{"name":"resourcePath","in":"path","description":"The resource path for the resource object you want to delete using the SEMP DELETE request, for example oauthProfiles/profile1.\nSee Objects for resource path formatting.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"A JSON object with metadata returned from the event broker service after deleting the resource object.","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad request.","content":{}},"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":{}},"409":{"description":"Conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service unavailable.","content":{}}},"security":[{"bearerAuth":[]}]},"patch":{"tags":["Broker Configuration Using SEMP Proxy"],"summary":"(Beta) Update a resource object on an event broker service using a SEMP PATCH","description":"To update a resource object on an event broker service using a SEMP PATCH.
Note: The Try It! feature for this API does not work. To use this API, you must:\n
/** appended to the end of the URL.For more information, see Configuring OAuth Profiles for Management Access to Event Broker Services in the Solace documentation.
\nThis SEMP API supports the following SEMP objects only:\n
Your token must have one of the permissions listed in the Token Permissions.
mission_control:access or services:post ]","operationId":"patchResource","parameters":[{"name":"serviceId","in":"path","description":"The unique identifier of the event broker service.","required":true,"schema":{"type":"string"}},{"name":"resourcePath","in":"path","description":"The resource path for the resource object you want to update using the SEMP PATCH request, for example oauthProfiles/profile1.\nSee Objects for resource path formatting.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The object's attributes in JSON.","content":{"application/json":{"schema":{"type":"string"},"example":"{\"enabled\":true,\"oauthProfileName\":\"profile1\",\"oauthRole\":\"client\",\"resourceServerParseAccessTokenEnabled\":true,\"resourceServerValidateAudienceEnabled\":true,\"resourceServerValidateIssuerEnabled\":true,\"resourceServerValidateScopeEnabled\":true,\"resourceServerValidateTypeEnabled\":true,\"sempEnabled\":true}"}},"required":true},"responses":{"200":{"description":"A JSON object returned by the event broker service after updating the resource object’s attributes. The JSON object describes the resource object’s attributes after being updated in name/value pairs.","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrokerSempProxyError"},"example":{"meta":{"error":{"code":"0","description":"An entity of the type OAuth profile was passed in an invalid format.","status":"SOLACE_CLOUD_CUSTOM_OAUTH_VALIDATION_FAILURE"},"request":{"method":"PATCH","uri":"/api/v2/missionControl/eventBrokerServices/v4qyo12tlvb/broker/SEMP/v2/config/oauthProfiles/profile1"},"responseCode":400}}}}},"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":{}},"409":{"description":"Conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service unavailable.","content":{}}},"security":[{"bearerAuth":[]}]}},"/api/v2/missionControl/eventBrokerServices/{serviceId}/clientProfiles":{"get":{"tags":["Client Profiles"],"summary":"Get a list of client profiles","description":"Get the client profiles that are available for the event broker sevice.
Your token must have one of the permissions listed in the Token Permissions.
mission_control:access or services:get or services:get:self or services:view or services:view:self ]","operationId":"getClientProfiles","parameters":[{"name":"serviceId","in":"path","description":"The identifier of the event broker service.","required":true,"schema":{"type":"string"}},{"name":"pageNumber","in":"query","description":"The page number to retrieve.","required":false,"schema":{"minimum":1,"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"The number of client profiles to return per page.","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","default":100}},{"name":"sort","in":"query","description":"The sorting criteria for the list of client profiles.","required":false,"schema":{"type":"string","example":"name:asc","default":"name:asc"}}],"responses":{"200":{"description":"OK.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientProfilesResponse"}}}},"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":{}}},"409":{"description":"Conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]},"post":{"tags":["Client Profiles"],"summary":"Create a client profile","description":"Create a client profile for the specified event broker service. You can optionally configure permissions for the client profile when creating it.
Your token must have one of the permissions listed in the Token Permissions.
mission_control:access or service_requests:post:client_profile ]","operationId":"createClientProfile","parameters":[{"name":"serviceId","in":"path","description":"The identifier of the event broker service.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The new client profile specification.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientProfileRequest"}}},"required":true},"responses":{"202":{"description":"Accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"message":"An entity of type client profile was passed in an invalid format.","errorId":"618e2fb0-a198-4d9d-9219-13e51ef0ecec","validationDetails":{"name":["must not be blank"]}}}}},"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":{}}},"409":{"description":"Conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/api/v2/missionControl/eventBrokerServices/{serviceId}/clientProfiles/{name}":{"get":{"tags":["Client Profiles"],"summary":"Get a specific client profile for event broker service by name","description":"Get the details of a client profile using its name.
Your token must have one of the permissions listed in the Token Permissions.
mission_control:access or services:get or services:get:self or services:view or services:view:self ]","operationId":"getClientProfile","parameters":[{"name":"serviceId","in":"path","description":"The identifier of the event broker service.","required":true,"schema":{"type":"string"}},{"name":"name","in":"path","description":"The name of the client profile.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientProfileResponse"}}}},"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":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"message":"Could not find the client profile with name, some_name.","errorId":"618e2fb0-a198-4d9d-9219-13e51ef0ecec"}}}},"409":{"description":"Conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]},"put":{"tags":["Client Profiles"],"summary":"Replace a client profile","description":"Replace the configuration of an existing client profile. You can provide any combination of supported fields. If a field is not provided, then it will be set to default value.
Your token must have one of the permissions listed in the Token Permissions.
mission_control:access or service_requests:post:client_profile ]","operationId":"replaceClientProfile","parameters":[{"name":"serviceId","in":"path","description":"The unique identifier of the event broker service.","required":true,"schema":{"type":"string"}},{"name":"name","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The fields to update the configuration for the client profile.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientProfileRequest"}}},"required":true},"responses":{"202":{"description":"Accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"message":"A JSON parse error occurred.","errorId":"618e2fb0-a198-4d9d-9219-13e51ef0ecec"}}}},"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":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"message":"Could not find the client profile with name, some_name.","errorId":"618e2fb0-a198-4d9d-9219-13e51ef0ecec"}}}},"409":{"description":"Conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]},"delete":{"tags":["Client Profiles"],"summary":"Delete a client profile","description":"Delete a client profile using the identifier for the event broker service and the name of the client profile.
Your token must have one of the permissions listed in the Token Permissions.
mission_control:access or service_requests:post:client_profile ]","operationId":"deleteClientProfile","parameters":[{"name":"serviceId","in":"path","description":"The unique identifier of the event broker service.","required":true,"schema":{"type":"string"}},{"name":"name","in":"path","description":"The name of the client profile.","required":true,"schema":{"type":"string"}}],"responses":{"202":{"description":"Operation accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}},"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":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"message":"Could not find the client profile with name, some_name.","errorId":"618e2fb0-a198-4d9d-9219-13e51ef0ecec"}}}},"409":{"description":"Conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]},"patch":{"tags":["Client Profiles"],"summary":"Update a client profile","description":"Update the configuration of an existing client profile. You can provide any combination of supported fields. If a field is not provided, then it will not be updated.
Your token must have one of the permissions listed in the Token Permissions.
mission_control:access or service_requests:post:client_profile ]","operationId":"updateClientProfile","parameters":[{"name":"serviceId","in":"path","description":"The unique identifier of the event broker service.","required":true,"schema":{"type":"string"}},{"name":"name","in":"path","description":"The name of the client profile.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The configuration to update for the client profile.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientProfileRequest"}}},"required":true},"responses":{"202":{"description":"Accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"message":"A JSON parse error occurred.","errorId":"618e2fb0-a198-4d9d-9219-13e51ef0ecec"}}}},"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":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"message":"Could not find the client profile with name, some_name.","errorId":"618e2fb0-a198-4d9d-9219-13e51ef0ecec"}}}},"409":{"description":"Conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/api/v2/missionControl/eventBrokerServices/{serviceId}/connectionEndpoints/{connectionEndpointId}/dnsNames":{"get":{"tags":["Connection Endpoint DNS Names"],"summary":"(Beta) Get all connection endpoint DNS names for the event broker service","description":"Get all connection endpoint DNS names for the event broker service.
Your token must have one of the permissions listed in the Token Permissions.mission_control:access or services:get or services:get:self or services:view or services:view:self ]","operationId":"getConnectionEndpointDnsNames","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 event broker service connection endpoint.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAllConnectionEndpointDnsNamesResponse"}}}},"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/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"},"examples":{"Event broker service not found":{"description":"Event broker service not found","value":{"message":"Could not find event broker service with id some_id.","errorId":"618e2fb0-a198-4d9d-9219-13e51ef0ecec"}},"Connection endpoint not found":{"description":"Connection endpoint not found","value":{"message":"Could not find connectionEndpoint with id some_id.","errorId":"618e2fb0-a198-4d9d-9219-13e51ef0ecec"}}}}}},"409":{"description":"Conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]},"post":{"tags":["Connection Endpoint DNS Names"],"summary":"(Beta) Create a DNS name for an event broker service's connection endpoint","description":"Create a DNS name using a fully qualified domain name (FQDN) to use as a custom hostname for an event broker service’s connection endpoint.
Your token must have one of the permissions listed in the Token Permissions.mission_control:access or service_connection_endpoint:post ]","operationId":"createConnectionEndpointDnsName","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 event broker service connection endpoint.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The dns-name specification.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dnsNameCreateRequest"}}},"required":true},"responses":{"202":{"description":"Accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"message":"An entity of type dnsName was passed in an invalid format.","errorId":"618e2fb0-a198-4d9d-9219-13e51ef0ecec","validationDetails":{"dnsName":["dnsName must not be blank"]}}}}},"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":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"Event broker service not found":{"description":"Event broker service not found","value":{"message":"Could not find event broker service with id some_id.","errorId":"618e2fb0-a198-4d9d-9219-13e51ef0ecec"}},"Connection endpoint not found":{"description":"Connection endpoint not found","value":{"message":"Could not find connectionEndpoint with id some_id.","errorId":"618e2fb0-a198-4d9d-9219-13e51ef0ecec"}}}}}},"409":{"description":"Conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/api/v2/missionControl/eventBrokerServices/{serviceId}/connectionEndpoints/{connectionEndpointId}/dnsNames/{dnsName}":{"delete":{"tags":["Connection Endpoint DNS Names"],"summary":"(Beta) Delete a connection endpoint DNS name from an event broker service","description":"Delete a connection endpoint DNS name from an event broker service.
Your token must have one of the permissions listed in the Token Permissions.service_connection_endpoint:delete or service_connection_endpoint:delete:self or mission_control:access ]","operationId":"deleteConnectionEndpointDnsName","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 event broker service connection endpoint.","required":true,"schema":{"type":"string"}},{"name":"dnsName","in":"path","description":"The DNS name to delete.","required":true,"schema":{"type":"string"}}],"responses":{"202":{"description":"Accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}},"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/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"},"examples":{"Event broker service not found":{"description":"Event broker service not found","value":{"message":"Could not find event broker service with id some_id.","errorId":"618e2fb0-a198-4d9d-9219-13e51ef0ecec"}},"Connection endpoint not found":{"description":"Connection endpoint not found","value":{"message":"Could not find connectionEndpoint with id some_id.","errorId":"618e2fb0-a198-4d9d-9219-13e51ef0ecec"}}}}}},"409":{"description":"Conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/api/v2/missionControl/eventBrokerServices/{serviceId}/connectionEndpoints/{connectionEndpointId}/dnsNames/{dnsName}/move":{"post":{"tags":["Connection Endpoint DNS Names"],"summary":"(Beta) Initiate the move of a DNS name from one connection endpoint to another","description":"Initiate the move of a DNS name from one connection endpoint to another.
Your token must have one of the permissions listed in the Token Permissions on both the source and the target event broker services.mission_control:access or service_connection_endpoint:post ]","operationId":"moveConnectionEndpointDnsName","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 event broker service connection endpoint.","required":true,"schema":{"type":"string"}},{"name":"dnsName","in":"path","description":"The DNS name to move.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The move specification.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DnsNameMoveRequest"}}},"required":true},"responses":{"202":{"description":"Accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"message":"An entity of type dnsName was passed in an invalid format.","errorId":"618e2fb0-a198-4d9d-9219-13e51ef0ecec","validationDetails":{"dnsName":["dnsName must not be blank"]}}}}},"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":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"Event broker service not found":{"description":"Event broker service not found","value":{"message":"Could not find event broker service with id some_id.","errorId":"618e2fb0-a198-4d9d-9219-13e51ef0ecec"}},"Connection endpoint not found":{"description":"Connection endpoint not found","value":{"message":"Could not find connectionEndpoint with id some_id.","errorId":"618e2fb0-a198-4d9d-9219-13e51ef0ecec"}}}}}},"409":{"description":"Conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/api/v2/missionControl/eventBrokerServices/{serviceId}/connectionEndpoints":{"get":{"tags":["Connection Endpoints"],"summary":"(Beta) Get all connection endpoints","description":"Get all connection endpoints for a given event broker service.mission_control:access or services:get or services:get:self or services:view or services:view:self ]","operationId":"getConnectionEndpoints","parameters":[{"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/ConnectionEndpointList"}}}},"400":{"description":"Bad Request.","content":{"application/json":{"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"}}}},"503":{"description":"Service Unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Gateway Timeout","message":"Timeout waiting 28000 ms for.... "}}}}}},"post":{"tags":["Connection Endpoints"],"summary":"(Beta) Create a connection endpoint","description":"Create a connection endpoint for a given event broker service.
\nAn event broker service can have a maximum of one public and one private connection endpoint,\nand must have at least one connection endpoint.\nThe serviceManagementTlsListenPort and serviceSmfTlsListenPort protocols must be enabled on at least one connection endpoint.
\nmission_control:access or service_connection_endpoint:post ]","operationId":"createConnectionEndpoint","parameters":[{"name":"serviceId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateConnectionEndpoint"}}},"required":true},"responses":{"202":{"description":"OK.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"message":"Secured SEMP must be enabled on at least one connection endpoint","errorId":"3722dbd9-ffd6-4244-bc1b-1bd8193dd25c","validationDetails":{"connectionEndpoints":["no semp enabled on connection endpoints"]}}}}},"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"}}}},"503":{"description":"Service Unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Gateway Timeout","message":"Timeout waiting 28000 ms for.... "}}}}}}},"/api/v2/missionControl/eventBrokerServices/{serviceId}/connectionEndpoints/{connectionEndpointId}":{"get":{"tags":["Connection Endpoints"],"summary":"(Beta) Get a connection endpoint","description":"Get a connection endpoint for a given event broker service.mission_control:access or services:get or services:get:self or services:view or services:view:self ]","operationId":"getConnectionEndpoint","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"}}],"responses":{"200":{"description":"OK.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetConnectionEndpointResponse"}}}},"400":{"description":"Bad Request.","content":{"application/json":{"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"}}}},"503":{"description":"Service Unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Gateway Timeout","message":"Timeout waiting 28000 ms for.... "}}}}}},"delete":{"tags":["Connection Endpoints"],"summary":"(Beta) Delete a connection endpoint","description":"Delete a connection endpoint for a given event broker service.service_connection_endpoint:delete or service_connection_endpoint:delete:self or mission_control:access ]","operationId":"deleteConnectionEndpoint","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"}}],"responses":{"202":{"description":"OK.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}},"400":{"description":"Bad Request.","content":{"application/json":{"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"}}}},"503":{"description":"Service Unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Gateway Timeout","message":"Timeout waiting 28000 ms for.... "}}}}}},"patch":{"tags":["Connection Endpoints"],"summary":"(Beta) Update a connection endpoint","description":"Update a connection endpoint for a given event broker service.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":{"application/json":{"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"}}}},"503":{"description":"Service Unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Gateway Timeout","message":"Timeout waiting 28000 ms for.... "}}}}}}},"/api/v2/missionControl/privateRegions":{"post":{"tags":["Customer-Controlled Clusters"],"summary":"(Beta) Create a Customer-Controlled Cluster","description":"Create a Customer-Controlled Cluster.dc:put ]","operationId":"createCustomerControlledCluster","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerControlledCluster"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivateRegionResponse"}}}},"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":"Entity Not Found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/api/v2/missionControl/privateRegions/{id}":{"get":{"tags":["Customer-Controlled Clusters"],"summary":"(Beta) Get a Customer-Controlled Cluster","description":"Get a Customer-Controlled Cluster using its unique identifier.dc:get ]","operationId":"getPrivateRegion","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivateRegionResponse"}}}},"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/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":{}}},"409":{"description":"Conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]},"delete":{"tags":["Customer-Controlled Clusters"],"summary":"(Beta) Delete a Customer-Controlled Cluster","description":"Delete a Customer-Controlled Cluster using its unique identifier.dc:put ]","operationId":"deletePrivateRegion","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Deleted.","content":{"application/json":{"schema":{"type":"string"}}}},"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/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":{}}},"409":{"description":"Conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]},"patch":{"tags":["Customer-Controlled Clusters"],"summary":"(Beta) Update a Customer-Controlled Cluster","description":"Update a Customer-Controlled Cluster using its unique identifier. You can provide any combination of supported fields.\nIf a field is not provided, the field will not be updated.
\ndc:put ]","operationId":"patchPrivateRegion","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerControlledCluster"}}},"required":true},"responses":{"201":{"description":"Updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivateRegionResponse"}}}},"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":"Entity Not Found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/api/v2/missionControl/privateRegions/{id}/health":{"get":{"tags":["Customer-Controlled Clusters"],"summary":"(Beta) Get the health of a Customer-Controlled Cluster","description":"Get the health of a Customer-Controlled Cluster using its unique identifier.dc:get ]","operationId":"getPrivateRegionHealth","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MCAHealthResponse"}}}},"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/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":{}}},"409":{"description":"Conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/api/v2/missionControl/privateRegions/{id}/helmValues":{"get":{"tags":["Customer-Controlled Clusters"],"summary":"(Beta) Get a Customer-Controlled Cluster's helm values","description":"Get a Customer-Controlled Cluster's helm values using the private region's unique identifier.dc:get ]","operationId":"getPrivateRegionHelmValues","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok.","content":{"application/octet-stream":{}}},"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/ErrorResponse"},"example":{"message":"You do not have permissions to perform this operation.","errorId":"618e2fb0-a198-4d9d-9219-13e51ef0ecec"}}}},"404":{"description":"Not found."},"409":{"description":"Conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/api/v2/missionControl/environments/{id}":{"get":{"tags":["Environments"],"summary":"(Beta) Get details of an environment in Mission Control","description":"Get the Mission Control-specific details of an environment.
Your token must have one of the permissions listed in the Token Permissions.
environments:view ]","operationId":"getEnvironment","parameters":[{"name":"id","in":"path","description":"The unique identifier of the environment.","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","description":"Populate additional hidden attributes","required":false,"schema":{"uniqueItems":true,"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"OK.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/EnvironmentResponse"}}}},"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":"Access Denied.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"message":"Subject does not have permission [environments:view]","errorId":"618e2fb0-a198-4d9d-9219-13e51ef0ecec"}}}},"404":{"description":"Not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"message":"Could not find environment environmentId","errorId":"618e2fb0-a198-4d9d-9219-13e51ef0ecec"}}}},"409":{"description":"Conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]},"patch":{"tags":["Environments"],"summary":"(Beta) Update details for an environment in Mission Control","description":"Update the Mission Control-specific details of an environment. You can provide any combination of supported fields. If a field is not provided, then it will not be updated.
Your token must have one of the permissions listed in the Token Permissions.
environments:edit ]","operationId":"patchEnvironment","parameters":[{"name":"id","in":"path","description":"The unique identifier of the environment.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvironmentRequest"}}},"required":true},"responses":{"200":{"description":"OK.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/EnvironmentResponse"}}}},"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":"Access Denied.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"message":"Subject does not have permission [environments:edit]","errorId":"618e2fb0-a198-4d9d-9219-13e51ef0ecec"}}}},"404":{"description":"Not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"message":"Could not find environment environmentId","errorId":"618e2fb0-a198-4d9d-9219-13e51ef0ecec"}}}},"409":{"description":"Conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/api/v2/missionControl/datacenters":{"get":{"tags":["Event Broker Services"],"summary":"Get a list of datacenters","description":"Get the datacenters that are available for the account (or organization).dc:get ]","operationId":"getDatacenters","parameters":[{"name":"pageNumber","in":"query","description":"The page number to retrieve.","required":false,"schema":{"minimum":1,"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"The number of datacenters to return per page.","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","default":100}},{"name":"sort","in":"query","description":"The sorting criteria for the returned results. You can sort the results by query\nparameter in ascending or descending order. Define the sort order using the following string:\nfieldname:asc/desc where:
fieldname—The field name of the query parameter to sort by.asc—Sort the selected field name in ascending order.desc—Sort the selected field name in descending order.You can use multiple query parameters to refine the sorting order.
","required":false,"schema":{"type":"string","example":"name:asc,datacenterType:asc","default":"name:asc,datacenterType:asc"}},{"name":"datacenterType","in":"query","description":"Filter the returned query results by datacenter type. The filtering options include:
\nEmpty'—Returns all datacenter types.Unknown'—Returns any datacenters where the datacenterType\n is not set.SolacePublic'—Known as Public Regions. Public Regions are cloud-based,\n managed datacenters shared between customers.SolaceDedicated'—Known as Dedicated Regions. Dedicated Regions are\n cloud-based, managed datacenters dedicated to a single-customer.CustomerControlled'—Cloud-based Customer-Controlled Regions.CustomerOnPrem'—On-premises Customer-Controlled Regions.Filter the returned query results by Kubernetes provider type.\nThe filtering options include:
\naks'-Azure Kubernetes Service.eks’-AWS Elastic Kubernetes Service.gce’-Google Kubernetes Engine.k8s’-Other Kubernetes provider.aws’-(deprecated) VM-based on Amazon Web Services.azure’-(deprecated) VM-based on Azure.Filter the returned query results by an environment's unique identifier. You cannot filter public datacenters using an environment's unique identifier.
\n","required":false,"schema":{"type":"string","example":"abcd1234"}}],"responses":{"200":{"description":"OK.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatacentersResponse"}}}},"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":{}}},"409":{"description":"Conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/api/v2/missionControl/datacenters/{id}":{"get":{"tags":["Event Broker Services"],"summary":"Get a specific datacenter by identifier","description":"Get the details of a datacenter using its identifier.dc:get ]","operationId":"getDatacenter","parameters":[{"name":"id","in":"path","description":"The unique identifier of the datacenter.","required":true,"schema":{"type":"string"}},{"name":"showSelfServe","in":"query","description":"Indicates self-serve upgrade availability. The possible values are:True - Self-serve upgrades are available.False - Self-serve upgrades are not available.dc:put ]","operationId":"updateDatacenter","parameters":[{"name":"id","in":"path","description":"The unique identifier of the datacenter.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatacenterRequest"}}},"required":true},"responses":{"200":{"description":"OK.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatacenterResponse"}}}},"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":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"message":"Could not find the datacenter with id gke-gcp-us-central1-a.","errorId":"618e2fb0-a198-4d9d-9219-13e51ef0ecec"}}}},"409":{"description":"Conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/api/v2/missionControl/datacenters/{id}/eventBrokerServiceVersions":{"get":{"tags":["Event Broker Services"],"summary":"Get a list of available software event broker versions by datacenter","description":" \nThis API endpoint has been deprecated.
\nDeprecation Date: 2025-06-10
\nRemoval Date: 2026-07-31
\nReason: Please use \n Get a list of software event broker versions available for creating event broker services.\" instead.
Get the software event broker versions available in the datacenter to create event broker services.
event_broker_versions:get ]","operationId":"getEventBrokerServiceVersionsByDatacenter","parameters":[{"name":"id","in":"path","description":"The unique identifier of the datacenter.","required":true,"schema":{"type":"string"}},{"name":"filterIncompatibleVersions","in":"query","description":"Exclude event broker service versions that are incompatible with the datacenter’s Kubernetes version. The default setting is false.","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventBrokerServiceVersionsResponse"}}}},"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":{}}},"409":{"description":"Conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"deprecated":true,"security":[{"bearerAuth":[]}]}},"/api/v2/missionControl/defaultBrokerVersions":{"get":{"tags":["Event Broker Services"],"summary":"(Beta) Get event broker versions","description":"Get the default version number used for event broker service creation in a specific datacenter. Note that the default version used for event broker service creation may not be the same as the latest event broker service version.","operationId":"getVersions","responses":{"200":{"description":"OK.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventBrokerVersionsResponse"}}}},"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"},"404":{"description":"Entity Not Found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/api/v2/missionControl/eventBrokerServiceVersions":{"get":{"tags":["Event Broker Services"],"summary":"Get a list of software event broker versions available for creating event broker services","description":"Get the software event broker versions available to create event broker services.event_broker_versions:get ]","operationId":"getEventBrokerServiceVersions","parameters":[{"name":"recommended","in":"query","description":"Choose to show only recommended or unrecommended event broker versions for service creation.\nThe default value for this field is blank, which returns all event broker versions,\n recommended and unrecommended. You can sort the responses by selecting:
\ntrue - Show only recommended event broker versions.false - Show only unrecommended event broker versions.The release channel shows the type of broker release. The release types offer differing support and upgrade paths. For more information, seesee Version Adoption in the Solace documentation.
The filtering options include:
Preview - A pre-10.25 version release for previewing new features.Production - A pre-10.25 version production release.Production_LTS - A pre-10.25 version long term support production release.LTS - A 10.25 version and later, annual production release with two-years of support and maintenance releases.Rolling - A 10.25 version and later, bi-weekly production release for introducing new features. Rolling releases have two years of support with no maintenance releases.Declined - Unsupported versions, available for testing.Get a listing of event broker services.
Your token must have one of the permissions listed in the Token Permissions.
mission_control:access or services:get or services:get:self or services:view or services:view:self ]","operationId":"getServices","parameters":[{"name":"customAttributes","in":"query","description":"Filter the list of event broker services by custom attributes.
To filter by custom attribute name and value, use the format: customAttributes=<custom-attribute-name>==<custom-attribute-value>.
customAttributes are RSQL query strings that support using asterisks as a wildcard. You can place a wildcard at the beginning, middle, or end of the query value.The supported attributes, and examples of each are listed below:
name, examples include:name==myservicename==production*name==*prod*ownedBy, examples include:ownedBy==userIdenvironmentId, examples include:environmentId==12345environmentId!=345678Additional information to retrieve for the event broker service. The supported value is allowedActions.
The returned allowedActions may include: 'get', 'messageSpoolDetails', 'configure', 'update', 'broker_update', 'delete', 'assign'.
The definitions for each action are listed below:
get The user can get the event broker service.messageSpoolDetails The user can get the message spool details.configure The user can configure the event broker service, for example, to add a new client profile.update The user can update the event broker service configurations.broker_update The user can update the event broker service message vpn configuration.delete The user can delete the event broker service.assign The user can assign the event broker service to other users.Sort the returned event broker services by attribute.
You can use the following value formats for the sort order:
attributes-namesattributes-names:sort-orderAdd attribute-names in a comma-separated list in the order you want to sort them by.
Use the sort-order to sort the attributes using one of the following values:
asc’-ascending orderdesc’-descending orderIf you do not define a sort order, it will default to ascending order.\nThese are support attribute names you can sort by:
datacenterId,createdTime:asc\n","required":false,"schema":{"type":"string"}},{"name":"pageNumber","in":"query","description":"The page number to retrieve.","required":false,"schema":{"minimum":1,"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"The number of event broker services to return per page.","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","default":100}}],"responses":{"200":{"description":"OK.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceSummaryResponse"}}}},"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":{}}},"409":{"description":"Conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]},"post":{"tags":["Event Broker Services"],"summary":"Create an event broker service","description":"Create an event broker service. You must provide a unique name and select a service class and datacenter. You can optionally define other properties for the event broker service.
Your token must have one of the permissions listed in the Token Permissions.
services:post ]","operationId":"createService","requestBody":{"description":"The new service specification.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateServiceRequest"}}},"required":true},"responses":{"202":{"description":"Accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"message":"An entity of type service was passed in an invalid format.","errorId":"618e2fb0-a198-4d9d-9219-13e51ef0ecec","validationDetails":{"serviceClassId":["must not be blank"]}}}}},"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":{}}},"409":{"description":"Conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/api/v2/missionControl/eventBrokerServices/{id}":{"get":{"tags":["Event Broker Services"],"summary":"Get a specific event broker service by identifier","description":"Get the details of an event broker service using its identifier. Additional information about the event broker service can be requested using the 'expand' parameter.
mission_control:access or services:get or services:get:self or services:view or services:view:self ]","operationId":"getService","parameters":[{"name":"id","in":"path","description":"The unique identifier of the event broker service.","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","description":"You can request additional information about the event broker service by selecting expand parameters, including connection endpoint information, broker details including version, allowed actions you can perform on the service, and message spool details.","required":false,"schema":{"maxItems":4,"minItems":0,"uniqueItems":true,"type":"array","items":{"type":"string","enum":["broker","serviceConnectionEndpoints","allowedActions","messageSpoolDetails"]}}}],"responses":{"200":{"description":"OK.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceResponse"}}}},"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":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"message":"Could not find the event broker service with id 4o5kyf4x5504.","errorId":"618e2fb0-a198-4d9d-9219-13e51ef0ecec"}}}},"409":{"description":"Conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]},"delete":{"tags":["Event Broker Services"],"summary":"Delete an event broker service","description":"Delete a service using its unique identifier.
Your token must have one of the permissions listed in the Token Permissions.
services:delete or services:delete:self or mission_control:access ]","operationId":"deleteService","parameters":[{"name":"id","in":"path","description":"The unique identifier of the event broker service.","required":true,"schema":{"type":"string"}}],"responses":{"202":{"description":"Operation accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"message":"You cannot delete a service with deletion protection enabled.","errorId":"8545813d-9eec-456d-92e6-e82f8c942cb4","validationDetails":{"value":["must be false"]}}}}},"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":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"message":"Could not find the event broker service with id 4o5kyf4x5504.","errorId":"618e2fb0-a198-4d9d-9219-13e51ef0ecec"}}}},"409":{"description":"Conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]},"patch":{"tags":["Event Broker Services"],"summary":"Update an event broker service","description":"Update the configuration of an existing event broker service. You can provide any combination of supported fields. If a field is not provided, then it will not be updated.
Your token must have one of the permissions listed in the Token Permissions.
mission_control:access or services:put ]","operationId":"updateService","parameters":[{"name":"id","in":"path","description":"The unique identifier of the event broker service.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The fields to update the configuration for the event broker service.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateServiceRequest"}}},"required":true},"responses":{"200":{"description":"OK.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"message":"A JSON parse error occurred.","errorId":"618e2fb0-a198-4d9d-9219-13e51ef0ecec"}}}},"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":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"message":"Could not find the event broker service with id 4o5kyf4x5504.","errorId":"618e2fb0-a198-4d9d-9219-13e51ef0ecec"}}}},"409":{"description":"Conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/api/v2/missionControl/eventBrokerServices/{id}/clone":{"post":{"tags":["Event Broker Services"],"summary":"Create a clone of an existing event broker service","description":"Create a clone of an existing event broker service.
You must specify the unique identifiers of the event broker service in the URL and the datacenter in the request body. By default, the name of the new service is the name of the specified event broker service with \" - Clone\" appended to the name. When the event broker service that you clone has deletion protection enabled ('locked' is ‘true’), the new event broker service also has deletion protection enabled. If service creation fails during the clone process, deletion protection is disabled ('locked' is 'false') and allows you to delete the failed service.
Cloning copies the Rest Delivery Endpoints, but disables them. You must re-enable the endpoints after creating the cloned service.
This endpoint does not clone:
Optionally, you can set the service connection endpoint settings as they are not cloned from the specified service.
services:post ]","operationId":"cloneService","parameters":[{"name":"id","in":"path","description":"The unique identifier of the event broker service to clone.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The fields to specify to clone an event broker service.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloneServiceRequest"}}},"required":true},"responses":{"202":{"description":"Accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"message":"An entity of type service was passed in an invalid format.","errorId":"618e2fb0-a198-4d9d-9219-13e51ef0ecec","validationDetails":{"serviceClassId":["must not be blank"]}}}}},"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":{}}},"409":{"description":"Conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/api/v2/missionControl/eventBrokerServices/{serviceId}/brokerState":{"get":{"tags":["Event Broker Services"],"summary":"(Beta) Get the availability state of an event broker service","description":"Get the availability state of an event broker service and the name of the active messaging node using the service's unique identifier.
Your token must have one of the permissions listed in the Token Permissions.
mission_control:access or services:get or services:get:self or services:view or services:view:self ]","operationId":"getBrokerStateByServiceId","parameters":[{"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/BrokerStateResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"message":"Bad request.","errorId":"618e2fb0-a198-4d9d-9219-13e51ef0ecec"}}}},"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":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"message":"Could not find the event broker service with id 4o5kyf4x5504.","errorId":"618e2fb0-a198-4d9d-9219-13e51ef0ecec"}}}},"409":{"description":"Conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"message":"The mission control agent for the region hosting your service is not available to process the request.","errorId":"618e2fb0-a198-4d9d-9219-13e51ef0ecec"}}}}},"security":[{"bearerAuth":[]}]}},"/api/v2/missionControl/eventBrokerServices/{serviceId}/messageSpool":{"patch":{"tags":["Event Broker Services"],"summary":"Update the event broker service message spool size","description":"Expand the event broker service's message spool size.
Your token must have one of the permissions listed in the Token Permissions.
mission_control:access or services:put ]","operationId":"updateMessageSpool","parameters":[{"name":"serviceId","in":"path","description":"The unique identifier of the event broker service.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The new size of the message spool in gigabytes (GB).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageSpool"}}},"required":true},"responses":{"202":{"description":"Accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"message":"Service scale up failed due to insufficient message spool expansion limits.","errorId":"618e2fb0-a198-4d9d-9219-13e51ef0ecec"}}}},"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":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"message":"Could not find event broker service with id some_id.","errorId":"618e2fb0-a198-4d9d-9219-13e51ef0ecec"}}}},"409":{"description":"Conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/api/v2/missionControl/eventBrokerServices/{serviceId}/operations":{"get":{"tags":["Event Broker Services"],"summary":"(Beta) Get the status of all operations on an event broker service","description":"Get the status of all operations being performed on an event broker service. To get the operations, you must provide the identifier of the event broker service. You can filter the list or returned results by operation type.
Your token must have one of the permissions listed in the Token Permissions.
mission_control:access or services:get or services:get:self or services:view or services:view:self ]","operationId":"getServiceOperations","parameters":[{"name":"serviceId","in":"path","description":"The unique identifier of the event broker service.","required":true,"schema":{"type":"string"}},{"name":"operationTypes","in":"query","description":"Filter the returned query results by the type of operation being performed on the event broker service. The filtering options include: haSwitchover - A high-availability switchover operation.Get the status of an operation that being performed on an event broker service. To get the operation, you provide identifier of the operation and the identifier of the event broker service.
Your token must have one of the permissions listed in the Token Permissions.
mission_control:access or services:get or services:get:self or services:view or services:view:self ]","operationId":"getServiceOperation","parameters":[{"name":"serviceId","in":"path","description":"The unique identifier of the event broker service.","required":true,"schema":{"type":"string"}},{"name":"operationId","in":"path","description":"The identifier of the operation being performed on the event broker service.","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","description":"Additional information to retrieve about the in-progress operation for the event broker service. The supported values are: progressLogsprogressLogs may include information about the state of in-progress multi-stage operations for an event broker service, for example, high-availability switchovers.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}},"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":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"message":"Could not find the event broker service with id 4o5kyf4x5504.","errorId":"618e2fb0-a198-4d9d-9219-13e51ef0ecec"}}}},"409":{"description":"Conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/api/v2/missionControl/eventBrokerServices/{serviceId}/sempBasicAuth":{"put":{"tags":["Event Broker Services"],"summary":"(Beta) Update whether an event broker service allows basic authentication for management access","description":"Enable or disable basic authentication for management access to the event broker service.
Disabling basic authentication for management access to the event broker service disables access to users with the following roles:
If you disable basic authentication, you must configure alternative access using LDAP or OAuth to provide management access to the event broker service. For more information, see Configuring User Access to Event Broker Services in the documentation.
Your token must have one of the permissions listed in the Token Permissions.
mission_control:access or services:put ]","operationId":"disableOrEnable","parameters":[{"name":"serviceId","in":"path","description":"The unique identifier of the event broker service.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The object's attributes in JSON.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BasicAuthAvailability"}}},"required":true},"responses":{"200":{"description":"Returns the state of basic authentication on the event broker service, either:\ntrue (authentication is enabled)false (authentication is disabled)Change the active messaging node in a high-availability event broker service. This action may cause a brief loss of messaging connectivity.
Your token must have one of the permissions listed in the Token Permissions.
mission_control:access or services:switchover ]","operationId":"switchoverBroker","parameters":[{"name":"serviceId","in":"path","description":"The unique identifier of the event broker service.","required":true,"schema":{"type":"string"}}],"responses":{"202":{"description":"Accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"message":"Bad request.","errorId":"618e2fb0-a198-4d9d-9219-13e51ef0ecec"}}}},"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"},"404":{"description":"Not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"message":"Could not find resource with id some_id.","errorId":"618e2fb0-a198-4d9d-9219-13e51ef0ecec"}}}},"409":{"description":"Conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/api/v2/missionControl/organizations/{orgId}/messageSpoolLimitUsage":{"get":{"tags":["Event Broker Services"],"summary":"(Beta) Get the organization message spool expansion information","description":"Get the organization-wide message spool expansion class and limits information.","operationId":"getLimits","parameters":[{"name":"orgId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageSpoolLimitClassesResponse"}}}},"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"},"404":{"description":"Entity Not Found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/api/v2/missionControl/serviceClasses":{"get":{"tags":["Event Broker Services"],"summary":"Get a list of service classes","description":"Get the service classes that are available in the account (or organization).service_classes:get ]","operationId":"getServiceClasses","parameters":[{"name":"brokerFamilyVersion","in":"query","description":"The version of the broker family. For example 10.6","required":false,"schema":{"type":"number"},"example":10.7}],"responses":{"200":{"description":"OK.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceClassesResponse"}}}},"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":{}}},"409":{"description":"Conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/api/v2/missionControl/serviceClasses/{id}":{"get":{"tags":["Event Broker Services"],"summary":"Get a specific service class by identifier","description":"Get the details of a service class using its identifier.service_classes:get ]","operationId":"getServiceClass","parameters":[{"name":"id","in":"path","description":"The unique identifier of the service class.","required":true,"schema":{"type":"string","enum":["DEVELOPER","ENTERPRISE_250_STANDALONE","ENTERPRISE_1K_STANDALONE","ENTERPRISE_5K_STANDALONE","ENTERPRISE_10K_STANDALONE","ENTERPRISE_50K_STANDALONE","ENTERPRISE_100K_STANDALONE","ENTERPRISE_250_HIGHAVAILABILITY","ENTERPRISE_1K_HIGHAVAILABILITY","ENTERPRISE_5K_HIGHAVAILABILITY","ENTERPRISE_10K_HIGHAVAILABILITY","ENTERPRISE_50K_HIGHAVAILABILITY","ENTERPRISE_100K_HIGHAVAILABILITY"]}},{"name":"brokerFamilyVersion","in":"query","description":"The version of the broker family. For example 10.6","required":false,"schema":{"type":"number"},"example":10.7}],"responses":{"200":{"description":"OK.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceClassResponse"}}}},"400":{"description":"Invalid Parameter.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"message":"Invalid parameter: id. Must be one of the following types: DEVELOPER,ENTERPRISE_250_HIGHAVAILABILITY,ENTERPRISE_1K_HIGHAVAILABILITY,ENTERPRISE_5K_HIGHAVAILABILITY,ENTERPRISE_10K_HIGHAVAILABILITY,ENTERPRISE_50K_HIGHAVAILABILITY,ENTERPRISE_100K_HIGHAVAILABILITY,ENTERPRISE_250_STANDALONE,ENTERPRISE_1K_STANDALONE,ENTERPRISE_5K_STANDALONE,ENTERPRISE_10K_STANDALONE,ENTERPRISE_50K_STANDALONE,ENTERPRISE_100K_STANDALONE","errorId":"618e2fb0-a198-4d9d-9219-13e51ef0ecec"}}}},"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":"Entity Not Found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/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.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/ErrorResponse"},"example":{"message":"You do not have permissions to perform this operation.","errorId":"618e2fb0-a198-4d9d-9219-13e51ef0ecec"}}}},"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"}}}},"503":{"description":"Service unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/upgradeReadinessResponse"}}}}}}},"/api/v2/missionControl/eventBrokerServices/{serviceId}/upgrades":{"get":{"tags":["Event Broker Upgrades"],"summary":"Get a list of event broker service upgrades","description":"Get the details of all upgrades, past and present, for an event broker service using the service's unique identifier. You can filter the results using the query parameters.mission_control:access or event_broker_upgrade:post or maintenance_activity:read ]","operationId":"getEventBrokerServiceUpgrades","parameters":[{"name":"serviceId","in":"path","description":"The unique identifier of the event broker service.","required":true,"schema":{"type":"string"}},{"name":"maintenanceWindowId","in":"query","description":"The identifier of the maintenance window to filter by.","required":false,"schema":{"type":"string"}},{"name":"operationStatus","in":"query","description":"The operation status to filter by.","required":false,"schema":{"type":"string","enum":["SCHEDULED","IN_PROGRESS","COMPLETED","FAILED","CANCELLED","SKIPPED","PAUSED","WARNING","RESOLVED"]}},{"name":"preMaintenanceValidationStatus","in":"query","description":"The pre-maintenance validation status to filter by.","required":false,"schema":{"type":"string","enum":["SCHEDULED","IN_PROGRESS","COMPLETED","FAILED","CANCELLED","SKIPPED","PAUSED","WARNING","RESOLVED"]}},{"name":"postMaintenanceValidationStatus","in":"query","description":"The post-maintenance validation status to filter by.","required":false,"schema":{"type":"string","enum":["SCHEDULED","IN_PROGRESS","COMPLETED","FAILED","CANCELLED","SKIPPED","PAUSED","WARNING","RESOLVED"]}},{"name":"maintenanceActivityStatus","in":"query","description":"The maintenance activity status to filter by.","required":false,"schema":{"type":"string","enum":["SCHEDULED","IN_PROGRESS","COMPLETED","FAILED","CANCELLED","SKIPPED","PAUSED","WARNING","RESOLVED"]}},{"name":"scheduledStartTimeAfter","in":"query","description":"Filter the returned query results by maintenance activities with start times scheduled after the entered timestamp (epoch milliseconds).","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"scheduledStartTimeBefore","in":"query","description":"Filter the returned query results by maintenance activities with start times scheduled before the entered timestamp (epoch milliseconds).","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"pageNumber","in":"query","description":"The page number for pagination.","required":false,"schema":{"minimum":1,"type":"integer","default":1},"example":1},{"name":"pageSize","in":"query","description":"The number of items per page.","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","default":20},"example":20},{"name":"sort","in":"query","description":"The sorting criteria for the returned results. You can sort the results by any of the query parameters,\nin either ascending or descending order.\nDefine the sort order using the following string: parameter name:asc/desc\n","required":false,"schema":{"pattern":"^[a-zA-Z]+:(asc|desc)$","type":"string","default":"createdTime:desc"},"example":"createdTime,desc"}],"responses":{"200":{"description":"OK.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MaintenanceActivityResponseList"}}}},"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":{}}}}},"post":{"tags":["Event Broker Upgrades"],"summary":"Create an event broker service upgrade","description":"Create an event broker service upgrade using the service's unique identifier.event_broker_upgrade:post ]","operationId":"createEventBrokerServiceUpgrade","parameters":[{"name":"serviceId","in":"path","description":"The unique identifier of the event broker service.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventBrokerUpgradeRequest"}}},"required":true},"responses":{"201":{"description":"Created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MaintenanceActivityResponseDTO"}}}},"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":"Entity Not Found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v2/missionControl/eventBrokerServices/{serviceId}/upgrades/{maintenanceActivityId}":{"get":{"tags":["Event Broker Upgrades"],"summary":"Get an event broker service upgrade","description":"Get the details of a specific event broker service upgrade using the unique identifiers of the service and maintenance activity.mission_control:access or event_broker_upgrade:post ]","operationId":"getEventBrokerServiceUpgrade","parameters":[{"name":"serviceId","in":"path","description":"The unique identifier of the event broker service.","required":true,"schema":{"type":"string"}},{"name":"maintenanceActivityId","in":"path","description":"The identifier of the maintenance activity.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MaintenanceActivityResponseList"}}}},"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":{}}}}}},"/api/v2/missionControl/maintenanceActivities":{"get":{"tags":["Maintenance Activities"],"summary":"Get a list of maintenance activities","description":"Get the details of maintenance activities for the account (or organization).maintenance_activity:read ]","operationId":"getMaintenanceActivities","parameters":[{"name":"maintenanceWindowId","in":"query","description":"The identifier of the maintenance window to filter by.","required":false,"schema":{"type":"string"}},{"name":"environmentId","in":"query","description":"The identifier of the environment to filter by.","required":false,"schema":{"type":"string"}},{"name":"operationStatus","in":"query","description":"The operation status to filter by.","required":false,"schema":{"type":"string","enum":["SCHEDULED","IN_PROGRESS","COMPLETED","FAILED","CANCELLED","SKIPPED","PAUSED","WARNING","RESOLVED"]}},{"name":"resourceId","in":"query","description":"The identifier of the resource to filter by.","required":false,"schema":{"type":"string"}},{"name":"resourceType","in":"query","description":"The resource type to filter by. Filter options include:","required":false,"schema":{"type":"string","enum":["SOLACE_EVENT_BROKER","DATADOG_AGENT","MISSION_CONTROL_AGENT"]}},{"name":"scheduledStartTimeAfter","in":"query","description":"Filter the returned query results by maintenance activities with start times scheduled after the entered timestamp (epoch milliseconds).","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"scheduledStartTimeBefore","in":"query","description":"Filter the returned query results by maintenance activities with start times scheduled before the entered timestamp (epoch milliseconds).","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"pageNumber","in":"query","description":"The page number for pagination.","required":false,"schema":{"minimum":1,"type":"integer","default":1},"example":1},{"name":"pageSize","in":"query","description":"The number of items per page.","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","default":20},"example":20},{"name":"preMaintenanceValidationStatus","in":"query","description":"The pre-maintenance validation status to filter by.","required":false,"schema":{"type":"string","enum":["SCHEDULED","IN_PROGRESS","COMPLETED","FAILED","CANCELLED","SKIPPED","PAUSED","WARNING","RESOLVED"]}},{"name":"postMaintenanceValidationStatus","in":"query","description":"The post-maintenance validation status to filter by.","required":false,"schema":{"type":"string","enum":["SCHEDULED","IN_PROGRESS","COMPLETED","FAILED","CANCELLED","SKIPPED","PAUSED","WARNING","RESOLVED"]}},{"name":"maintenanceActivityStatus","in":"query","description":"The maintenance activity status to filter by.","required":false,"schema":{"type":"string","enum":["SCHEDULED","IN_PROGRESS","COMPLETED","FAILED","CANCELLED","SKIPPED","PAUSED","WARNING","RESOLVED"]}},{"name":"critical","in":"query","description":"Filter by critical flag. Critical activities may not be cancelled, only rescheduled.","required":false,"schema":{"type":"boolean"}},{"name":"sort","in":"query","description":"The sorting criteria for the returned results. You can sort the results by query parameter in ascending or descending order. Define the sort order using the following string: fieldname:asc/desc","required":false,"schema":{"pattern":"^[a-zA-Z]+:(asc|desc)$","type":"string","default":"createdTime:desc"},"example":"createdTime,desc"}],"responses":{"200":{"description":"OK.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MaintenanceActivityResponseList"}}}},"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":{}}}}}},"/api/v2/missionControl/maintenanceActivities/{maintenanceActivityId}":{"get":{"tags":["Maintenance Activities"],"summary":"Get a specific maintenance activity","description":"Get the details of a specific maintenance activity.maintenance_activity:read ]","operationId":"getMaintenanceActivity","parameters":[{"name":"maintenanceActivityId","in":"path","description":"The identifier of the maintenance activity.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MaintenanceActivityResponseDTO"}}}},"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":{}}}}}},"/api/v2/missionControl/maintenanceActivities/{maintenanceActivityId}/cancel":{"post":{"tags":["Maintenance Activities"],"summary":"Cancel a specific scheduled maintenance activity","description":"Cancel a specific scheduled maintenance activity using the activities unique ID.maintenance_activity:write ]","operationId":"cancelMaintenanceActivity","parameters":[{"name":"maintenanceActivityId","in":"path","description":"The identifier of the maintenance activity.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"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":{}}}}}},"/api/v2/missionControl/maintenanceActivities/{maintenanceActivityId}/initiatePostMaintenanceCheck":{"post":{"tags":["Maintenance Activities"],"summary":"Initiate a post-maintenance validation for a maintenance activity","description":"Initiate a post-maintenance validation for a specific maintenance activity using the unique identifier of the maintenance activity.event_broker_upgrade:post ]","operationId":"initiatePostMaintenanceCheck","parameters":[{"name":"maintenanceActivityId","in":"path","description":"The identifier of the maintenance activity.","required":true,"schema":{"type":"string"}}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MaintenanceActivityResponseDTO"}}}},"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":{}}}}}},"/api/v2/missionControl/maintenanceActivities/{maintenanceActivityId}/initiatePreMaintenanceCheck":{"post":{"tags":["Maintenance Activities"],"summary":"Initiate a pre-maintenance validation for a maintenance activity","description":"Initiate a pre-maintenance validation for a specific maintenance activity using the unique identifier of the maintenance activity.event_broker_upgrade:post ]","operationId":"initiatePreMaintenanceCheck","parameters":[{"name":"maintenanceActivityId","in":"path","description":"The identifier of the maintenance activity.","required":true,"schema":{"type":"string"}}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MaintenanceActivityResponseDTO"}}}},"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":{}}}}}},"/api/v2/missionControl/maintenanceSchedules":{"get":{"tags":["Maintenance Schedules"],"summary":"Get a list of maintenance schedules","description":"Get a list of maintenance schedule for self-serve upgrades.maintenance_schedules:read ]","operationId":"getMaintenanceSchedules","parameters":[{"name":"environmentId","in":"query","description":"The identifier of the environment to filter by.","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"The page number to retrieve.","schema":{"type":"integer","default":1}},{"name":"size","in":"query","description":"The number of items per page.","schema":{"type":"integer","default":20}},{"name":"sort","in":"query","description":"The sorting criteria for the returned results.\nYou can sort the results by query parameter in ascending or descending order.\nDefine the sort order using the following string: field name:asc/desc where:\nenvironmentId: The environment identifier.organizationId: The organization identifier.id: The maintenance schedule identifier.maintenanceType: The type of maintenance type.createdBy: The identifier of the person who created the recurrence.createdTime: The date and time the recurrence was created.maintenance_schedules:write ]","operationId":"createMaintenanceSchedule","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MaintenanceScheduleRequest"}}},"required":true},"responses":{"201":{"description":"Created.","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":{}}}}}},"/api/v2/missionControl/maintenanceSchedules/{maintenanceScheduleId}":{"get":{"tags":["Maintenance Schedules"],"summary":"Get a maintenance schedule","description":"Get a maintenance schedule using its identifier.maintenance_schedules:read ]","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":{}}}}},"delete":{"tags":["Maintenance Schedules"],"summary":"Delete a maintenance schedule","description":"Delete a maintenance schedule using its identifier.maintenance_schedules:write ]","operationId":"deleteMaintenanceSchedule","parameters":[{"name":"maintenanceScheduleId","in":"path","description":"The unique identifier of the maintenance schedule.","required":true,"schema":{"minLength":1,"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad request."},"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."}}}},"/api/v2/missionControl/maintenanceWindows":{"get":{"tags":["Maintenance Windows"],"summary":"Get maintenance windows","description":"Get the details of all maintenance windows for event broker service upgrades on a maintenance schedule.maintenance_schedules:read ]","operationId":"getMaintenanceWindows","parameters":[{"name":"environmentId","in":"query","description":"The identifier of the environment to filter by.","required":false,"schema":{"type":"string"}},{"name":"maintenanceScheduleId","in":"query","description":"The identifier of the maintenance schedule to filter by.","required":false,"schema":{"type":"string"}},{"name":"pageNumber","in":"query","description":"The page number for pagination.","required":false,"schema":{"minimum":1,"type":"integer","default":1},"example":1},{"name":"pageSize","in":"query","description":"The number of items per page.","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","default":20},"example":20},{"name":"sort","in":"query","description":"The sorting criteria for the returned results.\nYou can sort the results by query parameter in ascending or descending order.\nDefine the sort order using the following string: field name:asc/desc where:\norganizationId: The organization identifier.maintenanceScheduleId: The identifier of the maintenance schedule.maintenanceType: The type of maintenance type.recurrenceDayOfWeek: The day of the week for the recurrence.recurrenceFrequency: The frequency of the recurrence.recurrenceDayOfWeekMonthly: The day of the recurrence,\n when the recurrence occurs on a specific day of the month.\n For example, if the recurrenceDayOfWeek returns Tuesday, and recurrenceDayOfWeekMonthly returns SECOND,\n then upgrades are triggered on the second Tuesday of a month.startTime: The date and time of the recurrence starts.durationInHours: The duration of the maintenance window, in hours.createdBy: The identifier of the person who created the recurrence.createdTime: The date and time the recurrence was created.updatedBy: The identifier of the last person to update the recurrence.updatedTime: The date and time the recurrence was last updated.maintenance_schedules:write ]","operationId":"createMaintenanceWindow","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MaintenanceWindowRequest"}}},"required":true},"responses":{"201":{"description":"Created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MaintenanceWindowResponse"}}}},"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":{}}}}}},"/api/v2/missionControl/maintenanceWindows/{maintenanceWindowId}":{"get":{"tags":["Maintenance Windows"],"summary":"Get a specific maintenance window","description":"Get the details of a specific maintenance window for event broker service upgrades on a maintenance schedule.maintenance_schedules:read ]","operationId":"getMaintenanceWindow","parameters":[{"name":"environmentId","in":"query","description":"The identifier of the environment to filter by.","schema":{"type":"string"}},{"name":"maintenanceScheduleId","in":"query","description":"The identifier of the maintenance schedule to filter by.","schema":{"type":"string"}},{"name":"maintenanceWindowId","in":"path","description":"The identifier of the maintenance window.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MaintenanceWindowResponse"}}}},"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":{}}}}},"put":{"tags":["Maintenance Windows"],"summary":"Update a maintenance window","description":"Update a maintenance window for an event broker service upgrade on a maintenance schedule.\nThe changes you make with this API do not affect scheduled upgrades for event brokers services in the maintenance window.\nmaintenance_schedules:write ]","operationId":"updateMaintenanceWindow","parameters":[{"name":"maintenanceWindowId","in":"path","description":"The unique identifier of the maintenance window you want to update.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MaintenanceWindowRequest"}}},"required":true},"responses":{"200":{"description":"OK.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MaintenanceWindowResponse"}}}},"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":{}}}}},"delete":{"tags":["Maintenance Windows"],"summary":"Delete a maintenance window","description":"Delete a maintenance window for event broker service upgrades on a maintenance schedule.maintenance_schedules:write ]","operationId":"deleteMaintenanceWindow","parameters":[{"name":"maintenanceWindowId","in":"path","description":"The unique identifier of the maintenance window.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"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/ErrorResponse"},"example":{"message":"You do not have permissions to perform this operation.","errorId":"618e2fb0-a198-4d9d-9219-13e51ef0ecec"}}}},"404":{"description":"Not found.","content":{}}}}},"/api/v2/missionControl/eventBrokerServices/{serviceId}/recommendedVersions":{"get":{"tags":["Recommended Event Broker Versions"],"summary":"Get a list of recommended software event broker versions for a service upgrade","description":"Get a list of available event broker software versions recommended for upgrading the queried event broker service.event_broker_versions:get ]","operationId":"getRecommendedEventBrokerServicesV2","parameters":[{"name":"serviceId","in":"path","description":"The unique identifier of the service.","required":true,"schema":{"type":"string"}},{"name":"recommended","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"pageNumber","in":"query","required":false,"schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":100}},{"name":"sort","in":"query","required":false,"schema":{"pattern":"^[a-zA-Z]+:(asc|desc)$","type":"string","default":"version:desc"}}],"responses":{"200":{"description":"OK.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecommendedEventEventBrokerServiceVersionsResponse"}}}},"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":{}}},"409":{"description":"Conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/api/v2/missionControl/eventBrokerServices/multiResourceOperations/{operationId}":{"get":{"tags":["Replication"],"summary":"(Beta) Get the status of a multi-resource operation","description":"Get the status of a multi-resource operation that is being performed on the event broker services. To get the operation, you must provide the operation identifier. The operation identifier is returned as part of the response body to the original API request to initiate the operation.
Your token must have one of the permissions listed in the Token Permissions.
mission_control:access or services:get or services:get:self or services:view or services:view:self ]","operationId":"getMultiResourceOperation","parameters":[{"name":"operationId","in":"path","description":"The identifier of the multi-resource operation being performed on the event broker services.","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","description":"Additional information to retrieve about the in-progress operations for the event broker services. The supported values are: operationsoperations may include information about the detail information of each single operation.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/MultiResourceOperationResponse"}}}},"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/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 multi-resource operation with id 4o5kyf4x5504.","errorId":"618e2fb0-a198-4d9d-9219-13e51ef0ecec"}}}},"409":{"description":"Conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/api/v2/missionControl/eventBrokerServices/replication/rotatePSK":{"post":{"tags":["Replication"],"summary":"(Beta) Initiate authentication for replication config-sync connections using a pre-shared key","description":"Configure the event broker services in a replication pair to use a pre-shared key (PSK) for authentication of replication config-sync. This API generates the PSK and installs that PSK on both event broker services in the replication pair.
Initiating authentication for replication config-sync using a PSK disables insecure upgrade mode if enabled on the event broker service.
Your token must have one of the permissions listed in the Token Permissions.
services:post or mission_control:access ]","operationId":"initiateReplicationPSK","requestBody":{"description":"The request to initiate authentication for replication config-sync using a pre-shared key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Replication"}}},"required":true},"responses":{"202":{"description":"Accepted.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"message":"Bad request.","errorId":"618e2fb0-a198-4d9d-9219-13e51ef0ecec"}}}},"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":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"message":"Could not find service with id some_id.","errorId":"618e2fb0-a198-4d9d-9219-13e51ef0ecec"}}}},"409":{"description":"Conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service unavailable.","content":{}}},"security":[{"bearerAuth":[]}]}},"/api/v2/missionControl/eventBrokerServices/{serviceId}/serverCertificates":{"get":{"tags":["Server Certificates"],"summary":"(Beta) Get all server certificates","description":"Get all server certificates for the event broker service.
Your token must have one of the permissions listed in the Token Permissions.
mission_control:access or services:get ]","operationId":"getAllServerCertificates","parameters":[{"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/ServerCertificateSummaryResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"message":"Bad request.","errorId":"618e2fb0-a198-4d9d-9219-13e51ef0ecec"}}}},"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":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"message":"Could not find resource with id some_id.","errorId":"618e2fb0-a198-4d9d-9219-13e51ef0ecec"}}}},"409":{"description":"Conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service unavailable.","content":{}}},"security":[{"bearerAuth":[]}]},"post":{"tags":["Server Certificates"],"summary":"(Beta) Initiate an upload of a server certificate","description":"Upload a server certificate for the event broker service.
Note: The Try It! feature for this API does not work. To use this API, you must:
certificate parameter in the body of the POST.privateKey parameter in the body of the POST.For more information, see Managing Custom TLS Server Certificates for an Event Broker Service in the Solace documentation.
Your token must have one of the permissions listed in the Token Permissions.
services:post or mission_control:access ]","operationId":"uploadServerCertificate","parameters":[{"name":"serviceId","in":"path","description":"The unique identifier of the event broker service.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The request to upload a server certificate.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadCertificateRequest"}}},"required":true},"responses":{"202":{"description":"Accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"message":"Bad request.","errorId":"618e2fb0-a198-4d9d-9219-13e51ef0ecec"}}}},"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":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"message":"Could not find resource with id some_id.","errorId":"618e2fb0-a198-4d9d-9219-13e51ef0ecec"}}}},"409":{"description":"Conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service unavailable.","content":{}}},"security":[{"bearerAuth":[]}]}},"/api/v2/missionControl/eventBrokerServices/{serviceId}/serverCertificates/{certificateId}":{"get":{"tags":["Server Certificates"],"summary":"(Beta) Get a server certificate by its ID","description":"Get a server certificate by its ID for the event broker service.
Your token must have one of the permissions listed in the Token Permissions.
mission_control:access or services:get ]","operationId":"getServerCertificateById","parameters":[{"name":"serviceId","in":"path","description":"The unique identifier of the event broker service.","required":true,"schema":{"type":"string"}},{"name":"certificateId","in":"path","description":"The unique identifier of the server certificate.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerCertificateResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"message":"Bad request.","errorId":"618e2fb0-a198-4d9d-9219-13e51ef0ecec"}}}},"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":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"message":"Could not find resource with id some_id.","errorId":"618e2fb0-a198-4d9d-9219-13e51ef0ecec"}}}},"409":{"description":"Conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service unavailable.","content":{}}},"security":[{"bearerAuth":[]}]},"delete":{"tags":["Server Certificates"],"summary":"(Beta) Delete a server certificate by its ID","description":"Delete a server certificate by its ID for the event broker service.
Your token must have one of the permissions listed in the Token Permissions.
mission_control:access or services:delete ]","operationId":"deleteServerCertificateById","parameters":[{"name":"serviceId","in":"path","description":"The unique identifier of the event broker service.","required":true,"schema":{"type":"string"}},{"name":"certificateId","in":"path","description":"The unique identifier of the server certificate.","required":true,"schema":{"type":"string"}}],"responses":{"202":{"description":"Accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"message":"Bad request.","errorId":"618e2fb0-a198-4d9d-9219-13e51ef0ecec"}}}},"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":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"message":"Could not find resource with id some_id.","errorId":"618e2fb0-a198-4d9d-9219-13e51ef0ecec"}}}},"409":{"description":"Conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service unavailable.","content":{}}},"security":[{"bearerAuth":[]}]}},"/api/v2/missionControl/eventBrokerServices/{serviceId}/serverCertificates/{certificateId}/install":{"post":{"tags":["Server Certificates"],"summary":"(Beta) Initiate installation of a server certificate by its ID","description":"Install a server certificate by its ID for the event broker service.
Your token must have one of the permissions listed in the Token Permissions.
services:post or mission_control:access ]","operationId":"installServerCertificate","parameters":[{"name":"serviceId","in":"path","description":"The unique identifier of the event broker service.","required":true,"schema":{"type":"string"}},{"name":"certificateId","in":"path","description":"The unique identifier of the server certificate.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The request to install a server certificate.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstallCertificateRequest"}}},"required":true},"responses":{"202":{"description":"Accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"message":"Bad request.","errorId":"618e2fb0-a198-4d9d-9219-13e51ef0ecec"}}}},"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":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"message":"Could not find resource with id some_id.","errorId":"618e2fb0-a198-4d9d-9219-13e51ef0ecec"}}}},"409":{"description":"Conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service unavailable.","content":{}}},"security":[{"bearerAuth":[]}]}}},"components":{"schemas":{"BasicAuthAvailability":{"required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Select a value in the field to indicate whether basic authentication should be enabled or disabled for the event broker service. The valid values are:\ntrue-enables basic authenticationfalse-disables basic authenticationRemoval Date: 2024-05-26
Reason: Replaced by apiQueueManagementCopyFromOnCreateTemplateName
The name of a queue template to copy settings from when a new queue is created by the client using the client profile. If the specified queue template does not exist, creation fails. Deprecated since 2.14. This attribute has been replaced with apiQueueManagementCopyFromOnCreateTemplateName.
","deprecated":true},"apiQueueManagementCopyFromOnCreateTemplateName":{"maxLength":255,"minLength":0,"type":"string","description":"The name of a queue template to copy settings from when a new queue is created by the client using the client profile. If the specified queue template does not exist, creation fails."},"apiTopicEndpointManagementCopyFromOnCreateName":{"maxLength":200,"minLength":0,"type":"string","description":"Removal Date: 2024-05-26
Reason: Replaced by apiTopicEndpointManagementCopyFromOnCreateTemplateName
The name of a topic endpoint to copy settings from when a new topic endpoint is created by the client using the client profile. If the specified topic endpoint does not exist, creation fails. Deprecated since 2.14. This attribute has been replaced with apiTopicEndpointManagementCopyFromOnCreateTemplateName.
","deprecated":true},"apiTopicEndpointManagementCopyFromOnCreateTemplateName":{"maxLength":255,"minLength":0,"type":"string","description":"The name of a topic endpoint to copy settings from when a new topic endpoint is created by the client using the client profile. If the specified topic endpoint does not exist, creation fails."},"serviceMinKeepaliveTimeout":{"type":"integer","description":"The minimum period of time (in seconds) that the event broker service will tolerate inactivity on the client connection. This keepalive value is also enforced for MQTT and SMF (Solace Message Format) connections. The keepalive timeout value is calculated based on the client provided timeout interval (3 x the keepalive interval for SMF, 1.5 x the keepalive interval for MQTT). The default is 30 and valid ranges are 3–3600.","format":"int32"},"serviceSmfMinKeepaliveEnabled":{"type":"boolean","description":"Indicates whether clients using the client profile have the minimum keep-alive timeout enabled for SMF (Solace Message Format) connections. The valid values are 'true' (enabled) and 'false' (not enabled). The default is 'false'."},"serviceWebInactiveTimeout":{"type":"integer","description":"The number of seconds a Web client has to send a request before its session times out and be terminated for being inactive. The default value is 30 seconds.","format":"int32"},"serviceWebMaxPayload":{"type":"integer","description":"The maximum transport payload size (in bytes) before fragmentation occurs for clients using the client profile. The size of the header is not included.\n\nSolace Message Format (SMF) messages that are sent to a consuming Web client are contained within a Web transport message that the event broker sends in its HTTP response to that client. Each Web transport message that is sent can contain multiple SMF messages or partial SMF messages.\nThe maximum Web payload value sets the maximum number of bytes allowed in a single Web transport message (not including the header). This value determines the number of SMF messages that can be sent in a single HTTP response and the size of the Web transport message sent in the HTTP response. The value range is 300 to 10000000, in bytes. The default is 1000000 bytes.\n\nSMF messages that are sent to a consuming Web client are contained within a Web transport message that the event broker sends in its HTTP response to that client. Each Web transport message that is sent can contain multiple SMF messages or partial SMF messages.\n\nThe maximum Web payload value sets the maximum number of bytes allowed in a single Web transport message (not including the header). This value determines the number of SMF messages that can be sent in a single HTTP response and the size of the Web transport message sent in the HTTP response. Note that large SMF messages can be fragmented across Web transport messages to respect the value set for the maximum possible Web payload.\n)","format":"int32"},"maxConnectionCountPerClientUsername":{"type":"integer","description":"The maximum permitted number of simultaneous Web transport client connections to the event broker service that can be made using the same client username account. The default is the maximum value supported by the platform.","format":"int32"},"serviceSmfMaxConnectionCountPerClientUsername":{"type":"integer","description":"The maximum permitted number of simultaneous Solace Message Format (SMF) client connections to the event broker that can be made using the same client username account. The default is the maximum value supported by the platform.","format":"int32"},"serviceWebMaxConnectionCountPerClientUsername":{"type":"integer","description":"The maximum permitted number of simultaneous Web transport client connections to the event broker service that can be made using the same client username account. The default is the maximum value supported by the platform.","format":"int32"},"maxEndpointCountPerClientUsername":{"type":"integer","description":"The maximum number of durable and non-durable queues and topic endpoints that can be owned by the clients using the same client username within a client profile. The default is 1000.","format":"int32"},"maxEgressFlowCount":{"type":"integer","description":"The maximum number of egress flows (that is, Guaranteed Message client receive flows or consumer flows) that can be created by a single client associated with this client profile. The default is 1000.","format":"int32"},"maxIngressFlowCount":{"type":"integer","description":"The maximum number of ingress flows (that is, Guaranteed Message client publish flows) that can be created by a single client associated with this client profile. The default is 1000.","format":"int32"},"maxSubscriptionCount":{"type":"integer","description":"The maximum number of subscriptions for a single client in the client profile. When you set this option, consider the total maximum number of permitted topic subscriptions and the total maximum number of client connections for the type of event broker that is used. That is, to ensure reliable system performance, you must find the right balance for your network, while staying within the system limits mentioned. The balance is generally between allowing the creation of many client applications and allowing each client to add a large number of topic subscriptions. The default varies by platform.","format":"int32"},"maxTransactedSessionCount":{"type":"integer","description":"The maximum number of simultaneous transacted sessions and/or XA sessions allowed for a single client associated with the client profile. The default is 10.","format":"int32"},"maxTransactionCount":{"type":"integer","description":"The total maximum number of simultaneous transactions (both local transactions and transactions within the XA transaction branches) allowed for a single client associated with the client profile. The default varies by platform.","format":"int32"},"queueGuaranteed1MaxDepth":{"type":"integer","description":"The egress queue maximum depth for Guaranteed Messages that represents the number of work units for the client priority queues. The valid range is 2 to 262144. The default is 20000.","format":"int32"},"queueGuaranteed1MinMsgBurst":{"type":"integer","description":"The minimum number of messages that must be on the Guaranteed Message queue before the queue’s depth is checked against the maximum depth setting (thereby allowing the queue to absorb a burst of large messages that exceeds the number of allowed work units). A valid range is 0 to 262144 with the default of 255. The value of 255 is recommended for memory usage optimized configurations, such as message applications; a value of 66000 is for WAN optimized configurations.","format":"int32"},"queueDirect1MaxDepth":{"type":"integer","description":"The egress queue maximum depth for Direct Messages 1 [Class of Service (COS) 1] that represents the number of work units for the client priority queues. The valid range is 2 to 262144. The default is 20000..","format":"int32"},"queueDirect1MinMsgBurst":{"type":"integer","description":"The minimum number of messages that must be on the Direct 1 (COS 1) queue before the queue’s depth is checked against the maximum depth setting (thereby allowing the queue to absorb a burst of large messages that exceeds the number of allowed work units). A valid range is 0 to 262144 with the default of 4.","format":"int32"},"queueDirect2MaxDepth":{"type":"integer","description":"The egress queue maximum depth for Direct Messages 2 (COS 2) that represents the number of work units for the client priority queues. The valid range is 2 to 262144. The default is 20000.","format":"int32"},"queueDirect2MinMsgBurst":{"type":"integer","description":"The minimum number of messages that must be on the Direct 2 (COS 2) queue before the queue’s depth is checked against the maximum depth setting (thereby allowing the queue to absorb a burst of large messages that exceeds the number of allowed work units). A valid range is 0 to 262144 with the default of 4.","format":"int32"},"queueDirect3MaxDepth":{"type":"integer","description":"The egress queue maximum depth for Direct Messages 3 [Class of Service (COS) 3] that represents the number of work units for the client priority queues. The valid range is 2 to 262144. The default is 20000.","format":"int32"},"queueDirect3MinMsgBurst":{"type":"integer","description":"The minimum number of messages that must be on the Direct 3 (COS 3) queue before the queue’s depth is checked against the maximum depth setting (thereby allowing the queue to absorb a burst of large messages that exceeds the number of allowed work units). A valid range is 0 to 262144 with the default of 4.","format":"int32"},"queueControl1MaxDepth":{"type":"integer","description":"The egress queue maximum depth for Control 1 that represents the number of work units for the client priority queues. The valid range is 2 to 262144. The default is 20000.","format":"int32"},"queueControl1MinMsgBurst":{"type":"integer","description":"The minimum number of messages that must be on the Direct 1 (COS 1) queue before the queue’s depth is checked against the maximum depth setting (thereby allowing the queue to absorb a burst of large messages that exceeds the number of allowed work units). A valid range is 0 to 262144 with the default of 4.","format":"int32"},"tcpCongestionWindowSize":{"type":"integer","description":"The TCP initial congestion window size is the number of segments that TCP sends before waiting for an acknowledgment from the peer. The TCP initial congestion window size is used when starting up a TCP connection or on recovery from idle (that is, no traffic). Larger values of the initial window allows a connection to come up to speed more quickly. For further details, refer to RFC 2581.\nChanging the TCP initial congestion window size from its default of 2 results in non-compliance with RFC 2581. Further, if this setting is set to a value too high, it may cause congestion in the network. Contact support before you attempt to change this TCP parameter.","format":"int32"},"tcpKeepaliveCount":{"type":"integer","description":"The maximum number of keepalive probes (from 2 to 5 ) that TCP should send before dropping the connection. The default is 5.","format":"int32"},"tcpKeepaliveIdleTime":{"type":"integer","description":"The time (from 3 to 120 seconds) a connection must remain idle before TCP begins sending keepalive probes. The default is 3.","format":"int32"},"tcpKeepaliveInterval":{"type":"integer","description":"The time (from 1 to 30 seconds) to set as the interval between individual keepalive probes. The default is 1.","format":"int32"},"tcpMaxSegmentSize":{"type":"integer","description":"The TCP maximum segment size (MSS) used for client to the event broker service. The default is 1460.","format":"int32"},"tcpMaxWindowSize":{"type":"integer","description":"The TCP window size between the event broker service and the client.\nIf the maximum window size is set to less than the bandwidth-delay product, then the TCP connection operates below its maximum potential throughput. If the maximum window is set to less than about twice the bandwidth-delay product, then occasional packet loss causes the TCP connection to operate below its maximum potential throughput as it handles the missing acknowledgments and retransmissions. The default is 256.\n\nAlternately, if the TCP maximum window size is set too large, in the presence of a high offered load, TCP gradually increases its congestion window size until either the congestion window size reaches the maximum window size, or packet loss occurs in the network.\n\nInitially, when the TCP congestion window size is small, the physical bandwidth-delay of the network acts as a memory buffer for packets in flight. But as the congestion window crosses the bandwidth-delay product, the buffering of in-flight packets moves to queues in event broker services and other equipment throughout the network. As the TCP congestion window continues to increase in size, these various equipment queues overflow, causing packet loss and TCP backoff.","format":"int32"},"elidingDelay":{"type":"integer","description":"The amount of time to delay the delivery of messages to a client after the initial message has been delivered. You can specify a value from 0-6000 milliseconds. The default is 0.","format":"int32"},"elidingEnabled":{"type":"boolean","description":"Indicates whether clients assigned to the client profile are allowed to use eliding. Eliding allows clients to define a custom per-topic rate for client applications so they can effectively consume relevant messages, rather than queuing up outdated messages. For example, when eliding is configured, clients could receive direct messages for their topic subscriptions at a rate of at most five per second, per topic–even though the source is publishing updates at a much higher rate. The valid values are 'true' (enabled) and 'false' (not enabled). The default is 'false'."},"elidingMaxTopicCount":{"type":"integer","description":"The maximum number of topics the event broker service that can track for performing the eliding function on each client connection. You can specify a value from 1-320000. The default is 256.","format":"int32"},"rejectMsgToSenderOnNoSubscriptionMatchEnabled":{"type":"boolean","description":"Indicates whether clients assigned the client profile are allowed to return NACKs (negative acknowledgements) for guaranteed messages that do not have a that do not have a matching guaranteed message subscription. The value values are 'true' (allowed) and 'false' (not allowed). The default is 'false'."},"tlsAllowDowngradeToPlainTextEnabled":{"type":"boolean","description":"Indicates whether clients assigned the client profile are allowed to use TLS/SSL encryption to protect the clients' credentials. This setting doesn't encrypt the data that is transmitted after the clients are authenticated and authorized. This also allows connecting client applications to request to downgrade of their TLS/SSL connections to the Message VPN to a plain-text connection, and if that Message VPN allows TLS/SSL connection downgrades, after the clientsʼ login handshake are finished, their connections are downgraded. This means that the clientsʼ authentication data is still encrypted, but the subsequent application data that is transmitted is sent as non-encrypted plain-text. The valid values are 'true (allowed) or 'false (not allowed). The default is 'true'."},"eventClientProvisionedEndpointSpoolUsageThreshold":{"$ref":"#/components/schemas/ProvisionedEndpointSpoolUsageAlertThresholds"}},"description":"The client profile configured on the event broker service."},"ClientProfileBase":{"required":["name"],"type":"object","properties":{"name":{"maxLength":32,"minLength":1,"pattern":"[a-zA-Z0-9-_]*","type":"string","description":"The name of the client profile."}},"description":"The client profile configured on the event broker service."},"ClientProfileRequest":{"type":"object","properties":{"name":{"maxLength":32,"minLength":1,"pattern":"[a-zA-Z0-9-_]*","type":"string"},"allowGuaranteedMsgSendEnabled":{"type":"boolean","description":"Indicates whether clients assigned to the client profile are allowed to publish guaranteed messages. The valid values are 'true' (allowed) or 'false' (not allowed) . The default is 'false'."},"allowGuaranteedMsgReceiveEnabled":{"type":"boolean","description":"Indicates whether clients assigned to the client profile are allowed to bind to topic endpoints or queues to receive guaranteed messages. The valid values are 'true' (allowed) or 'false' (not allowed). The default is 'false'."},"compressionEnabled":{"type":"boolean","description":"Indicates whether clients assigned to the client profile are allowed to transfer data using compression. The valid values are 'true' (allowed) and 'false' (not allowed). The default is 'true'."},"replicationAllowClientConnectWhenStandbyEnabled":{"type":"boolean","description":"Indicates whether clients assigned to the client profile are allowed to remain connected to the Message VPN when its replication state is Standby. This situation may occur when the Message VPN Replication state of the event broker service changes from Active to Standby. The valid values are 'true' (allowed) and 'false' (not allowed). The default is 'false'."},"allowTransactedSessionsEnabled":{"type":"boolean","description":"Indicates whether client applications client applications assigned to the client profile are allowed to establish transacted sessions or XA sessions. The valid values are 'true' (allowed) and 'false' (not allowed). The default is 'false'."},"allowBridgeConnectionsEnabled":{"type":"boolean","description":"Indicates whether clients assigned to the client profile are allowed to establish Dynamic Messaging Routing (DMR) links (or bridge links) from the current Message VPN to another Message VPN in a separate event broker service. The valid values are 'true' (allowed) and 'false' (not allowed). The default is 'false'."},"allowGuaranteedEndpointCreateEnabled":{"type":"boolean","description":"Indicates whether clients assigned to the client profile are allowed to create queues or topic endpoints. The valid values are 'true' (allowed) and 'false' (not allowed). The default is 'false'."},"allowSharedSubscriptionsEnabled":{"type":"boolean","description":"Indicates whether clients assigned to the client profile are allowed to use shared subscriptions. The valid values are 'true' (allowed) and 'false' (not allowed). The default is 'false'."},"apiQueueManagementCopyFromOnCreateName":{"maxLength":200,"minLength":0,"type":"string","description":"Removal Date: 2024-05-26
Reason: Replaced by apiQueueManagementCopyFromOnCreateTemplateName
The name of a queue template to copy settings from when a new queue iscreated by the client using the client profile. If the specified queue template does not exist, creation fails. Deprecated since 2.14. This attribute has been replaced with apiQueueManagementCopyFromOnCreateTemplateName.
","deprecated":true},"apiQueueManagementCopyFromOnCreateTemplateName":{"maxLength":255,"minLength":0,"type":"string","description":"The name of a queue template to copy settings from when a new queue is created by the client using the client profile. If the specified queue template does not exist, creation fails. "},"apiTopicEndpointManagementCopyFromOnCreateName":{"maxLength":200,"minLength":0,"type":"string","description":"Removal Date: 2024-05-26
Reason: Replaced by apiTopicEndpointManagementCopyFromOnCreateTemplateName
The name of a topic endpoint to copy settings from when a new topic endpoint is created by the client using the client profile. If the specified topic endpoint does not exist, creation fails. Deprecated since 2.14. This attribute has been replaced with apiTopicEndpointManagementCopyFromOnCreateTemplateName.
","deprecated":true},"apiTopicEndpointManagementCopyFromOnCreateTemplateName":{"maxLength":255,"minLength":0,"type":"string","description":"The name of a topic endpoint to copy settings from when a new topic endpoint is created by the client using the client profile. If the specified topic endpoint does not exist, creation fails."},"serviceMinKeepaliveTimeout":{"type":"integer","description":"The minimum period of time (in seconds) that the event broker service will tolerate inactivity on the client connection. This keepalive value is also enforced for MQTT and SMF (Solace Message Format) connections. The keepalive timeout value is calculated based on the client provided timeout interval (3 x the keepalive interval for SMF, 1.5 x the keepalive interval for MQTT). The default is 30 and valid ranges are 3–3600.","format":"int32"},"serviceSmfMinKeepaliveEnabled":{"type":"boolean","description":"Indicates whether clients using the client profile have the minimum keep-alive timeout enabled for SMF (Solace Message Format) connections. The valid values are 'true' (enabled) and 'false' (not enabled). The default is 'false'."},"serviceWebInactiveTimeout":{"type":"integer","description":"The number of seconds a Web client has to send a request before its session times out and be terminated for being inactive. The default value is 30 seconds.","format":"int32"},"serviceWebMaxPayload":{"type":"integer","description":"The maximum transport payload size (in bytes) before fragmentation occurs for clients using the client profile. The size of the header is not included.\n\nSolace Message Format (SMF) messages that are sent to a consuming Web client are contained within a Web transport message that the event broker sends in its HTTP response to that client. Each Web transport message that is sent can contain multiple SMF messages or partial SMF messages.\nThe maximum Web payload value sets the maximum number of bytes allowed in a single Web transport message (not including the header). This value determines the number of SMF messages that can be sent in a single HTTP response and the size of the Web transport message sent in the HTTP response. The value range is 300 to 10000000, in bytes. The default is 1000000 bytes.\n\nSMF messages that are sent to a consuming Web client are contained within a Web transport message that the event broker sends in its HTTP response to that client. Each Web transport message that is sent can contain multiple SMF messages or partial SMF messages.\n\nThe maximum Web payload value sets the maximum number of bytes allowed in a single Web transport message (not including the header). This value determines the number of SMF messages that can be sent in a single HTTP response and the size of the Web transport message sent in the HTTP response. Note that large SMF messages can be fragmented across Web transport messages to respect the value set for the maximum possible Web payload.","format":"int32"},"maxConnectionCountPerClientUsername":{"type":"integer","description":"The maximum permitted number of simultaneous Web transport client connections to the event broker service that can be made using the same client username account. The default is the maximum value supported by the platform.","format":"int32"},"serviceSmfMaxConnectionCountPerClientUsername":{"type":"integer","description":"The maximum permitted number of simultaneous Solace Message Format (SMF) client connections to the event broker that can be made using the same client username account. The default is the maximum value supported by the platform.","format":"int32"},"serviceWebMaxConnectionCountPerClientUsername":{"type":"integer","description":"The maximum permitted number of simultaneous Web transport client connections to the event broker service that can be made using the same client username account. The default is the maximum value supported by the platform.","format":"int32"},"maxEndpointCountPerClientUsername":{"type":"integer","description":"The maximum number of durable and non-durable queues and topic endpoints that can be owned by the clients using the same client username within a client profile. The default is 1000.","format":"int32"},"maxEgressFlowCount":{"type":"integer","description":"The maximum number of egress flows (that is, Guaranteed Message client receive flows or consumer flows) that can be created by a single client associated with this client profile. The default is 1000.","format":"int32"},"maxIngressFlowCount":{"type":"integer","description":"The maximum number of ingress flows (that is, Guaranteed Message client publish flows) that can be created by a single client associated with this client profile. The default is 1000.","format":"int32"},"maxSubscriptionCount":{"type":"integer","description":"The maximum number of subscriptions for a single client in the client profile. When you set this option, consider the total maximum number of permitted topic subscriptions and the total maximum number of client connections for the type of event broker that is used. That is, to ensure reliable system performance, you must find the right balance for your network, while staying within the system limits mentioned. The balance is generally between allowing the creation of many client applications and allowing each client to add a large number of topic subscriptions. The default varies by platform.","format":"int32"},"maxTransactedSessionCount":{"type":"integer","description":"The maximum number of simultaneous transacted sessions and/or XA sessions allowed for a single client associated with the client profile. The default is 10.","format":"int32"},"maxTransactionCount":{"type":"integer","description":"The total maximum number of simultaneous transactions (both local transactions and transactions within the XA transaction branches) allowed for a single client associated with the client profile. The default varies by platform.","format":"int32"},"queueGuaranteed1MaxDepth":{"type":"integer","description":"The egress queue maximum depth for Guaranteed Messages that represents the number of work units for the client priority queues. The valid range is 2 to 262144. The default is 20000.","format":"int32"},"queueGuaranteed1MinMsgBurst":{"type":"integer","description":"The minimum number of messages that must be on the Guaranteed Message queue before the queue’s depth is checked against the maximum depth setting (thereby allowing the queue to absorb a burst of large messages that exceeds the number of allowed work units). A valid range is 0 to 262144 with the default of 255. The value of 255 is recommended for memory usage optimized configurations, such as message applications; a value of 66000 is for WAN optimized configurations.","format":"int32"},"queueDirect1MaxDepth":{"type":"integer","description":"The egress queue maximum depth for Direct Messages 1 [Class of Service (COS) 1] that represents the number of work units for the client priority queues. The valid range is 2 to 262144. The default is 20000.","format":"int32"},"queueDirect1MinMsgBurst":{"type":"integer","description":"The minimum number of messages that must be on the Direct 1 (COS 1) queue before the queue’s depth is checked against the maximum depth setting (thereby allowing the queue to absorb a burst of large messages that exceeds the number of allowed work units). A valid range is 0 to 262144 with the default of 4.","format":"int32"},"queueDirect2MaxDepth":{"type":"integer","description":"The egress queue maximum depth for Direct Messages 2 (COS 2) that represents the number of work units for the client priority queues. The valid range is 2 to 262144. The default is 20000.","format":"int32"},"queueDirect2MinMsgBurst":{"type":"integer","description":"The minimum number of messages that must be on the Direct 2 (COS 2) queue before the queue’s depth is checked against the maximum depth setting (thereby allowing the queue to absorb a burst of large messages that exceeds the number of allowed work units). A valid range is 0 to 262144 with the default of 4.","format":"int32"},"queueDirect3MaxDepth":{"type":"integer","description":"The egress queue maximum depth for Direct Messages 3 [Class of Service (COS) 3] that represents the number of work units for the client priority queues. The valid range is 2 to 262144. The default is 20000.","format":"int32"},"queueDirect3MinMsgBurst":{"type":"integer","description":"The minimum number of messages that must be on the Direct 3 (COS 3) queue before the queue’s depth is checked against the maximum depth setting (thereby allowing the queue to absorb a burst of large messages that exceeds the number of allowed work units). A valid range is 0 to 262144 with the default of 4.","format":"int32"},"queueControl1MaxDepth":{"type":"integer","description":"The egress queue maximum depth for Control 1 that represents the number of work units for the client priority queues. The valid range is 2 to 262144. The default is 20000.","format":"int32"},"queueControl1MinMsgBurst":{"type":"integer","description":"The minimum number of messages that must be on the Direct 1 (COS 1) queue before the queue’s depth is checked against the maximum depth setting (thereby allowing the queue to absorb a burst of large messages that exceeds the number of allowed work units). A valid range is 0 to 262144 with the default of 4.","format":"int32"},"tcpCongestionWindowSize":{"type":"integer","description":"The TCP initial congestion window size is the number of segments that TCP sends before waiting for an acknowledgment from the peer. The TCP initial congestion window size is used when starting up a TCP connection or on recovery from idle (that is, no traffic). Larger values of the initial window allows a connection to come up to speed more quickly. For further details, refer to RFC 2581.\nChanging the TCP initial congestion window size from its default of 2 results in non-compliance with RFC 2581. Further, if this setting is set to a value too high, it may cause congestion in the network. Contact support before you attempt to change this TCP parameter.","format":"int32"},"tcpKeepaliveCount":{"type":"integer","description":"The maximum number of keepalive probes (from 2 to 5 ) that TCP should send before dropping the connection. The default is 5.","format":"int32"},"tcpKeepaliveIdleTime":{"type":"integer","description":"The time (from 3 to 120 seconds) a connection must remain idle before TCP begins sending keepalive probes. The default is 3.","format":"int32"},"tcpKeepaliveInterval":{"type":"integer","description":"The time (from 1 to 30 seconds) to set as the interval between individual keepalive probes. The default is 1.","format":"int32"},"tcpMaxSegmentSize":{"type":"integer","description":"The TCP maximum segment size (MSS) used for client to the event broker service. The default is 1460.","format":"int32"},"tcpMaxWindowSize":{"type":"integer","description":"The TCP window size between the event broker service and the client.\nIf the maximum window size is set to less than the bandwidth-delay product, then the TCP connection operates below its maximum potential throughput. If the maximum window is set to less than about twice the bandwidth-delay product, then occasional packet loss causes the TCP connection to operate below its maximum potential throughput as it handles the missing acknowledgments and retransmissions. The default is 256.\n\nAlternately, if the TCP maximum window size is set too large, in the presence of a high offered load, TCP gradually increases its congestion window size until either the congestion window size reaches the maximum window size, or packet loss occurs in the network.\n\nInitially, when the TCP congestion window size is small, the physical bandwidth-delay of the network acts as a memory buffer for packets in flight. But as the congestion window crosses the bandwidth-delay product, the buffering of in-flight packets moves to queues in event broker services and other equipment throughout the network. As the TCP congestion window continues to increase in size, these various equipment queues overflow, causing packet loss and TCP backoff.","format":"int32"},"elidingDelay":{"type":"integer","description":"The amount of time to delay the delivery of messages to a client after the initial message has been delivered. You can specify a value from 0-6000 milliseconds. The default is 0.","format":"int32"},"elidingEnabled":{"type":"boolean","description":"Indicates whether clients assigned to the client profile are allowed to use eliding. Eliding allows clients to define a custom per-topic rate for client applications so they can effectively consume relevant messages, rather than queuing up outdated messages. For example, when eliding is configured, clients could receive direct messages for their topic subscriptions at a rate of at most five per second, per topic–even though the source is publishing updates at a much higher rate. The valid values are 'true' (enabled) and 'false' (not enabled). The default is 'false'."},"elidingMaxTopicCount":{"type":"integer","description":"The maximum number of topics the event broker service that can track for performing the eliding function on each client connection. You can specify a value from 1-320000. The default is 256.","format":"int32"},"rejectMsgToSenderOnNoSubscriptionMatchEnabled":{"type":"boolean","description":"Indicates whether clients assigned the client profile are allowed to return NACKs (negative acknowledgements) for guaranteed messages that do not have a that do not have a matching guaranteed message subscription. The value values are 'true' (allowed) and 'false' (not allowed). The default is 'false'."},"tlsAllowDowngradeToPlainTextEnabled":{"type":"boolean","description":"Indicates whether clients assigned the client profile are allowed to use TLS/SSL encryption to protect the clients' credentials. This setting doesn't encrypt the data that is transmitted after the clients are authenticated and authorized. This also allows connecting client applications to request to downgrade of their TLS/SSL connections to the Message VPN to a plain-text connection, and if that Message VPN allows TLS/SSL connection downgrades, after the clientsʼ login handshake are finished, their connections are downgraded. This means that the clientsʼ authentication data is still encrypted, but the subsequent application data that is transmitted is sent as non-encrypted plain-text. The valid values are 'true (allowed) or 'false (not allowed). The default is 'true'."},"eventClientProvisionedEndpointSpoolUsageThreshold":{"$ref":"#/components/schemas/ProvisionedEndpointSpoolUsageAlertThresholds"},"id":{"type":"string"},"type":{"type":"string"}},"description":"The client profile configured on the event broker service."},"ClientProfileResponse":{"required":["data","meta"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/ClientProfile"},"meta":{"type":"object","additionalProperties":{"type":"object"}}}},"ClientProfileSummary":{"required":["name"],"type":"object","properties":{"name":{"maxLength":32,"minLength":1,"pattern":"[a-zA-Z0-9-_]*","type":"string","description":"The name of the client profile."},"id":{"type":"string","description":"The identifier of the client profile."},"type":{"type":"string","description":"The type of object for informational purposes."},"allowGuaranteedMsgSendEnabled":{"type":"boolean","description":"Indicates whether clients assigned the client profile are allowed to publish guaranteed messages. The valid values are 'true' (allowed) and 'false' (not allowed). The default is 'false'."},"allowGuaranteedMsgReceiveEnabled":{"type":"boolean","description":"Indicates whether clients assigned to the client profile are allowed to bind to topic endpoints or queues to receive guaranteed messages. The valid values are 'true' (allowed) or 'false' (not allowed). The default is 'false'."},"allowTransactedSessionsEnabled":{"type":"boolean","description":"Indicates whether clients assigned to the client profile are allowed to establish transacted sessions or XA sessions. The valid values are 'true' (allowed) and 'false' (not allowed). The default is 'true'."},"allowBridgeConnectionsEnabled":{"type":"boolean","description":"Indicates whether clients assigned to the client profile are allowed to establish Dynamic Messaging Routing (DMR) links (or bridge links) from the current Message VPN to another Message VPN in a separate event broker service. The valid values are 'true' (allowed) and 'false' (not allowed). The default is 'false'."},"allowGuaranteedEndpointCreateEnabled":{"type":"boolean","description":"Indicates whether clients assigned to the client profile are allowed to create queues or topic endpoints. The valid values are 'true' (allowed) and 'false' (not allowed). The default is 'false'."}},"description":"The client profile configured on the event broker service."},"ClientProfilesResponse":{"required":["data","meta"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ClientProfileSummary"}},"meta":{"type":"object","additionalProperties":{"type":"object"}}}},"CloneServiceRequest":{"required":["datacenterId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the clone service request.","readOnly":true},"type":{"type":"string","description":"The type of object for informational purposes.","readOnly":true},"name":{"type":"string","description":"The event broker service name.","example":"my-service-name"},"datacenterId":{"minLength":1,"type":"string","description":"The identifier of the datacenter.","example":"k8s-us-east-1"},"serviceConnectionEndpoints":{"type":"array","description":"The collection of service connection endpoints.","items":{"$ref":"#/components/schemas/ConnectionEndpoint"}},"serviceCloneAttributes":{"$ref":"#/components/schemas/ServiceCloneAttributes"},"customRouterName":{"maxLength":12,"minLength":3,"pattern":"^[a-z0-9]*$","type":"string","description":"The unique prefix for the name of the router for the event broker service. The prefix must be constructed using only lower-case, alphanumeric characters.
When the customRouterName value is defined, it is added as a prefix to the event broker service node role, and \"cn\" (custom name) is appended to the end to create the custom router name, for example, \"customprimarycn\".
If the customRouterName value is left blank, the prefix defaults to the service id of the event broker service. This is prefixed to the event broker service node role to create the router name, for example, \"bd37t1d5h4kprimary\".
Note: customRouterName is only supported on event broker versions 10.4 or greater.
","example":"abc123"},"environmentId":{"type":"string","description":"The unique identifier of the environment where you want to create the service.\n\nYou can only specify an environment identifier when creating services in a Public Region. You cannot specify an environment identifier when creating a service in a Dedicated Region.\n\nCreating a service in a Public Region without specifying an environment identifier places it in the default environment.\n"}}},"Cluster":{"type":"object","properties":{"name":{"type":"string","description":"The name of the DMR cluster."},"password":{"type":"string","description":"The password for the cluster.","format":"password"},"remoteAddress":{"type":"string","description":"The address of the remote node in the cluster."},"primaryRouterName":{"type":"string","description":"The name of the primary event broker."},"backupRouterName":{"type":"string","description":"The name of the backup event broker."},"monitoringRouterName":{"type":"string","description":"The name of the monitoring node."},"supportedAuthenticationMode":{"type":"array","description":"The authentication mode between the nodes in the DMR cluster.","items":{"type":"string","description":"The authentication mode between the nodes in the DMR cluster."}}},"description":"The DMR cluster details."},"ConnectionEndpoint":{"required":["accessType","name","ports"],"type":"object","properties":{"id":{"type":"string","description":"The identifier of the connection endpoint.","readOnly":true},"type":{"type":"string","description":"The type of object for informational purposes.","readOnly":true},"name":{"type":"string","description":"The name of the connection endpoint."},"description":{"type":"string","description":"The description for the connection endpoint."},"accessType":{"$ref":"#/components/schemas/ConnectionEndpointAccessType"},"k8sServiceType":{"type":"string","description":"The connectivity configuration that is used in the Kubernetes cluster.","readOnly":true,"enum":["LOADBALANCER","NODEPORT","CLUSTERIP"]},"k8sServiceId":{"type":"string","description":"The identifier for the Kubernetes service.","readOnly":true},"creationState":{"$ref":"#/components/schemas/CreationState"},"ports":{"minItems":1,"type":"array","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.
\nConnection specific protocols.
\nThe protocols and port numbers of the connection endpoint. The serviceManagementTlsListenPort and serviceSmfTlsListenPort protocols\nalong with the port numbers must be specified in the request.
\nConnection specific protocols.
\nThe unique prefix for the name of the router for the event broker service. The prefix must be constructed using only lower-case, alphanumeric characters.
When the customRouterName value is defined, it’s value is added as a prefix to the high-availability role (\"primary\", \"backup\", or \"monitoring\"), and \"cn\" (custom name) is appended to the end to create the custom router name. For example, if you specified a value of \"custom\", the router name is \"customprimarycn\".
If the customRouterName value is left blank, the prefix defaults to the service id of the event broker service. This is prefixed to the event broker service node role to create the router name, for example, \"bd37t1d5h4kprimary\".
Note: customRouterName is only supported on event broker versions 10.4 or later.
","example":"abc123"},"environmentId":{"type":"string","description":"The unique identifier of the environment where you want to create the service.\n\nYou can only specify an environment identifier when creating services in a Public Region. You cannot specify an environment identifier when creating a service in a Dedicated Region.\n\nCreating a service in a Public Region without specifying an environment identifier places it in the default environment.\n"}}},"CreationState":{"type":"string","description":"The creation state of the connection endpoint.","readOnly":true,"enum":["pending","inProgress","completed","failed","migrating"]},"CustomerControlledCluster":{"required":["name","provider","regionId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the datacenter for the customer-controlled cluster."},"name":{"type":"string","description":"The name of the customer-controlled cluster."},"provider":{"type":"string","description":"The cloud provider of the customer-controlled cluster.","example":"eks"},"regionId":{"type":"string","description":"The cloud region of the customer-controlled cluster.","example":"us-east-1"},"environmentId":{"type":"string","description":"The environment for the customer-controlled cluster.","example":"dev"},"useServiceClassSelectors":{"type":"boolean","description":"Whether to use service class node selectors.","example":true,"default":true},"imageRepository":{"type":"string","description":"The container registry to use for downloading Mission Control Agent and event broker images.","example":"gcr.io/my-gcp-project","default":"gcr.io/gcp-maas-prod"},"imagePullSecretName":{"type":"string","description":"The name of the Kubernetes secret that contains the container registry credentials.","example":"my-container-registry-secret","default":"gcr-reg-secret"},"storageClass":{"type":"string","description":"The name of the Kubernetes storage class used for broker persistent volumes.","example":"ssd","default":"gp2"},"cloudAgentPodLabels":{"type":"object","additionalProperties":{"type":"string","description":"The labels to apply to the Mission Control Agent pod.","example":"{key: value}"},"description":"The labels to apply to the Mission Control Agent pod.","example":"{key: value}"},"cloudAgentNodeSelectors":{"type":"object","additionalProperties":{"type":"string","description":"The node selectors to apply to the Mission Control Agent pod.","example":"{key: value}"},"description":"The node selectors to apply to the Mission Control Agent pod.","example":"{key: value}"},"cloudAgentTolerations":{"type":"array","description":"The tolerations to apply to the Mission Control Agent pod.","example":"{key: nodeType, value: agent, effect: NoSchedule, operator: Equal}","items":{"type":"object","additionalProperties":{"type":"string","description":"The tolerations to apply to the Mission Control Agent pod.","example":"{key: nodeType, value: agent, effect: NoSchedule, operator: Equal}"},"description":"The tolerations to apply to the Mission Control Agent pod.","example":"{key: nodeType, value: agent, effect: NoSchedule, operator: Equal}"}},"primaryPodLabels":{"type":"object","additionalProperties":{"type":"string","description":"The labels to apply to the primary pod.","example":"{key: value}"},"description":"The labels to apply to the primary pod.","example":"{key: value}"},"primaryNodeSelectors":{"type":"object","additionalProperties":{"type":"string","description":"The node selectors to apply to the primary pod.","example":"{key: value}"},"description":"The node selectors to apply to the primary pod.","example":"{key: value}"},"primaryTolerations":{"type":"array","description":"The tolerations to apply to the primary pod.","example":"{key: nodeType, value: broker, effect: NoSchedule, operator: Equal}","items":{"type":"object","additionalProperties":{"type":"string","description":"The tolerations to apply to the primary pod.","example":"{key: nodeType, value: broker, effect: NoSchedule, operator: Equal}"},"description":"The tolerations to apply to the primary pod.","example":"{key: nodeType, value: broker, effect: NoSchedule, operator: Equal}"}},"backupPodLabels":{"type":"object","additionalProperties":{"type":"string","description":"The labels to apply to the backup pod.","example":"{key: value}"},"description":"The labels to apply to the backup pod.","example":"{key: value}"},"backupNodeSelectors":{"type":"object","additionalProperties":{"type":"string","description":"The node selectors to apply to the backup pod.","example":"{key: value}"},"description":"The node selectors to apply to the backup pod.","example":"{key: value}"},"backupTolerations":{"type":"array","description":"The tolerations to apply to the backup pod.","example":"{key: nodeType, value: broker, effect: NoSchedule, operator: Equal}","items":{"type":"object","additionalProperties":{"type":"string","description":"The tolerations to apply to the backup pod.","example":"{key: nodeType, value: broker, effect: NoSchedule, operator: Equal}"},"description":"The tolerations to apply to the backup pod.","example":"{key: nodeType, value: broker, effect: NoSchedule, operator: Equal}"}},"monitorPodLabels":{"type":"object","additionalProperties":{"type":"string","description":"The labels to apply to the monitoring pod.","example":"{key: value}"},"description":"The labels to apply to the monitoring pod.","example":"{key: value}"},"monitorNodeSelectors":{"type":"object","additionalProperties":{"type":"string","description":"The node selectors to apply to the monitoring pod.","example":"{key: value}"},"description":"The node selectors to apply to the monitoring pod.","example":"{key: value}"},"monitorTolerations":{"type":"array","description":"The tolerations to apply to the monitoring pod.","example":"{key: nodeType, value: broker, effect: NoSchedule, operator: Equal}","items":{"type":"object","additionalProperties":{"type":"string","description":"The tolerations to apply to the monitoring pod.","example":"{key: nodeType, value: broker, effect: NoSchedule, operator: Equal}"},"description":"The tolerations to apply to the monitoring pod.","example":"{key: nodeType, value: broker, effect: NoSchedule, operator: Equal}"}},"serviceAnnotations":{"type":"array","description":"The annotations on Kubernetes services for legacy load balancers.","example":"[\n {service.beta.kubernetes.io/aws-load-balancer-cross-zone-load-balancing-enabled: true},\n]\n","items":{"type":"object","properties":{"value":{"type":"string"},"key":{"type":"string"}},"description":"The annotations on Kubernetes services for legacy load balancers.","example":"[\n {service.beta.kubernetes.io/aws-load-balancer-cross-zone-load-balancing-enabled: true},\n]\n"}},"internalServiceAnnotations":{"type":"array","description":"The annotations on Kubernetes services for private connection endpoints of Solace event brokers.","example":"[\n {service.beta.kubernetes.io/aws-load-balancer-cross-zone-load-balancing-enabled: true},\n {service.beta.kubernetes.io/aws-load-balancer-type: internal},\n]\n","items":{"type":"object","properties":{"value":{"type":"string"},"key":{"type":"string"}},"description":"The annotations on Kubernetes services for private connection endpoints of Solace event brokers.","example":"[\n {service.beta.kubernetes.io/aws-load-balancer-cross-zone-load-balancing-enabled: true},\n {service.beta.kubernetes.io/aws-load-balancer-type: internal},\n]\n"}},"externalServiceAnnotations":{"type":"array","description":"The annotations on Kubernetes services for public connections endpoints of Solace event brokers.","example":"[\n {service.beta.kubernetes.io/aws-load-balancer-cross-zone-load-balancing-enabled: true},\n {service.beta.kubernetes.io/aws-load-balancer-type: external},\n]\n","items":{"type":"object","properties":{"value":{"type":"string"},"key":{"type":"string"}},"description":"The annotations on Kubernetes services for public connections endpoints of Solace event brokers.","example":"[\n {service.beta.kubernetes.io/aws-load-balancer-cross-zone-load-balancing-enabled: true},\n {service.beta.kubernetes.io/aws-load-balancer-type: external},\n]\n"}},"type":{"type":"string"}}},"Datacenter":{"required":["available","datacenterType","name","operState","provider","visible"],"type":"object","properties":{"id":{"type":"string","description":"The identifier of the datacenter."},"type":{"type":"string","description":"The type of object for informational purposes."},"name":{"type":"string","description":"The name of the datacenter."},"visible":{"type":"boolean","description":"Indicates whether the datacenter is visible."},"datacenterType":{"pattern":"^Unknown$|^SolacePublic$|^SolaceDedicated$|^CustomerCloud$|^CustomerOnPrem$","type":"string","description":"The type of the datacenter, in terms of ownership. The valus can be a Public Region( 'SolacePublic'), a Dedicated Region('SolaceDedicated'), or a Customer-Controlled Region ('CustomerCloud' or 'CustomerOnPrem').","example":"SolacePublic"},"provider":{"type":"string","description":"The name of the cloud provider for the datacenter.","example":"aws"},"operState":{"pattern":"^up$|^down$","type":"string","description":"The operational state of the datacenter. The values can be 'up' or 'down'.","example":"up"},"location":{"$ref":"#/components/schemas/Location"},"createdBy":{"type":"string","description":"The unique identifier representing the user who created the datacenter."},"createdTime":{"type":"string","description":"The time the datacenter was created, in ISO 8601 date/time format.","format":"date-time","example":"2022-03-14T15:01:34Z"},"updatedBy":{"type":"string","description":"The unique identifier representing the user who last updated the datacenter."},"updatedTime":{"type":"string","description":"The time of the last update was performed on the datacenter, in ISO 8601 date/time format.","format":"date-time","example":"2022-03-14T15:01:34Z"},"available":{"type":"boolean","description":"Indicates whether the datacenter is available."},"supportedServiceClasses":{"type":"array","description":"The list of supported service classes in the datacenter.","example":["DEVELOPER","ENTERPRISE_1K_HIGHAVAILABILITY","ENTERPRISE_1K_STANDALONE"],"items":{"$ref":"#/components/schemas/ServiceClassId"}},"cloudAgentVersion":{"type":"string","description":"The version of the Mission Control Agent."},"k8sServiceType":{"type":"string","description":"The type of the Kubernetes service. The values can be 'LOADBALANCER' or 'NODEPORT'.","example":"LOADBALANCER","enum":["LOADBALANCER","NODEPORT"]},"numSupportedPrivateEndpoints":{"type":"integer","description":"The number of supported private endpoints.","format":"int32"},"numSupportedPublicEndpoints":{"type":"integer","description":"The number of supported public endpoints.","format":"int32"},"organizationId":{"type":"string","description":"The identifier of the datacenter's organization."},"spoolScaleUpCapabilityInfo":{"$ref":"#/components/schemas/SpoolScaleUpCapabilityInfo"},"regionId":{"type":"string","description":"The unique identifier for the datacenter region."},"environmentId":{"type":"string","description":"The unique identifier of the datacenter's environment."},"selfServeEventBrokerUpgradesEnabled":{"type":"boolean","description":"Indicates whether this datacenter allows self-serve upgrades for the services it hosts. The valid values are 'true' (enabled) or 'false' (disabled)."}}},"DatacenterRequest":{"type":"object","properties":{"environmentId":{"type":"string","description":"The unique identifier of the datacenter's environment.","example":"7kj4kwt04ge"}}},"DatacenterResponse":{"required":["data","meta"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/Datacenter"},"meta":{"type":"object","additionalProperties":{"type":"object"}}}},"DatacentersResponse":{"required":["data","meta"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Datacenter"}},"meta":{"type":"object","additionalProperties":{"type":"object"}}}},"DnsName":{"type":"object","properties":{"id":{"type":"string","description":"The DNS name identifier","readOnly":true,"example":"missioncontrol.messaging.net"},"type":{"type":"string","description":"The resource type"},"dnsName":{"type":"string","description":"The DNS name(fully qualified domain name)","example":"missioncontrol.messaging.net"},"dnsRecordType":{"type":"string","description":"The DNS record type","example":"CNAME"},"domainType":{"$ref":"#/components/schemas/DnsNameDomainType"}},"description":"Connection endpoint DNS name"},"DnsNameDomainType":{"type":"string","description":"The domain type","example":"SolaceManaged","enum":["SolaceManaged","CustomerManaged"]},"DnsNameMoveRequest":{"type":"object","properties":{"targetServiceId":{"type":"string","description":"The unique identifier of the event broker service you want to move the DNS connection endpoint name to. If you don’t specify a value, the value defaults to the service id hosting the target connection endpoint.","example":"svc-98765"},"targetConnectionEndpointId":{"type":"string","description":"The unique identifier of the event broker service connection endpoint you want to move the DNS name to. If you don’t specify a value, the value defaults to the target service’s only connection endpoint.","example":"ep-54321"},"id":{"type":"string","description":"The DNS name identifier","readOnly":true},"type":{"type":"string","description":"The type of object for informational purposes.","readOnly":true}},"description":"DNS name move request"},"Environment":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for this environment."},"type":{"type":"string","description":"The type of object for informational purposes."},"allowServiceCreationInPublicRegions":{"type":"boolean","description":"When this setting is false, it blocks the creation of services in public regions in this environment."}}},"EnvironmentRequest":{"type":"object","properties":{"allowServiceCreationInPublicRegions":{"type":"boolean","description":"When this setting is false, it blocks the creation of services in public regions in this environment."}}},"EnvironmentResponse":{"required":["data","meta"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/Environment"},"meta":{"type":"object","additionalProperties":{"type":"object"}}}},"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']"}}},"EventBrokerServiceVersion":{"required":["capabilities","containerImageTag","endOfFullSupport","endOfTechnicalSupport","minimumK8sVersion","minimumMcaVersion","releaseChannel","releaseDate","releaseNotes","supportedServiceClasses","version"],"type":"object","properties":{"type":{"type":"string","description":"The type of object for informational purposes."},"id":{"type":"string","description":"Event broker service id.","readOnly":true},"version":{"type":"string","description":"Event broker service version.","example":"10.0.1.62-0"},"containerImageTag":{"type":"string","description":"The container image tag that will be pulled when creating the event broker.","example":"10.0.1.62"},"supportedServiceClasses":{"type":"array","description":"Supported service classes.","example":["DEVELOPER","ENTERPRISE_1K_HIGHAVAILABILITY","ENTERPRISE_1K_STANDALONE"],"items":{"$ref":"#/components/schemas/ServiceClassId"}},"capabilities":{"type":"array","description":"The capabilities of the event broker service.","example":["portDisabling","portRemapping"],"items":{"type":"string","description":"The capabilities of the event broker service.","example":"[\"portDisabling\",\"portRemapping\"]"}},"releaseChannel":{"$ref":"#/components/schemas/ReleaseChannel"},"releaseNotes":{"type":"string","description":"Release notes describing the content of this event broker version.","example":"This release contains..."},"minimumMcaVersion":{"type":"string","description":"The minimum Mission Control Agent version required to deploy this event broker version.","example":"v1.20230905"},"minimumK8sVersion":{"type":"string","description":"The minimum Kubernetes cluster version required to deploy this event broker version.","example":"1.25"},"releaseDate":{"type":"string","description":"The date the event broker version was released, in ISO 8601 date/time format.","format":"date-time","example":"2023-09-05T17:16:21Z"},"endOfFullSupport":{"type":"string","description":"The date full support for the event broker version ends in ISO 8601 date/time format.","format":"date-time","example":"2023-09-05T17:16:21Z"},"endOfTechnicalSupport":{"type":"string","description":"The date technical support for the event broker version ends in ISO 8601 date/time format.","format":"date-time","example":"2023-09-05T17:16:21Z"},"currentMcaVersion":{"type":"string","description":"The current Mission Control Agent version.","example":"v1.20230905"},"recommended":{"type":"boolean","description":"Indicates if the version is recommended.","example":true}},"description":"The event broker service version."},"EventBrokerServiceVersionDetails":{"type":"object","properties":{"releaseStatus":{"type":"string","description":"The event broker service version release status.","enum":["REVOKED"]},"releaseStatusDetails":{"type":"string","description":"The event broker service version release status details."}},"description":"The event broker service version details."},"EventBrokerServiceVersionsResponse":{"required":["data","meta"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EventBrokerServiceVersion"}},"meta":{"type":"object","additionalProperties":{"type":"object"}}}},"EventBrokerUpgradeRequest":{"required":["targetVersion"],"type":"object","properties":{"targetVersion":{"type":"string","description":"The event broker version to upgrade to."},"maintenanceWindowId":{"type":"string","description":"The unique identifier of the maintenance window the upgrade will be scheduled in."},"maintenanceTimeOrdinal":{"type":"integer","description":"The ordinal identifying the maintenance time from the maintenance window the upgrade will be scheduled in.","format":"int32"}}},"EventBrokerVersions":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"defaultEventBrokerVersion":{"type":"string"},"latestK8sEventBrokerVersion":{"type":"string"}}},"EventBrokerVersionsResponse":{"required":["data","meta"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/EventBrokerVersions"},"meta":{"type":"object","additionalProperties":{"type":"object"}}}},"GetAllConnectionEndpointDnsNamesResponse":{"required":["data","meta"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DnsName"}},"meta":{"type":"object","additionalProperties":{"type":"object"}}},"description":"Response containing a list of connection endpoint DNS names"},"GetConnectionEndpoint":{"required":["accessType","name","ports"],"type":"object","properties":{"id":{"type":"string","description":"The identifier of the connection endpoint.","readOnly":true},"type":{"type":"string","description":"The type of object for informational purposes.","readOnly":true},"name":{"type":"string","description":"The name of the connection endpoint."},"description":{"type":"string","description":"The description for the connection endpoint."},"accessType":{"$ref":"#/components/schemas/ConnectionEndpointAccessType"},"k8sServiceType":{"type":"string","description":"The connectivity configuration that is used in the Kubernetes cluster.","readOnly":true,"enum":["LOADBALANCER","NODEPORT","CLUSTERIP"]},"k8sServiceId":{"type":"string","description":"The identifier for the Kubernetes service.","readOnly":true},"creationState":{"$ref":"#/components/schemas/CreationState"},"ports":{"type":"array","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.
\nConnection specific protocols.
\n'HEALTHY' or 'UNHEALTHY'.","enum":["HEALTHY","UNHEALTHY","UNKNOWN"]},"healthChecks":{"type":"array","description":"The list of health checks performed on the Mission Control Agent.","items":{"$ref":"#/components/schemas/MCAHealthCheck"}},"error":{"type":"string","description":"Shows a message describing any errors the Mission Control Agent encountered while performing health checks."}}},"MaintenanceActivity":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the maintenance activity."},"description":{"type":"string","description":"The description of the maintenance activity."},"environmentId":{"type":"string","description":"The identifier of the environment the maintenance activity belongs to."},"maintenanceWindowId":{"type":"string","description":"The identifier of the maintenance window the activity is associated with."},"orgId":{"type":"string","description":"The organization identifier associated with the maintenance activity."},"maintenanceType":{"type":"string","description":"The type of maintenance schedule. The metadata about the response, which can include:
The metadata about the response, which can include:
Indicates whether the service accepts API provided usernames instead of subject alternative names,\nor user identifiers from the certificate. The valid values are:
\nget','configure','update','broker_update','delete','assign'.","items":{"type":"string","description":"The allowed actions the user can perform on the event broker service and its configurations, including: 'get','configure','update','broker_update','delete','assign'."}},"messageSpoolDetails":{"$ref":"#/components/schemas/MessageSpoolDetails"},"environmentId":{"type":"string","description":"The unique identifier of the environment the service is associated with."},"eventBrokerServiceVersionDetails":{"$ref":"#/components/schemas/EventBrokerServiceVersionDetails"},"msgVpnName":{"type":"string","description":"The name of the event broker service Message VPN."},"defaultManagementHostname":{"type":"string","description":"Default management hostname."},"serviceConnectionEndpoints":{"type":"array","description":"Connection Endpoints available on expand only.","items":{"$ref":"#/components/schemas/ConnectionEndpoint"}},"broker":{"$ref":"#/components/schemas/Broker"},"infrastructureDetails":{"$ref":"#/components/schemas/InfrastructureDetails"}}},"ServiceAdminState":{"type":"string","description":"The administration state of the event broker service.","enum":["INITIAL","START","STOP","DESTROY"]},"ServiceClass":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ServiceClassId"},"type":{"type":"string","description":"The type of object for internal informational purposes."},"name":{"type":"string","description":"The name of the service class."},"vpnConnections":{"type":"integer","description":"The maximum number of client connections for the service class.","format":"int32"},"brokerScalingTier":{"type":"string","description":"The underlying scaling tiers for the software event broker."},"vpnMaxSpoolSize":{"type":"integer","description":"The maximum message spool size of the service class, in gigabytes (GB).","format":"int32"},"maxNumberVpns":{"type":"integer","description":"The maximum number of Message VPNs for the service class.","format":"int32"},"highAvailabilityCapable":{"type":"boolean","description":"Indicates whether the service class supports High-Availability. A value of 'True' indicates that high-availability is supported."},"limits":{"uniqueItems":true,"type":"array","description":"The service class usage and limits","items":{"$ref":"#/components/schemas/LimitClassUsage"}}}},"ServiceClassId":{"type":"string","description":"Supported service classes.","example":"[\"DEVELOPER\",\"ENTERPRISE_1K_HIGHAVAILABILITY\",\"ENTERPRISE_1K_STANDALONE\"]","enum":["DEVELOPER","ENTERPRISE_250_STANDALONE","ENTERPRISE_1K_STANDALONE","ENTERPRISE_5K_STANDALONE","ENTERPRISE_10K_STANDALONE","ENTERPRISE_50K_STANDALONE","ENTERPRISE_100K_STANDALONE","ENTERPRISE_200K_STANDALONE","ENTERPRISE_250_HIGHAVAILABILITY","ENTERPRISE_1K_HIGHAVAILABILITY","ENTERPRISE_5K_HIGHAVAILABILITY","ENTERPRISE_10K_HIGHAVAILABILITY","ENTERPRISE_50K_HIGHAVAILABILITY","ENTERPRISE_100K_HIGHAVAILABILITY","ENTERPRISE_200K_HIGHAVAILABILITY"]},"ServiceClassResponse":{"required":["data","meta"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/ServiceClass"},"meta":{"type":"object","additionalProperties":{"type":"object"}}}},"ServiceClassesResponse":{"required":["data","meta"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ServiceClass"}},"meta":{"type":"object","additionalProperties":{"type":"object"}}}},"ServiceCloneAttributes":{"type":"object","properties":{"components":{"type":"array","items":{"type":"string","enum":["SERVICE_CONFIGURATION","BROKER_CONFIGURATION","CERTIFICATE_AUTHORITIES"]}}},"description":"The event broker service settings that you can specify to clone. The cluster name, client authentication (client user names), and management users are always cloned to the new service. You can specify one or more of the following attributes to clone to the new event broker service:
\nIf you don't specify an attribute (default), all the supported settings except for the 'CERTIFICATE_AUTHORITIES' settings are cloned to the new service.
","example":{"components":["SERVICE_CONFIGURATION","BROKER_CONFIGURATION","CERTIFICATE_AUTHORITIES"]}},"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.
\nConnection specific protocols.
\nget','configure','update','broker_update','delete','assign'.","items":{"type":"string","description":"The allowed actions the user can perform on the event broker service and its configurations, including: 'get','configure','update','broker_update','delete','assign'."}},"messageSpoolDetails":{"$ref":"#/components/schemas/MessageSpoolDetails"},"environmentId":{"type":"string","description":"The unique identifier of the environment the service is associated with."},"eventBrokerServiceVersionDetails":{"$ref":"#/components/schemas/EventBrokerServiceVersionDetails"},"msgVpnName":{"type":"string","description":"The name of the event broker service Message VPN."}}},"ServiceSummaryResponse":{"required":["data","meta"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ServiceSummary"}},"meta":{"type":"object","additionalProperties":{"type":"object"}}}},"SpoolScaleUpCapabilityInfo":{"type":"object","properties":{"spoolScaleUpCapabilityState":{"pattern":"^UNKNOWN$|^IN_PROGRESS$|^SUPPORTED$|^NOT_SUPPORTED$","type":"string","description":"The current state of the Scalable Message Spool Size feature. The values can be 'INPROGRESS', 'SUPPORTED', 'NOT SUPPORTED', or 'UNKNOWN'.","example":"IN_PROGRESS"},"spoolScaleUpTestTimestamp":{"type":"string","description":"The time of the last test was performed, in ISO 8601 date/time format.","format":"date-time","example":"2022-03-14T15:01:34Z"},"spoolScaleUpTestMessage":{"type":"string","description":"Message resulting from a self-test of support for the Scalable Message Spool Size feature."}},"description":"Deprecation Date: 2025-02-01
\nRemoval Date: 2025-04-01
\nReason: Spool scale-up tests are no longer required, as all Kubernetes-based datacenters provide this capability.
\n","deprecated":true},"UpcomingMaintenanceTime":{"type":"object","properties":{"startTime":{"type":"string","format":"date-time"},"endTime":{"type":"string","format":"date-time"}},"description":"Shows a list of available times for the maintenance window."},"UpdateConnectionEndpoint":{"type":"object","properties":{"id":{"type":"string","description":"The identifier of the connection endpoint.","readOnly":true},"type":{"type":"string","description":"The type of object for informational purposes.","readOnly":true},"name":{"type":"string","description":"The name of the connection endpoint. Optional for updates."},"description":{"type":"string","description":"The description for the connection endpoint."},"accessType":{"$ref":"#/components/schemas/ConnectionEndpointAccessType"},"k8sServiceType":{"type":"string","description":"The connectivity configuration that is used in the Kubernetes cluster.","readOnly":true,"enum":["LOADBALANCER","NODEPORT","CLUSTERIP"]},"k8sServiceId":{"type":"string","description":"The identifier for the Kubernetes service.","readOnly":true},"creationState":{"$ref":"#/components/schemas/CreationState"},"ports":{"type":"array","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.
\nConnection specific protocols.
\nThe FQDN to use for the DNS name for the connection endpoint. The dnsName you enter:
\n• must contain only lowercase alphanumeric characters (a-z, 0-9), hyphens (-), or dots (.)
\n• cannot end with a hyphen or dot
\n• must have each portion of the FQDN (label) be between 1-63 characters
\n• must have an entire length no longer than 230 characters.
","example":"test.custom.net"},"id":{"type":"string","description":"The DNS name identifier","readOnly":true},"type":{"type":"string","description":"The type of object for informational purposes.","readOnly":true}},"description":"DNS name creation request"},"jobOperationTypes":{"type":"string","description":"The type of operation against the resource.","enum":["createService","cloneService","deleteService","createClientProfile","updateClientProfile","deleteClientProfile","createDnsName","moveDnsName","deleteDnsName","serviceRequest","infrastructureRequest","datacenterRequest","uploadCertificate","installCertificate","deleteCertificate","haSwitchover","rotateReplicationPSK","serviceScaleUp","serviceUpgrade","createConnectionEndpoint","updateConnectionEndpoint","deleteConnectionEndpoint"]},"operationTypesFilter":{"type":"string","enum":["haSwitchover"]},"upgradeReadinessResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/UpgradeReadiness"},"meta":{"type":"object","additionalProperties":{"type":"object"}}}}},"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}}},"x-readme":{"explorer-enabled":true,"proxy-enabled":true}}