{"openapi":"3.1.0","info":{"title":"Event Portal - Runtime","description":"REST API Concepts\n\nSolace Event Portal provides REST APIs that you can use to manage your data in Solace Cloud. \nThe REST APIs allow you to model your event-driven architectures from your own client applications.\n\nThe following document describes the public REST APIs available for use in Event Portal 2.0. Objects created in this \nversion will not be available in Event Portal 1.0. APIs that display (Beta) in their summary are provided as-is and \nare subject to change or removal. They may not be of the quality expected for generally available APIs and have no \nguaranteed forward compatibility with the generally available version of the API.\n\n","version":"2.13.2"},"servers":[{"url":"https://api.solace.cloud","description":"Solace PubSub+ Cloud US EAST Region"},{"url":"https://api.solacecloud.com.au","description":"Solace PubSub+ Cloud AU Region"},{"url":"https://api.solacecloud.eu","description":"Solace PubSub+ Cloud EU Region"},{"url":"https://api.solacecloud.sg","description":"Solace PubSub+ Cloud SG Region"}],"security":[{"APIToken":[]}],"tags":[{"name":"Application Configuration Push Job"},{"name":"Application Deployments"},{"name":"Application Promotion Requests"},{"name":"Audit Results"},{"name":"Environments"},{"name":"Event Management Agents"},{"name":"Event Meshes"},{"name":"Event Portal Usage Stats"},{"name":"Messaging Service Scan Data"},{"name":"Messaging Service Scan Logs"},{"name":"Messaging Service Scans"},{"name":"Messaging Services"},{"name":"Modeled Event Broker"}],"paths":{"/api/v2/architecture/runtimeManagement/applicationConfigurationPushJobs/{jobId}/decryptedConfigurations":{"get":{"tags":["Application Configuration Push Job"],"summary":"(Beta) Get a configuration push job's runtime configurations for self-managed configuration push","description":"Get an existing configuration push job's runtime configurations, the configurations are returned in HCL format by default.\nThe job's target environment must not have the `disabled` config push mode.\n\nYour token must have one of the permissions listed in the Token Permissions.\n<br><br><a href=\"https://api.solace.dev/cloud/reference/authentication\">Token Permissions</a>: [ `application_configuration_push_job:*:*` ]","operationId":"getConfigurationPushJobConfigurations","parameters":[{"name":"jobId","in":"path","description":"The unique identifier of the configuration push job.","required":true,"schema":{"type":"string"}},{"name":"format","in":"query","required":false,"schema":{"type":"string","default":"hcl"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ApplicationConfigPushJobConfigurationResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v2/architecture/runtimeManagement/applicationConfigurationPushJobs/{jobId}/run":{"post":{"tags":["Application Configuration Push Job"],"summary":"(Beta) Run a configuration push job","description":"Run an existing configuration push job by its identifier. The job's target environment must have the `onDemand` config push mode.\n\nYour token must have one of the permissions listed in the Token Permissions.\n<br><br><a href=\"https://api.solace.dev/cloud/reference/authentication\">Token Permissions</a>: [ `application_configuration_push_job:run:*` ]","operationId":"runApplicationConfigPushJob","parameters":[{"name":"jobId","in":"path","description":"The unique identifier of the configuration push job.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ApplicationConfigPushJobResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v2/architecture/runtimeManagement/applicationConfigurationPushJobs/{jobId}/status":{"put":{"tags":["Application Configuration Push Job"],"summary":"(Beta) Update the status of a configuration push job","description":"Update the status of an existing configuration push job by its identifier.\n\nYour token must have one of the permissions listed in the Token Permissions.\n<br><br><a href=\"https://api.solace.dev/cloud/reference/authentication\">Token Permissions</a>: [ `application_configuration_push_job:update_status:*` ]","operationId":"patchApplicationConfigPushJobStatus","parameters":[{"name":"jobId","in":"path","description":"The unique identifier of the configuration push job.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigPushJobStatusUpdateRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ApplicationConfigPushJobResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v2/architecture/runtimeManagement/applications/{id}/configurationPushJobs":{"get":{"tags":["Application Configuration Push Job"],"summary":"Get a list of configuration push jobs by application identifier","description":"Get a list of configuration push jobs that match the specified application identifier.\n\nYour token must have one of the permissions listed in the Token Permissions.\n<br><br><a href=\"https://api.solace.dev/cloud/reference/authentication\">Token Permissions</a>: [ `application:get:*` ]","operationId":"listApplicationConfigPushJobs","parameters":[{"name":"id","in":"path","description":"The unique identifier of the application.","required":true,"schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"The number of configuration push jobs to return per page.","required":false,"schema":{"type":"integer","format":"int32","default":20,"maximum":100,"minimum":1}},{"name":"pageNumber","in":"query","description":"The page number to retrieve.","required":false,"schema":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"changeRecordIds","in":"query","description":"The unique identifiers of the change record, separated by commas, to retrieve configuration push jobs from.","required":false,"schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"statuses","in":"query","description":"The statuses, separated by commas, of the configuration push jobs to retrieve.","required":false,"schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ApplicationConfigPushJobsResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v2/architecture/runtimeManagement/applicationDeploymentPreviews":{"post":{"tags":["Application Deployments"],"summary":"(EA) Create a preview of the application deployment","description":"Create a preview of the resulting changes in an application's event broker resources for the specified deployment action.\nThe preview is provided in the data/requested section of the response.\n\nYour token must have one of the permissions listed in the Token Permissions.\n<br><br><a href=\"https://api.solace.dev/cloud/reference/authentication\">Token Permissions</a>: [ `application_deployment_preview:create:*` **and** `application:get:*` ]","operationId":"createApplicationChangeRequestPreview","requestBody":{"description":"The application deployment request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationDeployment"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationDeploymentPreviewResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v2/architecture/runtimeManagement/applicationDeployments":{"post":{"tags":["Application Deployments"],"summary":"Create an application deployment","description":"Create an application deployment to an event broker in a modeled event mesh. This action has two variants:\n\n1. `deploy` creates and updates an application's resources on an event broker in a modeled event mesh.\n\n2. `undeploy` detaches an application from an model event broker and cleans up all related resources.\n\nOnly one version of an application can be deployed on a model event broker at the same time.\n\nDeploying a different version of the same application behaves as an upgrade or downgrade of the application to the newly deployed version.\n\nFor environments with configuration push enabled and a connected operational event broker, deployments trigger configuration push jobs\non the operational event broker.\n\nYour token must have one of the permissions listed in the Token Permissions.\n<br><br><a href=\"https://api.solace.dev/cloud/reference/authentication\">Token Permissions</a>: [ `modeled_event_broker:deploy:*` **and** `application:update:*` ]","operationId":"createApplicationDeployment","requestBody":{"description":"The application deployment request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationDeployment"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ApplicationDeploymentResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v2/architecture/applicationPromotionRequests":{"get":{"tags":["Application Promotion Requests"],"summary":"(EA) Get application promotion requests","description":"Use this API to get a list of application promotion requests that match the given parameters.<br><br><a href=\"https://api.solace.dev/cloud/reference/authentication\">Token Permissions</a>: [ <code>event_designer:access</code> ]","operationId":"getListApplicationPromotionRequests","parameters":[{"name":"pageSize","in":"query","description":"The number of requests to get per page.","required":false,"schema":{"type":"integer","format":"int32","default":20}},{"name":"pageNumber","in":"query","description":"The page number to get.","required":false,"schema":{"type":"integer","format":"int32","default":1}},{"name":"ids","in":"query","description":"The request ids to get","required":false,"schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"applicationVersionIds","in":"query","description":"Get requests with given application version IDs","required":false,"schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"applicationIds","in":"query","description":"Get requests with given application IDs","required":false,"schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"eventBrokerIds","in":"query","description":"Get requests with given messaging service IDs","required":false,"schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"environmentIds","in":"query","description":"Get requests with the given environment IDs","required":false,"schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"createdBys","in":"query","description":"Get requests with the given createdBy user IDs","required":false,"schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"requestStatuses","in":"query","description":"Get requests with the given request statuses","required":false,"schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"reviewStatuses","in":"query","description":"Get requests with the given review statuses","required":false,"schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"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.\nDefine the sort order using the following string: `fieldname:asc/desc` where:\n\n- `fieldname` — The field name of the query parameter to sort by.\n- `asc` — Sort the selected field name in ascending order.\n- `desc` — Sort the selected field name in descending order.\n\nIf the direction is not specified, the default is ascending.\n\nYou can use multiple query parameters to refine the sorting order.\n","required":false,"schema":{"type":"string"}},{"name":"applicationNameContains","in":"query","description":"Filter requests by application names that contain this string","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Get a list of application promotion requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationPromotionListResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"tags":["Application Promotion Requests"],"summary":"(EA) Create an application promotion request","description":"Use this API to create a new application promotion request.<br><br><a href=\"https://api.solace.dev/cloud/reference/authentication\">Token Permissions</a>: [ `promotion_request:create:*` **and** `ep_environment:get:*` ]","operationId":"createApplicationPromotionRequest","requestBody":{"description":"The application promotion request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationPromotionRequest"}}},"required":true},"responses":{"201":{"description":"The created application promotion request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationPromotionRequestResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v2/architecture/applicationPromotionRequests/previews":{"post":{"tags":["Application Promotion Requests"],"summary":"(EA) Create a preview of an application promotion","description":"Generates a *fresh* preview of the resulting changes in an application's event broker resources based on the specified application version ID and target event broker ID. It shows what would happen if the promotion were executed *now*. The preview is provided in the data/requested section of the response.<br><br><a href=\"https://api.solace.dev/cloud/reference/authentication\">Token Permissions</a>: [ <code>event_designer:access</code> ]","operationId":"createApplicationPromotionPreviewByVersion","requestBody":{"description":"The application version and event broker to preview the promotion for.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationPromotionPreviewRequestDTO"}}},"required":true},"responses":{"200":{"description":"The promotion preview has been successfully generated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationDeploymentPreviewResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v2/architecture/applicationPromotionRequests/{id}":{"get":{"tags":["Application Promotion Requests"],"summary":"(EA) Get application promotion request by id","description":"Get application promotion request by id<br><br><a href=\"https://api.solace.dev/cloud/reference/authentication\">Token Permissions</a>: [ `promotion_request:get:*` ]","operationId":"getApplicationPromotionRequest","parameters":[{"name":"id","in":"path","description":"The ID of the application promotion request.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Get the application promotion request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationPromotionRequestResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"delete":{"tags":["Application Promotion Requests"],"summary":"(EA) Delete an application promotion request","description":"Use this API to delete an application promotion request.<br><br><a href=\"https://api.solace.dev/cloud/reference/authentication\">Token Permissions</a>: [ `promotion_request:delete:*` ]","operationId":"deleteApplicationPromotionRequest","parameters":[{"name":"id","in":"path","description":"The ID of the application promotion request to delete.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"The application promotion request was successfully deleted."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v2/architecture/applicationPromotionRequests/{id}/promote":{"post":{"tags":["Application Promotion Requests"],"summary":"(EA) Initiate promotion of an approved application promotion request","description":"Promote a previously approved application promotion request. The promotion will be processed only if the request has an approved review.<br><br><a href=\"https://api.solace.dev/cloud/reference/authentication\">Token Permissions</a>: [ <code>event_designer:access</code> ]","operationId":"promoteApplicationPromotionRequest","parameters":[{"name":"id","in":"path","description":"The ID of the application promotion request to promote.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The promotion has been successfully submitted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationDeploymentResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v2/architecture/auditResults":{"get":{"tags":["Audit Results"],"summary":"Get a list of audit results","description":"This provides a list of audit results for the given event mesh and/or event brokers.<br><br><a href=\"https://api.solace.dev/cloud/reference/authentication\">Token Permissions</a>: [ <code>audit:read</code> ]","operationId":"listAuditResults","parameters":[{"name":"pageSize","in":"query","description":"The number of audit records to get per page.","required":false,"schema":{"type":"integer","format":"int32","default":20,"maximum":100,"minimum":1}},{"name":"pageNumber","in":"query","description":"The page number to get.","required":false,"schema":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"eventBrokerIds","in":"query","description":"Match only audit records belonging to the given event brokers.","required":false,"schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"eventMeshId","in":"query","description":"Match only audit records belonging to the given event mesh.","required":false,"schema":{"type":"string"}},{"name":"auditEntityTypes","in":"query","description":"Match only audit records belonging to the given entity types.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["all","kafkaConsumerGroup","kafkaConsumerGroupAggregate","kafkaTopic","kafkaTopicAggregate","schemaParent","schemaVersion","solaceQueue","solaceQueueAggregate","solaceTopic","kafkaTopicSchemaVersion","kafkaTopicSchemaParent"]},"uniqueItems":true}},{"name":"statuses","in":"query","description":"Match only audit records with the given statuses.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["designerOnly","match","partialMatch","runtimeOnly"]},"uniqueItems":true}},{"name":"startsWith","in":"query","description":"Match only audit records with identifiers starting with the given value.","required":false,"schema":{"type":"string"}},{"name":"contains","in":"query","description":"Match audit records with identifiers containing the given value.","required":false,"schema":{"type":"string"}},{"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.\nDefine the sort order using the following string: `fieldname:asc/desc` where:\n\n- `fieldname` — The field name of the query parameter to sort by.\n- `asc` — Sort the selected field name in ascending order.\n- `desc` — Sort the selected field name in descending order.\n\nIf the direction is not specified, the default is ascending.\n\nYou can use multiple query parameters to refine the sorting order.\n Sorting is supported for status and identifier.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The list of audit records and the accompanying metadata.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditResultsResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v2/architecture/auditResults/{auditResultId}":{"get":{"tags":["Audit Results"],"summary":"Get the details of a single audit result","description":"This provides the details of a single audit result, given its id.<br><br><a href=\"https://api.solace.dev/cloud/reference/authentication\">Token Permissions</a>: [ <code>audit:read</code> ]","operationId":"getAuditResultDetail","parameters":[{"name":"auditResultId","in":"path","description":"The ID of the audit.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The audit detail.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditResultDetailResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v2/architecture/about/environments":{"get":{"tags":["Environments"],"summary":"Get a list of basic environment information","description":"Get a list of the basic information for the specified environments.\n\nYour token must have one of the permissions listed in the Token Permissions.\n<br><br><a href=\"https://api.solace.dev/cloud/reference/authentication\">Token Permissions</a>: [ <code>ep_environment:get_info:*</code> ]","operationId":"getEnvironmentInfo","parameters":[{"name":"pageSize","in":"query","description":"The number of environments to return per page.","required":false,"schema":{"type":"integer","format":"int32","default":20,"maximum":100,"minimum":1}},{"name":"pageNumber","in":"query","description":"The page number to retrieve.","required":false,"schema":{"type":"integer","format":"int32","default":1,"minimum":1}},{"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.\nDefine the sort order using the following string: `fieldname:asc/desc` where:\n\n- `fieldname` — The field name of the query parameter to sort by.\n- `asc` — Sort the selected field name in ascending order.\n- `desc` — Sort the selected field name in descending order.\n\nIf the direction is not specified, the default is ascending.\n\nYou can use multiple query parameters to refine the sorting order.\n","required":false,"schema":{"type":"string"}},{"name":"ids","in":"query","description":"The unique identifiers of the environments to retrieve, separated by commas.","required":false,"schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}}],"responses":{"200":{"description":"OK","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/EnvironmentInfoResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v2/architecture/environments":{"get":{"tags":["Environments"],"summary":"Get a list of environments","description":"Use this API to get a list of all environments.<br><br><a href=\"https://api.solace.dev/cloud/reference/authentication\">Token Permissions</a>: [ <code>event_designer:access</code> ]","operationId":"getEnvironments","parameters":[{"name":"pageSize","in":"query","description":"The number of environments to get per page.","required":false,"schema":{"type":"integer","format":"int32","default":20,"maximum":100,"minimum":1}},{"name":"pageNumber","in":"query","description":"The page number to get.","required":false,"schema":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"sort","in":"query","required":false,"schema":{"type":"string"}},{"name":"like","in":"query","required":false,"schema":{"type":"string"}},{"name":"ids","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}}],"responses":{"200":{"description":"Get a list of environments and the accompanying metadata.","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/EnvironmentsResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v2/architecture/environments/{id}":{"get":{"tags":["Environments"],"summary":"Get an environment","description":"Use this API to get a single environment by its ID.<br><br><a href=\"https://api.solace.dev/cloud/reference/authentication\">Token Permissions</a>: [ `ep_environment:get:*` ]","operationId":"getEnvironment","parameters":[{"name":"id","in":"path","description":"The ID of the environment.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The environment.","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/EnvironmentResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"tags":["Environments"],"summary":"Update environment runtime configuration","description":"Update the runtime configuration attributes for an environment to enable or disable runtime configuration\nand to require Solace queue configuration and client profile name templates.\n\nYour token must have one of the permissions listed in the Token Permissions.\n<br><br><a href=\"https://api.solace.dev/cloud/reference/authentication\">Token Permissions</a>: [ `ep_environment:update:*` ]","operationId":"updateEnvironment","parameters":[{"name":"id","in":"path","description":"The ID of the environment.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The environment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Environment"}}},"required":true},"responses":{"200":{"description":"The updated environment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvironmentResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v2/architecture/eventManagementAgents":{"get":{"tags":["Event Management Agents"],"summary":"Get a list of EMAs","description":"Use this API to get a list of EMAs that match the given parameters.<br><br><a href=\"https://api.solace.dev/cloud/reference/authentication\">Token Permissions</a>: [ <code>event_management_agent:read</code> ]","operationId":"getEventManagementAgents","parameters":[{"name":"pageSize","in":"query","description":"The number of EMAs to get per page.","required":false,"schema":{"type":"integer","format":"int32","default":20,"maximum":100,"minimum":1}},{"name":"pageNumber","in":"query","description":"The page number to get.","required":false,"schema":{"type":"integer","format":"int32","default":1,"minimum":1}},{"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.\nDefine the sort order using the following string: `fieldname:asc/desc` where:\n\n- `fieldname` — The field name of the query parameter to sort by.\n- `asc` — Sort the selected field name in ascending order.\n- `desc` — Sort the selected field name in descending order.\n\nIf the direction is not specified, the default is ascending.\n\nYou can use multiple query parameters to refine the sorting order.\n","required":false,"schema":{"type":"string"}},{"name":"ids","in":"query","description":"The IDs of the EMAs.","required":false,"schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"createdBy","in":"query","description":"Match only EMAs created by this user","required":false,"schema":{"type":"string"}},{"name":"eventManagementAgentRegionId","in":"query","description":"Match only EMAs in the given EMA-Region","required":false,"schema":{"type":"string"}},{"name":"include","in":"query","description":"Specify extra data to be included, options are: referencedByMessagingServiceIds.\n<br>Replacement: Use expand instead.\n<br>Reason: The change is to align with the API specification design.\n<br>Removal Date: 2024-11-03 18:00:00.000.\n","required":false,"deprecated":true,"schema":{"type":"string"}},{"name":"expand","in":"query","description":"Specify extra data to be included, options are: referencedByMessagingServiceIds.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The list of EMAs and the accompanying metadata.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventManagementAgentsResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"tags":["Event Management Agents"],"summary":"Create an EMA object","description":"Use this API to create an EMA object.<br><br><a href=\"https://api.solace.dev/cloud/reference/authentication\">Token Permissions</a>: [ <code>event_management_agent:write</code> ]","operationId":"createEventManagementAgent","requestBody":{"description":"The EMA object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventManagementAgent"}}},"required":true},"responses":{"201":{"description":"Created an EMA. The newly saved EMA object is returned in the response body.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventManagementAgentResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v2/architecture/eventManagementAgents/{id}":{"get":{"tags":["Event Management Agents"],"summary":"Get an EMA object","description":"Use this API to get a single EMA by its ID.<br><br><a href=\"https://api.solace.dev/cloud/reference/authentication\">Token Permissions</a>: [ <code>event_management_agent:read</code> ]","operationId":"getEventManagementAgent","parameters":[{"name":"id","in":"path","description":"The ID of the EMA object.","required":true,"schema":{"type":"string"}},{"name":"include","in":"query","description":"Specify extra data to be included, options are: referencedByMessagingServiceIds.\n<br>Replacement: Use expand instead.\n<br>Reason: The change is to align with the API specification design.\n<br>Removal Date: 2024-11-03 18:00:00.000.\n","required":false,"deprecated":true,"schema":{"type":"string"}},{"name":"expand","in":"query","description":"Specify extra data to be included, options are: referencedByMessagingServiceIds.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The EMA object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventManagementAgentResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"delete":{"tags":["Event Management Agents"],"summary":"Delete an EMA object","description":"Use this API to delete an EMA.<br><br><a href=\"https://api.solace.dev/cloud/reference/authentication\">Token Permissions</a>: [ <code>event_management_agent:write</code> ]","operationId":"deleteEventManagementAgent","parameters":[{"name":"id","in":"path","description":"The ID of the EMA object.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No content is returned."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"tags":["Event Management Agents"],"summary":"Update an EMA object","description":"Use this API to update an EMA. You only need to specify the fields that need to be updated.<br><br><a href=\"https://api.solace.dev/cloud/reference/authentication\">Token Permissions</a>: [ <code>event_management_agent:write</code> ]","operationId":"updateEventManagementAgent","parameters":[{"name":"id","in":"path","description":"The ID of the EMA object to update.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The EMA object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventManagementAgent"}}},"required":true},"responses":{"200":{"description":"The updated EMA object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventManagementAgentResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v2/architecture/eventManagementAgents/{id}/configuration/raw":{"get":{"tags":["Event Management Agents"],"summary":"Get the raw configs in string format for an EMA object","description":"Use this API to get the raw configs for a single EMA by its ID.<br><br><a href=\"https://api.solace.dev/cloud/reference/authentication\">Token Permissions</a>: [ <code>event_management_agent:read</code> ]","operationId":"getEventManagementAgentConfigRaw","parameters":[{"name":"id","in":"path","description":"The ID of the EMA object.","required":true,"schema":{"type":"string"}},{"name":"configFileType","in":"query","required":false,"schema":{"type":"string","default":"connected","enum":["connected","standalone"]}}],"responses":{"200":{"description":"The EMA config in yaml structure.","content":{"text/plain":{"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"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v2/architecture/about/eventMeshes":{"get":{"tags":["Event Meshes"],"summary":"Get a list of basic information for all modeled event meshes","description":"Get a list of the basic information for all modeled event meshes.\n\nYour token must have one of the permissions listed in the Token Permissions.\n<br><br><a href=\"https://api.solace.dev/cloud/reference/authentication\">Token Permissions</a>: [ <code>modeled_event_mesh:get_info:*</code> ]","operationId":"getEventmeshInfo","parameters":[{"name":"pageSize","in":"query","description":"The number of modeled event meshes to return per page.","required":false,"schema":{"type":"integer","format":"int32","default":20,"maximum":100,"minimum":1}},{"name":"pageNumber","in":"query","description":"The page number to retrieve.","required":false,"schema":{"type":"integer","format":"int32","default":1,"minimum":1}},{"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.\nDefine the sort order using the following string: `fieldname:asc/desc` where:\n\n- `fieldname` — The field name of the query parameter to sort by.\n- `asc` — Sort the selected field name in ascending order.\n- `desc` — Sort the selected field name in descending order.\n\nIf the direction is not specified, the default is ascending.\n\nYou can use multiple query parameters to refine the sorting order.\n","required":false,"schema":{"type":"string"}},{"name":"ids","in":"query","description":"The unique identifiers of the modeled event meshes to retrieve, separated by commas.","required":false,"schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/EventMeshesInfoResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v2/architecture/eventMeshWarnings":{"get":{"tags":["Event Meshes"],"summary":"(EA) Get entities with warnings associated with the specified modeled event mesh","description":"Get a list of entities associated with the specified modeled event mesh that have warnings that the user may want to act on.\nExamples of warnings include unconsumed events, unpublished events, and events with no topic address.\n\nYour token must have one of the permissions listed in the Token Permissions.\n<br><br><a href=\"https://api.solace.dev/cloud/reference/authentication\">Token Permissions</a>: [ <code>event_runtime:read</code> ]","operationId":"getEventMeshWarnings","parameters":[{"name":"eventMeshId","in":"query","description":"The unique identifier of the modeled event mesh.","required":true,"schema":{"type":"string"}},{"name":"minimizeData","in":"query","description":"When set to true, returns a minimized data set containing only entity ids and warnings.","required":false,"schema":{"type":"boolean","default":true}}],"responses":{"200":{"description":"OK","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/EventMeshWarningResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v2/architecture/eventMeshes":{"get":{"tags":["Event Meshes"],"summary":"Get a list of modeled event meshes","description":"Get a list of modeled event meshes that match the given parameters.\n\nYour token must have one of the permissions listed in the Token Permissions.\n<br><br><a href=\"https://api.solace.dev/cloud/reference/authentication\">Token Permissions</a>: [ <code>event_designer:access</code> ]","operationId":"getEventMeshes","parameters":[{"name":"pageSize","in":"query","description":"The number of modeled event meshes to get per page.","required":false,"schema":{"type":"integer","format":"int32","default":20,"maximum":100,"minimum":1}},{"name":"pageNumber","in":"query","description":"The page number to get.","required":false,"schema":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"name","in":"query","description":"Name of the modeled event mesh to match on.","required":false,"schema":{"type":"string"}},{"name":"environmentId","in":"query","description":"Match only modeled event meshes in the given environment","required":false,"schema":{"type":"string"}},{"name":"ids","in":"query","description":"Match only modeled event meshes with the given unique identifiers separated by commas.","required":false,"schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}}],"responses":{"200":{"description":"OK","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/EventMeshesResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"tags":["Event Meshes"],"summary":"Create a modeled event mesh","description":"Create a modeled event mesh in Event Portal.\n\nYour token must have one of the permissions listed in the Token Permissions.\n<br><br><a href=\"https://api.solace.dev/cloud/reference/authentication\">Token Permissions</a>: [ `modeled_event_mesh:create:*` ]","operationId":"createEventMesh","requestBody":{"description":"The JSON schema that defines the modeled event mesh.","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/EventMesh"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/EventMeshResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v2/architecture/eventMeshes/{id}":{"get":{"tags":["Event Meshes"],"summary":"Get a modeled event mesh","description":"Get a single modeled event mesh by its unique identifier.\n\nYour token must have one of the permissions listed in the Token Permissions.\n<br><br><a href=\"https://api.solace.dev/cloud/reference/authentication\">Token Permissions</a>: [ `modeled_event_mesh:get:*` ]","operationId":"getEventMesh","parameters":[{"name":"id","in":"path","description":"The unique identifier of the modeled event mesh.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/EventMeshResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"delete":{"tags":["Event Meshes"],"summary":"Delete a modeled event mesh","description":"Delete a modeled event mesh.\n\nYour token must have one of the permissions listed in the Token Permissions.\n<br><br><a href=\"https://api.solace.dev/cloud/reference/authentication\">Token Permissions</a>: [ `modeled_event_mesh:delete:*` ]","operationId":"deleteEventMesh","parameters":[{"name":"id","in":"path","description":"The unique identifier of the modeled event mesh.","required":true,"schema":{"type":"string"}},{"name":"force","in":"query","required":false,"schema":{"type":"boolean","default":false}}],"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"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"tags":["Event Meshes"],"summary":"Update a modeled event mesh","description":"Update a modeled event mesh in Event Portal.\n\nYour token must have one of the permissions listed in the Token Permissions.\n<br><br><a href=\"https://api.solace.dev/cloud/reference/authentication\">Token Permissions</a>: [ `modeled_event_mesh:update:*` ]","operationId":"updateEventMesh","parameters":[{"name":"id","in":"path","description":"The unique identifier of the modeled event mesh.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The JSON schema that defines the modeled event mesh.","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/EventMesh"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/EventMeshResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v2/architecture/eventPortalUsageStats":{"get":{"tags":["Event Portal Usage Stats"],"summary":"(EA) Get event portal usage stats","description":"Use this API to get event portal usage stats<br><br><a href=\"https://api.solace.dev/cloud/reference/authentication\">Token Permissions</a>: [ <code>event_designer:access</code> ]","operationId":"getEventPortalUsageStats","responses":{"200":{"description":"OK","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/ResponseEventPortalUsageStats"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v2/architecture/messagingServiceScans/{scanId}/dataCollection":{"get":{"tags":["Messaging Service Scan Data"],"summary":"Get a list of messaging service scan data","description":"Use this API to get a list of messaging service scan data that match the given parameters.<br><br><a href=\"https://api.solace.dev/cloud/reference/authentication\">Token Permissions</a>: [ <code>messaging_service_scan:read</code> ]","operationId":"getMessagingServiceScansData","parameters":[{"name":"scanId","in":"path","description":"The ID of the messaging service scan we want data for.","required":true,"schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"The number of messaging service scan data to get per page.","required":false,"schema":{"type":"integer","format":"int32","default":20,"maximum":100,"minimum":1}},{"name":"pageNumber","in":"query","description":"The page number to get.","required":false,"schema":{"type":"integer","format":"int32","default":1,"minimum":1}},{"name":"sort","in":"query","description":"The name of the field to sort on.","required":false,"schema":{"type":"string"}},{"name":"ids","in":"query","description":"The IDs of the messaging service scan data.","required":false,"schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"collectionTypes","in":"query","description":"Match only scan data whose dataCollectionType matches the given list.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["brokerConfiguration","clusterConfiguration","consumerGroups","consumerGroupConfiguration","overrideTopicConfiguration","queueConfiguration","queueListing","schema","subscriptionConfiguration","topicConfiguration","topicListing"]},"uniqueItems":true}}],"responses":{"200":{"description":"The list of messaging service scan data and the accompanying metadata.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagingServiceScanDataListResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v2/architecture/messagingServiceScans/{scanId}/dataCollection/{id}":{"get":{"tags":["Messaging Service Scan Data"],"summary":"Get a messaging service scan data","description":"Use this API to get a single messaging service scan data by its ID.<br><br><a href=\"https://api.solace.dev/cloud/reference/authentication\">Token Permissions</a>: [ <code>messaging_service_scan:read</code> ]","operationId":"getMessagingServiceScanData","parameters":[{"name":"scanId","in":"path","description":"The ID of the messaging service scan.","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"The ID of the messaging service scan data.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The messaging service scan data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagingServiceScanDataResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v2/architecture/messagingServiceScans/{scanId}/logs":{"get":{"tags":["Messaging Service Scan Logs"],"summary":"Get a list of messaging service scan logs","description":"Use this API to get a list of messaging service scan logs that match the given parameters.<br><br><a href=\"https://api.solace.dev/cloud/reference/authentication\">Token Permissions</a>: [ <code>messaging_service_scan:read</code> ]","operationId":"getMessagingServiceScansLogs","parameters":[{"name":"scanId","in":"path","description":"The ID of the messaging service scan we want logs for.","required":true,"schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"The number of messaging service scan logs to get per page.","required":false,"schema":{"type":"integer","format":"int32","default":20,"maximum":100,"minimum":1}},{"name":"pageNumber","in":"query","description":"The page number to get.","required":false,"schema":{"type":"integer","format":"int32","default":1,"minimum":1}},{"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.\nDefine the sort order using the following string: `fieldname:asc/desc` where:\n\n- `fieldname` — The field name of the query parameter to sort by.\n- `asc` — Sort the selected field name in ascending order.\n- `desc` — Sort the selected field name in descending order.\n\nIf the direction is not specified, the default is ascending.\n\nYou can use multiple query parameters to refine the sorting order.\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The list of messaging service scan logs and the accompanying metadata.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagingServiceScanLogListResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v2/architecture/messagingServiceScans":{"get":{"tags":["Messaging Service Scans"],"summary":"Get a list of messaging service scans","description":"Use this API to get a list of messaging service scans that match the given parameters.<br><br><a href=\"https://api.solace.dev/cloud/reference/authentication\">Token Permissions</a>: [ <code>messaging_service_scan:read</code> ]","operationId":"getMessagingServiceScans","parameters":[{"name":"pageSize","in":"query","description":"The number of messaging service scans to get per page.","required":false,"schema":{"type":"integer","format":"int32","default":20,"maximum":100,"minimum":1}},{"name":"pageNumber","in":"query","description":"The page number to get.","required":false,"schema":{"type":"integer","format":"int32","default":1,"minimum":1}},{"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.\nDefine the sort order using the following string: `fieldname:asc/desc` where:\n\n- `fieldname` — The field name of the query parameter to sort by.\n- `asc` — Sort the selected field name in ascending order.\n- `desc` — Sort the selected field name in descending order.\n\nIf the direction is not specified, the default is ascending.\n\nYou can use multiple query parameters to refine the sorting order.\n","required":false,"schema":{"type":"string"}},{"name":"ids","in":"query","description":"The IDs of the messaging service scans.","required":false,"schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"messagingServiceId","in":"query","description":"Match only messaging service scans in the given messagingService","required":false,"schema":{"type":"string"}},{"name":"eventMeshId","in":"query","description":"Match only messaging service scans in the given eventMeshId","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The list of messaging service scans and the accompanying metadata.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagingServiceScansResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v2/architecture/messagingServiceScans/{id}":{"get":{"tags":["Messaging Service Scans"],"summary":"Get a messaging service scan","description":"Use this API to get a single messaging service scan by its ID.<br><br><a href=\"https://api.solace.dev/cloud/reference/authentication\">Token Permissions</a>: [ <code>messaging_service_scan:read</code> ]","operationId":"getMessagingServiceScan","parameters":[{"name":"id","in":"path","description":"The ID of the messaging service scan.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The messaging service scan.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagingServiceScanResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"delete":{"tags":["Messaging Service Scans"],"summary":"Delete a messaging service scan","description":"Use this API to delete a messaging service scan.<br><br><a href=\"https://api.solace.dev/cloud/reference/authentication\">Token Permissions</a>: [ <code>messaging_service_scan:write</code> ]","operationId":"deleteMessagingServiceScan","parameters":[{"name":"id","in":"path","description":"The ID of the messaging service scan.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No content is returned."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v2/architecture/messagingServices":{"get":{"tags":["Messaging Services"],"summary":"Get a list of messaging services","description":"Use this API to get a list of messaging services that match the given parameters.<br><br><a href=\"https://api.solace.dev/cloud/reference/authentication\">Token Permissions</a>: [ <code>event_designer:access</code> ]","operationId":"getMessagingServices","parameters":[{"name":"pageSize","in":"query","description":"The number of messaging services to get per page.","required":false,"schema":{"type":"integer","format":"int32","default":20,"maximum":100,"minimum":1}},{"name":"pageNumber","in":"query","description":"The page number to get.","required":false,"schema":{"type":"integer","format":"int32","default":1,"minimum":1}},{"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.\nDefine the sort order using the following string: `fieldname:asc/desc` where:\n\n- `fieldname` — The field name of the query parameter to sort by.\n- `asc` — Sort the selected field name in ascending order.\n- `desc` — Sort the selected field name in descending order.\n\nIf the direction is not specified, the default is ascending.\n\nYou can use multiple query parameters to refine the sorting order.\n","required":false,"schema":{"type":"string"}},{"name":"ids","in":"query","description":"The IDs of the messaging services.","required":false,"schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"messagingServiceType","in":"query","description":"Match only messaging services of the given type, options are: solace, kafka.","required":false,"schema":{"type":"string"}},{"name":"runtimeAgentId","in":"query","description":"Match only messaging services in the given runtimeAgentId","required":false,"schema":{"type":"string"}},{"name":"eventMeshId","in":"query","description":"Match only messaging services in the given eventMeshId","required":false,"schema":{"type":"string"}},{"name":"eventManagementAgentId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The list of messaging services and the accompanying metadata.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagingServicesResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"tags":["Messaging Services"],"summary":"Create a messaging service","description":"Use this API to create a messaging service.<br><br><a href=\"https://api.solace.dev/cloud/reference/authentication\">Token Permissions</a>: [ `modeled_event_broker:create:*` **or** `messaging_service:write` ]","operationId":"createMessagingService","requestBody":{"description":"The messaging service.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagingService"}}},"required":true},"responses":{"201":{"description":"Created a messaging service. The newly saved messaging service is returned in the response body.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagingServiceResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v2/architecture/messagingServices/{id}":{"get":{"tags":["Messaging Services"],"summary":"Get a messaging service","description":"Use this API to get a single messaging service by its ID.<br><br><a href=\"https://api.solace.dev/cloud/reference/authentication\">Token Permissions</a>: [ `modeled_event_broker:get:*` **or** `messaging_service:read` ]","operationId":"getMessagingService","parameters":[{"name":"id","in":"path","description":"The ID of the messaging service.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The messaging service.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagingServiceResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"delete":{"tags":["Messaging Services"],"summary":"Delete a messaging service","description":"Use this API to delete a messaging service.<br><br><a href=\"https://api.solace.dev/cloud/reference/authentication\">Token Permissions</a>: [ `modeled_event_broker:delete:*` **or** `messaging_service:write` ]","operationId":"deleteMessagingService","parameters":[{"name":"id","in":"path","description":"The ID of the messaging service.","required":true,"schema":{"type":"string"}},{"name":"force","in":"query","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"204":{"description":"No content is returned."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"tags":["Messaging Services"],"summary":"Update a messaging service","description":"Use this API to update a messaging service. You only need to specify the fields that need to be updated. However, if you want to update anything under subObjects (i.e. anything inside messagingServiceConnections object), you need to provide the original messagingServiceConnections with the updated fields instead of just providing the changed fields.<br><br><a href=\"https://api.solace.dev/cloud/reference/authentication\">Token Permissions</a>: [ `modeled_event_broker:update:*` **or** `messaging_service:write` ]","operationId":"updateMessagingService","parameters":[{"name":"id","in":"path","description":"The ID of the messaging service to update.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The messaging service.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagingService"}}},"required":true},"responses":{"200":{"description":"The updated messaging service.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagingServiceResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v2/architecture/messagingServices/{id}/removeAssociation":{"put":{"tags":["Messaging Services"],"summary":"Remove an association between an messaging service and the requested entity","description":"Use this API to remove the association between a messaging service and either of EVENT_MESH or EVENT_MANAGEMENT_AGENT.<br><br><a href=\"https://api.solace.dev/cloud/reference/authentication\">Token Permissions</a>: [ `modeled_event_broker:update:*` **or** `messaging_service:write` ]","operationId":"removeAssociationMessagingService","parameters":[{"name":"id","in":"path","description":"The ID of the messaging service.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The association object with the value matching either EVENT_MESH or EVENT_MANAGEMENT_AGENT.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagingServiceRemoveAssociation"}}},"required":true},"responses":{"200":{"description":"The updated messaging service, e.g. if the API request body had {\"association\": \"EVENT_MESH\"} then the resulting object would not have eventMeshId attribute.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagingServiceResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v2/architecture/messagingServices/{messagingServiceId}/scanStart":{"put":{"tags":["Messaging Services"],"summary":"Initiate a scan request to run against a messaging service","description":"Use this API to make a scan request on a messaging service.<br><br><a href=\"https://api.solace.dev/cloud/reference/authentication\">Token Permissions</a>: [ `modeled_event_broker:update:*` **or** `messaging_service:write` ]","operationId":"scanStartMessagingService","parameters":[{"name":"messagingServiceId","in":"path","description":"The ID of the messaging service.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The messaging service.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagingServiceOperation"}}},"required":true},"responses":{"200":{"description":"Requested a scan on the messaging service. The operation object with ID set as ID of the created scan Object is returned in the response body.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagingServiceOperationResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v2/architecture/about/modeledEventBrokers":{"get":{"tags":["Modeled Event Broker"],"summary":"Get a list of basic information for all model event brokers","description":"Get a list of basic information for all model event brokers.\n\nYour token must have one of the permissions listed in the Token Permissions.\n<br><br><a href=\"https://api.solace.dev/cloud/reference/authentication\">Token Permissions</a>: [ <code>modeled_event_broker:get_info:*</code> ]","operationId":"getMessagingServiceInfo","parameters":[{"name":"pageSize","in":"query","description":"The number of model event brokers to return per page.","required":false,"schema":{"type":"integer","format":"int32","default":20,"maximum":100,"minimum":1}},{"name":"pageNumber","in":"query","description":"The page number to retrieve.","required":false,"schema":{"type":"integer","format":"int32","default":1,"minimum":1}},{"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.\nDefine the sort order using the following string: `fieldname:asc/desc` where:\n\n- `fieldname` — The field name of the query parameter to sort by.\n- `asc` — Sort the selected field name in ascending order.\n- `desc` — Sort the selected field name in descending order.\n\nIf the direction is not specified, the default is ascending.\n\nYou can use multiple query parameters to refine the sorting order.\n","required":false,"schema":{"type":"string"}},{"name":"ids","in":"query","description":"The unique identifiers of the model event brokers to retrieve, separated by commas.","required":false,"schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ModeledEventBrokerInfoResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}},"components":{"schemas":{"Address":{"type":"object","properties":{"createdTime":{"type":"string","description":"The time the entity was created","example":"2021-12-31T20:30:57.920Z","readOnly":true},"updatedTime":{"type":"string","description":"The time the entity was last updated","example":"2021-12-31T20:30:57.920Z","readOnly":true},"createdBy":{"type":"string","description":"The user who created the entity","example":12345678,"readOnly":true},"changedBy":{"type":"string","description":"The user who last updated the entity","example":12345678,"readOnly":true},"id":{"type":"string","example":"xyz23mwec2g","readOnly":true},"addressLevels":{"type":"array","items":{"$ref":"#/components/schemas/AddressLevel"}},"addressType":{"type":"string","enum":["topic"]},"type":{"type":"string"}},"required":["addressLevels"]},"AddressLevel":{"type":"object","properties":{"name":{"type":"string","example":"root"},"addressLevelType":{"type":"string","enum":["literal","variable"]},"enumVersionId":{"type":"string"}},"required":["addressLevelType","name"]},"ApplicationConfigPushJobConfigurationResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ApplicationConfigurationPushJobConfiguration"},"meta":{"$ref":"#/components/schemas/meta"}}},"ApplicationConfigPushJobResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ApplicationConfigurationPushJob"},"meta":{"$ref":"#/components/schemas/meta"}}},"ApplicationConfigPushJobsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationConfigurationPushJob"}},"meta":{"$ref":"#/components/schemas/meta"}}},"ApplicationConfigurationPushJob":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the application configuration push job.","example":"xyz23mwec2g"},"eventBrokerId":{"type":"string","description":"The unique identifier of the modeled event broker the application configuration push job is for.","example":"acb2j5k3mly"},"applicationId":{"type":"string","description":"The unique identifier of the application the application configuration push job is for.","example":"8pg75d6fp0e"},"sourceType":{"type":"string","description":"The type of the source the application configuration push job is created from.","enum":["changeRecord"],"example":"changeRecord"},"sourceId":{"type":"string","description":"The unique identifier of the source the application configuration push job is created from.","example":"mca5sf9k3ut"},"requestMetadata":{"type":"object","additionalProperties":{},"description":"The request metadata in JSON format.","example":"'object': { 'field': 'description' }"},"status":{"type":"string","description":"The status of the application configuration push job.","enum":["pending","cancelled","in_progress","error","validation_error","success"]},"createdTime":{"type":"string","description":"The time the entity was created.","example":"2021-12-31T20:30:57.920Z","readOnly":true},"errorDescription":{"type":"string","description":"The error description of the failed application configuration push job.","example":"The event broker configuration operation timed out."},"updatedTime":{"type":"string","description":"The time the entity was last updated.","example":"2021-12-31T20:30:57.920Z","readOnly":true},"result":{"type":"object","additionalProperties":{},"description":"The result metadata of the job in JSON format.","example":"'object': { 'field': 'description' }"},"removal":{"type":"boolean"},"type":{"type":"string"},"isRemoval":{"type":"boolean","description":"Specifies whether the configuration push job is for the removal of an application from an event broker.","example":true}}},"ApplicationConfigurationPushJobConfiguration":{"type":"object","properties":{"id":{"type":"string"},"hclConfigurations":{"type":"string"},"environmentVariables":{"type":"object","additionalProperties":{"type":"string"}},"type":{"type":"string"}}},"ApplicationDeployment":{"type":"object","properties":{"createdTime":{"type":"string","description":"The time the entity was created","example":"2021-12-31T20:30:57.920Z","readOnly":true},"updatedTime":{"type":"string","description":"The time the entity was last updated","example":"2021-12-31T20:30:57.920Z","readOnly":true},"createdBy":{"type":"string","description":"The user who created the entity","example":12345678,"readOnly":true},"changedBy":{"type":"string","description":"The user who last updated the entity","example":12345678,"readOnly":true},"applicationVersionId":{"type":"string","description":"The unique identifier of the application version to deploy.","example":"xyz23mwec2g","minLength":1},"action":{"type":"string","description":"The deployment action to perform for the application version.","enum":["deploy","undeploy"]},"eventBrokerId":{"type":"string","description":"The unique identifier of the model event broker to deploy to.","example":"acb2j5k3mly","minLength":1}},"required":["action","applicationVersionId","eventBrokerId"]},"ApplicationDeploymentPreviewDTO":{"type":"object","properties":{"requested":{"type":"array","items":{"$ref":"#/components/schemas/PreviewEntityConfigurationDTO"}},"existing":{"type":"array","items":{"$ref":"#/components/schemas/PreviewEntityConfigurationDTO"}}}},"ApplicationDeploymentPreviewResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ApplicationDeploymentPreviewDTO"},"meta":{"type":"object","additionalProperties":{}}}},"ApplicationDeploymentResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ApplicationDeploymentResultDTO"},"meta":{"type":"object","additionalProperties":{}}}},"ApplicationDeploymentResultDTO":{"type":"object","properties":{"changeRecordId":{"type":"string","description":"The unique identifier of the changeRecord created for the deployment. For environments with configuration push enabled, this id correlates with the resulting configuration push job."}}},"ApplicationPromotionListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationPromotionRequest"}},"meta":{"$ref":"#/components/schemas/meta"}}},"ApplicationPromotionPreviewRequestDTO":{"type":"object","properties":{"applicationVersionId":{"type":"string","minLength":1},"eventBrokerId":{"type":"string","minLength":1},"action":{"type":"string","description":"The action to be performed on the application","enum":["promote","remove"],"example":"promote"}},"required":["action","applicationVersionId","eventBrokerId"]},"ApplicationPromotionRequest":{"type":"object","properties":{"createdTime":{"type":"string","description":"The time the entity was created","example":"2021-12-31T20:30:57.920Z","readOnly":true},"updatedTime":{"type":"string","description":"The time the entity was last updated","example":"2021-12-31T20:30:57.920Z","readOnly":true},"createdBy":{"type":"string","description":"The user who created the entity","example":12345678,"readOnly":true},"changedBy":{"type":"string","description":"The user who last updated the entity","example":12345678,"readOnly":true},"id":{"type":"string","example":12345678,"readOnly":true},"description":{"type":"string","example":"Description of the promotion request"},"applicationVersionId":{"type":"string","example":12345678},"applicationId":{"type":"string","example":12345678,"readOnly":true},"eventBrokerId":{"type":"string","example":12345678},"reviewStatus":{"type":"string","example":12345678,"readOnly":true},"requestStatus":{"type":"string","example":12345678,"readOnly":true},"promotedTime":{"type":"string","description":"The time the request was promoted","example":"2024-04-15T10:00:00.000Z","readOnly":true},"action":{"type":"string","description":"The action to be performed on the application","enum":["promote","remove"],"example":"promote"},"type":{"type":"string","readOnly":true}},"required":["action","applicationVersionId","eventBrokerId","requestStatus","reviewStatus"]},"ApplicationPromotionRequestResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ApplicationPromotionRequest"},"meta":{"type":"object","additionalProperties":{}}}},"ApplicationVersion":{"type":"object","properties":{"createdTime":{"type":"string","description":"The time the entity was created","example":"2021-12-31T20:30:57.920Z","readOnly":true},"updatedTime":{"type":"string","description":"The time the entity was last updated","example":"2021-12-31T20:30:57.920Z","readOnly":true},"createdBy":{"type":"string","description":"The user who created the entity","example":12345678,"readOnly":true},"changedBy":{"type":"string","description":"The user who last updated the entity","example":12345678,"readOnly":true},"id":{"type":"string","example":"xyz23mwec2g","readOnly":true},"applicationId":{"type":"string","example":"acb2j5k3mly"},"description":{"type":"string","example":"Application created by Solace Cloud documentation","maxLength":10000},"version":{"type":"string","example":"1.0.0"},"displayName":{"type":"string","example":"Display name for the version","maxLength":40},"declaredProducedEventVersionIds":{"type":"array","items":{"type":"string","example":["5h2km5khkj","h5mk26hkm2"]}},"declaredConsumedEventVersionIds":{"type":"array","items":{"type":"string","example":["5h2km5khkj","h5mk26hkm2"]}},"declaredEventApiProductVersionIds":{"type":"array","items":{"type":"string","example":["5h2km5khkj","h5mk26hkm2"]}},"stateId":{"type":"string","example":1,"readOnly":true},"consumers":{"type":"array","items":{"$ref":"#/components/schemas/Consumer"},"readOnly":true},"customAttributes":{"type":"array","items":{"$ref":"#/components/schemas/CustomAttribute"}},"messagingServiceIds":{"type":"array","items":{"type":"string","example":["5h2km5khkj","h5mk26hkm2"],"readOnly":true}},"validationMessages":{"$ref":"#/components/schemas/ValidationMessagesDTO"},"endOfLifeDate":{"type":"string","example":"2021-12-31T20:30:57.920Z"},"inboundApplicationVersionAssociations":{"type":"array","description":"The application versions that reference this application version. targetId can be left blank","items":{"$ref":"#/components/schemas/ApplicationVersionToApplicationVersionAssocation"}},"outboundApplicationVersionAssociations":{"type":"array","description":"The application versions that reference this application version. sourceId can be left blank","items":{"$ref":"#/components/schemas/ApplicationVersionToApplicationVersionAssocation"}},"type":{"type":"string"}},"required":["applicationId","version"]},"ApplicationVersionToApplicationVersionAssocation":{"type":"object","properties":{"sourceId":{"type":"string"},"destinationId":{"type":"string"}}},"AttractedEventVersionTuple":{"type":"object","properties":{"eventVersionId":{"type":"string"},"eventMeshIds":{"type":"array","items":{"type":"string"},"uniqueItems":true}}},"AttractingApplicationVersionTuple":{"type":"object","properties":{"applicationVersionId":{"type":"string"},"eventMeshIds":{"type":"array","items":{"type":"string"},"uniqueItems":true}}},"AuditRelationDTO":{"type":"object","properties":{"auditEntityType":{"type":"string"},"auditId":{"type":"string"},"identifier":{"type":"string"},"status":{"type":"string"}}},"AuditResult":{"type":"object","properties":{"createdTime":{"type":"string","description":"The time the entity was created","example":"2021-12-31T20:30:57.920Z","readOnly":true},"updatedTime":{"type":"string","description":"The time the entity was last updated","example":"2021-12-31T20:30:57.920Z","readOnly":true},"createdBy":{"type":"string","description":"The user who created the entity","example":12345678,"readOnly":true},"changedBy":{"type":"string","description":"The user who last updated the entity","example":12345678,"readOnly":true},"id":{"type":"string","example":12345678,"readOnly":true},"eventBrokerId":{"type":"string","example":12345678,"readOnly":true},"auditEntityType":{"type":"string","example":"solaceQueue","readOnly":true},"eventBrokerName":{"type":"string","example":"My Solace Service","readOnly":true},"identifier":{"type":"string","example":"orderEventQueue","readOnly":true},"status":{"type":"string","example":"partialMatch","readOnly":true},"schemaType":{"type":"string"},"type":{"type":"string"}}},"AuditResultDetail":{"type":"object","properties":{"createdTime":{"type":"string","description":"The time the entity was created","example":"2021-12-31T20:30:57.920Z","readOnly":true},"updatedTime":{"type":"string","description":"The time the entity was last updated","example":"2021-12-31T20:30:57.920Z","readOnly":true},"createdBy":{"type":"string","description":"The user who created the entity","example":12345678,"readOnly":true},"changedBy":{"type":"string","description":"The user who last updated the entity","example":12345678,"readOnly":true},"id":{"type":"string","example":12345678,"readOnly":true},"parentId":{"type":"string","example":12345678,"readOnly":true},"versionId":{"type":"string","example":12345678,"readOnly":true},"entityId":{"type":"string","example":12345678,"readOnly":true},"scanId":{"type":"string","example":12345678,"readOnly":true},"status":{"type":"string","example":"partialMatch","readOnly":true},"identifier":{"type":"string","example":"orderEventQueue","readOnly":true},"relations":{"type":"array","items":{"$ref":"#/components/schemas/AuditRelationDTO","readOnly":true}},"type":{"type":"string"}}},"AuditResultDetailResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AuditResultDetail"},"meta":{"type":"object","additionalProperties":{}}}},"AuditResultsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AuditResult"}},"meta":{"$ref":"#/components/schemas/meta"}}},"ConfigPushJobStatusUpdateRequest":{"type":"object","properties":{"status":{"type":"string","enum":["pending","cancelled","in_progress","error","validation_error","success"]},"errorDescription":{"type":"string","description":"Optional error description for error status transitions"}},"required":["status"]},"Consumer":{"type":"object","properties":{"createdTime":{"type":"string","description":"The time the entity was created","example":"2021-12-31T20:30:57.920Z","readOnly":true},"updatedTime":{"type":"string","description":"The time the entity was last updated","example":"2021-12-31T20:30:57.920Z","readOnly":true},"createdBy":{"type":"string","description":"The user who created the entity","example":12345678,"readOnly":true},"changedBy":{"type":"string","description":"The user who last updated the entity","example":12345678,"readOnly":true},"id":{"type":"string","example":"xyz23mwec2g","readOnly":true},"name":{"type":"string","example":"My First Consumer","maxLength":255,"minLength":1},"applicationVersionId":{"type":"string","example":"acb2j5k3mly"},"brokerType":{"type":"string","example":"solace"},"consumerType":{"type":"string","example":"eventQueue"},"subscriptions":{"type":"array","items":{"$ref":"#/components/schemas/Subscription"}},"type":{"type":"string"}},"required":["applicationVersionId"]},"CustomAttribute":{"type":"object","properties":{"customAttributeDefinitionId":{"type":"string","example":"acb2j5k3mly"},"customAttributeDefinitionName":{"type":"string","example":"color","pattern":"a-zA-Z0-9_\\-\\."},"value":{"type":"string","example":"red","pattern":"a-zA-Z0-9_\\-\\."},"stringValues":{"type":"string","example":"red","pattern":"a-zA-Z0-9_\\-\\."}}},"DeliveryDescriptor":{"type":"object","properties":{"createdTime":{"type":"string","description":"The time the entity was created","example":"2021-12-31T20:30:57.920Z","readOnly":true},"updatedTime":{"type":"string","description":"The time the entity was last updated","example":"2021-12-31T20:30:57.920Z","readOnly":true},"createdBy":{"type":"string","description":"The user who created the entity","example":12345678,"readOnly":true},"changedBy":{"type":"string","description":"The user who last updated the entity","example":12345678,"readOnly":true},"brokerType":{"type":"string"},"address":{"$ref":"#/components/schemas/Address"},"keySchemaVersionId":{"type":"string","example":"shb3mlyec2g"},"keySchemaPrimitiveType":{"type":"string","enum":["BOOLEAN","BYTES","DOUBLE","FLOAT","INT","LONG","NULL","NUMBER","STRING"],"example":"BYTES"},"id":{"type":"string"},"type":{"type":"string"}}},"DeploymentPreviewError":{"type":"object","properties":{"conflictType":{"type":"string","enum":["clientUsername","authorizationGroupName","queueName","aclProfileName"]},"configurationTypeId":{"type":"string"},"type":{"type":"string"},"subType":{"type":"string"}}},"Environment":{"type":"object","properties":{"createdTime":{"type":"string","description":"The time the entity was created","example":"2021-12-31T20:30:57.920Z","readOnly":true},"updatedTime":{"type":"string","description":"The time the entity was last updated","example":"2021-12-31T20:30:57.920Z","readOnly":true},"createdBy":{"type":"string","description":"The user who created the entity","example":12345678,"readOnly":true},"changedBy":{"type":"string","description":"The user who last updated the entity","example":12345678,"readOnly":true},"id":{"type":"string","example":"xyz123abc","readOnly":true},"name":{"type":"string","deprecated":true,"description":"*Deprecation Date: 2025-01-17<br>Removal Date: 2026-01-17<br>Reason: Environment name should be fetched from Platform APIs.*<br>","example":"Staging environment","readOnly":true},"description":{"type":"string","deprecated":true,"description":"*Deprecation Date: 2025-01-17<br>Removal Date: 2026-01-17<br>Reason: Environment description should be fetched from Platform APIs.*<br>","example":"The description of my environment","readOnly":true},"revision":{"type":"integer","format":"int32","deprecated":true,"description":"*Deprecation Date: 2025-01-17<br>Removal Date: 2026-01-17<br>Reason: Environment revision should be fetched from Platform APIs.*<br>","readOnly":true},"numberOfEventMeshes":{"type":"integer","format":"int32","readOnly":true},"configPush":{"type":"string","description":"The configuration push mode where 'disabled' indicates that configuration changes will not be pushed to event broker on deployment. 'auto' indicates that configuration changes will be automatically pushed to event broker on deployment. 'onDemand' indicates that configuration changes will be pushed to event broker only when requested by the user. 'selfManaged' indicates that the user is responsible for pushing configuration changes to event broker.","enum":["auto","disabled","onDemand","selfManaged"],"example":"auto | disabled | onDemand | selfManaged"},"enforcedConfigurationTemplateTypeIds":{"type":"array","description":"The configuration template type ids required by this environment for deployment to an event broker.","example":"[solaceClientProfileName, solaceQueue]","items":{"type":"string"}},"type":{"type":"string","readOnly":true}}},"EnvironmentInfo":{"type":"object","properties":{"createdTime":{"type":"string","description":"The time the entity was created","example":"2021-12-31T20:30:57.920Z","readOnly":true},"updatedTime":{"type":"string","description":"The time the entity was last updated","example":"2021-12-31T20:30:57.920Z","readOnly":true},"createdBy":{"type":"string","description":"The user who created the entity","example":12345678,"readOnly":true},"changedBy":{"type":"string","description":"The user who last updated the entity","example":12345678,"readOnly":true},"id":{"type":"string","description":"The unique identifier of the environment.","example":"xyz123abc","readOnly":true},"name":{"type":"string","deprecated":true,"description":"*Deprecation Date: 2025-01-17<br>Removal Date: 2026-01-17<br>Reason: Environment name should be fetched from Platform APIs.*<br>","example":"Staging environment","readOnly":true},"allowedActions":{"type":"array","description":"The types of environment information a user is permitted to retrieve. Users with 'get_info' may use the 'about/environments' API. Users with any other action may use the standard '/environments' API.","example":"[get, get_info, update]","items":{"type":"string"},"readOnly":true,"uniqueItems":true},"type":{"type":"string","enum":["environmentInfo"],"readOnly":true}}},"EnvironmentInfoResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EnvironmentInfo"}},"meta":{"$ref":"#/components/schemas/meta"}}},"EnvironmentResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Environment"},"meta":{"type":"object","additionalProperties":{}}}},"EnvironmentsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Environment"}},"meta":{"$ref":"#/components/schemas/meta"}}},"ErrorResponse":{"type":"object","discriminator":{"propertyName":"errorType"},"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":{},"example":"'object': { 'field': 'description' }"},"validationDetails":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"description":"When applicable, these are the details of issues with the fields provided for the REST call.","example":"'name': ['Not unique']"},"errorType":{"type":"string","writeOnly":true}}},"EventManagementAgent":{"type":"object","properties":{"createdTime":{"type":"string","description":"The time the entity was created","example":"2021-12-31T20:30:57.920Z","readOnly":true},"updatedTime":{"type":"string","description":"The time the entity was last updated","example":"2021-12-31T20:30:57.920Z","readOnly":true},"createdBy":{"type":"string","description":"The user who created the entity","example":12345678,"readOnly":true},"changedBy":{"type":"string","description":"The user who last updated the entity","example":12345678,"readOnly":true},"id":{"type":"string","description":"Primary key set by the server.","example":"sdagkjlh32x","readOnly":true},"name":{"type":"string","description":"The name of the EMA.","example":"primary event management agent"},"region":{"type":"string","description":"The region in which the EMA belongs to, extracted from the EventManagementAgentRegion.","example":"North America","readOnly":true},"referencedByMessagingServiceIds":{"type":"array","items":{"type":"string","description":"The list of messagingServiceIds user provides in GET APIs to filter the results.","example":["1kjdsf32","9875ksdf"],"readOnly":true}},"orgId":{"type":"string","description":"Used by admin APIs to get a list of EMAs against the given orgId.","example":"897xd32","readOnly":true},"status":{"type":"string","description":"The connection status of EP to the actual EMA which this object represents.","example":"Connected","readOnly":true},"lastConnectedTime":{"type":"string","description":"The timestamp of last heartbeat received from the EMA.","example":"2021-12-31T20:30:57.920Z","readOnly":true},"version":{"type":"string","description":"The version of the current connected EMA.","example":"1.1.2","readOnly":true},"runtimeAgentMode":{"type":"string","description":"The mode that the EMA operates in. scanWithEventPortal is equivalent to Connected, and uploadScanFile is equivalent to Offline.","enum":["scanWithEventPortal","uploadScanFile"],"example":"scanWithEventPortal","readOnly":true},"updateRequired":{"type":"boolean","description":"Determines whether the EMA needs an upgrade.","example":true,"readOnly":true},"eventManagementAgentRegionId":{"type":"string","description":"The ID of the associated EventManagementAgentRegion.","example":"sdfkjh3242ds"},"type":{"type":"string","readOnly":true}}},"EventManagementAgentResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EventManagementAgent"},"meta":{"type":"object","additionalProperties":{}}}},"EventManagementAgentsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EventManagementAgent"}},"meta":{"$ref":"#/components/schemas/meta"}}},"EventMesh":{"type":"object","properties":{"createdTime":{"type":"string","description":"The time the entity was created","example":"2021-12-31T20:30:57.920Z","readOnly":true},"updatedTime":{"type":"string","description":"The time the entity was last updated","example":"2021-12-31T20:30:57.920Z","readOnly":true},"createdBy":{"type":"string","description":"The user who created the entity","example":12345678,"readOnly":true},"changedBy":{"type":"string","description":"The user who last updated the entity","example":12345678,"readOnly":true},"id":{"type":"string","description":"Primary key set by the server.","example":12345,"readOnly":true},"name":{"type":"string","description":"The name of the modeled event mesh.","example":"Inventory","maxLength":40,"minLength":1},"environmentId":{"type":"string","description":"The environmentId of the modeled event mesh.","example":67890,"maxLength":255,"minLength":1},"description":{"type":"string","description":"The description of the modeled event mesh.","example":"The Inventory Event Mesh applications.","maxLength":10000,"minLength":1},"brokerType":{"type":"string","description":"The type of the event broker used in the modeled event mesh.","enum":["kafka","solace"]},"type":{"type":"string","description":"The type of this payload, eventMesh.","readOnly":true}},"required":["environmentId"]},"EventMeshInfoDTO":{"type":"object","properties":{"createdTime":{"type":"string","description":"The time the entity was created","example":"2021-12-31T20:30:57.920Z","readOnly":true},"updatedTime":{"type":"string","description":"The time the entity was last updated","example":"2021-12-31T20:30:57.920Z","readOnly":true},"createdBy":{"type":"string","description":"The user who created the entity","example":12345678,"readOnly":true},"changedBy":{"type":"string","description":"The user who last updated the entity","example":12345678,"readOnly":true},"name":{"type":"string","description":"The name of the modeled event mesh.","example":"Inventory","maxLength":40,"minLength":1},"id":{"type":"string","description":"The unique identifier of the modeled event mesh.","example":12345,"readOnly":true},"description":{"type":"string","description":"The description of the modeled event mesh.","example":"The Inventory Event Meshapplications.","maxLength":10000,"minLength":1},"environmentId":{"type":"string","description":"The unique identifier of the environment that contains the modeled event mesh.","example":67890,"maxLength":255,"minLength":1},"brokerType":{"type":"string","description":"The type of the broker used in the modeled event mesh.","enum":["kafka","solace"]},"allowedActions":{"type":"array","description":"The types of modeled event mesh information a user is permitted to retrieve. Users with the 'get_info' action can use the 'about/modeledEventMeshes' API. Users with any other action can use the standard '/eventMeshes' API.","example":"[get, get_info]","items":{"type":"string"},"readOnly":true,"uniqueItems":true},"type":{"type":"string"}}},"EventMeshResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EventMesh"},"meta":{"type":"object","additionalProperties":{}}}},"EventMeshWarningResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EventMeshWarnings"},"meta":{"type":"object","additionalProperties":{}}}},"EventMeshWarnings":{"type":"object","properties":{"eventMesh":{"$ref":"#/components/schemas/EventMesh"},"applicationVersions":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationVersion"}},"eventVersions":{"type":"array","items":{"$ref":"#/components/schemas/EventVersion"}}}},"EventMeshesInfoResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EventMeshInfoDTO"}},"meta":{"$ref":"#/components/schemas/meta"}}},"EventMeshesResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EventMesh"}},"meta":{"$ref":"#/components/schemas/meta"}}},"EventPortalUsageStats":{"type":"object","properties":{"schemaCount":{"type":"integer","format":"int32","readOnly":true},"domainScopedCustomAttributeCount":{"type":"integer","format":"int32","readOnly":true},"orgScopedCustomAttributeCount":{"type":"integer","format":"int32","readOnly":true},"eventCount":{"type":"integer","format":"int32","readOnly":true},"selfManagedEventManagementAgentCount":{"type":"integer","format":"int32","readOnly":true},"applicationCount":{"type":"integer","format":"int32","readOnly":true},"applicationDomainCount":{"type":"integer","format":"int32","readOnly":true},"eventApiCount":{"type":"integer","format":"int32","readOnly":true},"subscriptionCount":{"type":"integer","format":"int32","readOnly":true},"consumerCount":{"type":"integer","format":"int32","readOnly":true},"enumCount":{"type":"integer","format":"int32","readOnly":true},"enumValueCount":{"type":"integer","format":"int32","readOnly":true},"sumUniqueEventsInEachEnvironmentCount":{"type":"integer","format":"int32","readOnly":true},"sumUniqueSchemasInEachEnvironmentCount":{"type":"integer","format":"int32","readOnly":true},"sumUniqueApplicationsInEachEnvironmentCount":{"type":"integer","format":"int32","readOnly":true},"environmentIdToUniqueEventsCount":{"type":"object","additionalProperties":{"type":"integer","format":"int32"},"readOnly":true},"environmentIdToUniqueApplicationsCount":{"type":"object","additionalProperties":{"type":"integer","format":"int32"},"readOnly":true},"environmentIdToUniqueSchemasCount":{"type":"object","additionalProperties":{"type":"integer","format":"int32"},"readOnly":true}}},"EventVersion":{"type":"object","properties":{"createdTime":{"type":"string","description":"The time the entity was created","example":"2021-12-31T20:30:57.920Z","readOnly":true},"updatedTime":{"type":"string","description":"The time the entity was last updated","example":"2021-12-31T20:30:57.920Z","readOnly":true},"createdBy":{"type":"string","description":"The user who created the entity","example":12345678,"readOnly":true},"changedBy":{"type":"string","description":"The user who last updated the entity","example":12345678,"readOnly":true},"id":{"type":"string","example":"xyz23mwec2g","readOnly":true},"eventId":{"type":"string","example":"acb2j5k3mly"},"description":{"type":"string","example":"Event version created by Solace Cloud documentation","maxLength":10000},"version":{"type":"string","example":"1.0.0"},"displayName":{"type":"string","example":"Display name for the version","maxLength":40,"minLength":0},"declaredProducingApplicationVersionIds":{"type":"array","items":{"type":"string","example":["5h2km5khkj","h5mk26hkm2"],"readOnly":true}},"declaredConsumingApplicationVersionIds":{"type":"array","items":{"type":"string","example":["5h2km5khkj","h5mk26hkm2"],"readOnly":true}},"producingEventApiVersionIds":{"type":"array","items":{"type":"string","example":["5h2km5khkj","h5mk26hkm2"],"readOnly":true}},"consumingEventApiVersionIds":{"type":"array","items":{"type":"string","example":["5h2km5khkj","h5mk26hkm2"],"readOnly":true}},"attractingApplicationVersionIds":{"type":"array","items":{"$ref":"#/components/schemas/AttractingApplicationVersionTuple"},"readOnly":true},"schemaVersionId":{"type":"string","example":"shb3mlyec2g"},"schemaPrimitiveType":{"type":"string","enum":["BOOLEAN","BYTES","DOUBLE","FLOAT","INT","LONG","NULL","NUMBER","STRING"],"example":"BYTES"},"deliveryDescriptor":{"$ref":"#/components/schemas/DeliveryDescriptor"},"stateId":{"type":"string","example":1,"readOnly":true},"customAttributes":{"type":"array","items":{"$ref":"#/components/schemas/CustomAttribute"}},"messagingServiceIds":{"type":"array","items":{"type":"string","example":["5h2km5khkj","h5mk26hkm2"],"readOnly":true}},"validationMessages":{"$ref":"#/components/schemas/ValidationMessagesDTO"},"endOfLifeDate":{"type":"string","example":"2021-12-31T20:30:57.920Z"},"type":{"type":"string"}},"required":["eventId","version"]},"MessagingService":{"type":"object","properties":{"createdTime":{"type":"string","description":"The time the entity was created","example":"2021-12-31T20:30:57.920Z","readOnly":true},"updatedTime":{"type":"string","description":"The time the entity was last updated","example":"2021-12-31T20:30:57.920Z","readOnly":true},"createdBy":{"type":"string","description":"The user who created the entity","example":12345678,"readOnly":true},"changedBy":{"type":"string","description":"The user who last updated the entity","example":12345678,"readOnly":true},"id":{"type":"string","description":"Primary key set by the server.","example":"asdkl234x","readOnly":true},"eventMeshId":{"type":"string","description":"The eventMeshId associated to the messaging service.","example":"67890x23vh"},"runtimeAgentId":{"type":"string","description":"The runtimeAgentId associated to the messaging service.","example":"vh1234y14"},"solaceCloudMessagingServiceId":{"type":"string","description":"The solaceCloudMessagingServiceId associated to the messaging service.","example":"abcd1234x"},"datacenterId":{"type":"string","description":"The datacenterId associated to the messaging service.","example":"dasglk213x"},"messagingServiceType":{"type":"string","description":"The type of the messaging service.","enum":["solace","kafka"],"example":"solace"},"name":{"type":"string","description":"The name of the messaging service.","example":"first messagingService"},"messagingServiceConnections":{"type":"array","items":{"$ref":"#/components/schemas/MessagingServiceConnection"}},"eventManagementAgentId":{"type":"string"},"type":{"type":"string","readOnly":true}}},"MessagingServiceAuthentication":{"type":"object","properties":{"createdTime":{"type":"string","description":"The time the entity was created","example":"2021-12-31T20:30:57.920Z","readOnly":true},"updatedTime":{"type":"string","description":"The time the entity was last updated","example":"2021-12-31T20:30:57.920Z","readOnly":true},"createdBy":{"type":"string","description":"The user who created the entity","example":12345678,"readOnly":true},"changedBy":{"type":"string","description":"The user who last updated the entity","example":12345678,"readOnly":true},"id":{"type":"string","description":"Primary key set by the server.","example":"kjsfg32ds","readOnly":true},"messagingServiceConnectionId":{"type":"string","description":"The ID of the connection object associated to the authentication object.","example":"sdafgj23","readOnly":true},"name":{"type":"string","description":"The name of the authentication object.","example":"https auth details"},"authenticationType":{"type":"string","description":"The type of the authentication object.","example":"basicAuthentication"},"authenticationDetails":{"type":"object","additionalProperties":{},"description":"A JSON map containing a map of extra details for the authentication.","example":{"broker owner":"Solace PE team"}},"messagingServiceCredentials":{"type":"array","items":{"$ref":"#/components/schemas/MessagingServiceCredentials"}},"type":{"type":"string","readOnly":true}},"required":["authenticationType","name"]},"MessagingServiceConnection":{"type":"object","properties":{"createdTime":{"type":"string","description":"The time the entity was created","example":"2021-12-31T20:30:57.920Z","readOnly":true},"updatedTime":{"type":"string","description":"The time the entity was last updated","example":"2021-12-31T20:30:57.920Z","readOnly":true},"createdBy":{"type":"string","description":"The user who created the entity","example":12345678,"readOnly":true},"changedBy":{"type":"string","description":"The user who last updated the entity","example":12345678,"readOnly":true},"id":{"type":"string","description":"Primary key set by the server.","example":"5432dfg3","readOnly":true},"messagingServiceId":{"type":"string","description":"The messagingServiceId associated to the connection object.","example":"sdkjhg21948","readOnly":true},"name":{"type":"string","description":"The name of the connection object.","example":"my https connection"},"url":{"type":"string","description":"The url of the connection object.","example":"https://abcd.messaging.solace.cloud:943"},"protocol":{"type":"string","description":"The protocol of the connection object.","example":"https"},"protocolVersion":{"type":"string","description":"The protocolVersion of the connection object.","example":2},"bindings":{"type":"object","additionalProperties":{},"description":"A JSON map containing a map of connection-specific values. ","example":{"msgVpn":"myVPN"}},"messagingServiceAuthentications":{"type":"array","items":{"$ref":"#/components/schemas/MessagingServiceAuthentication"}},"type":{"type":"string","readOnly":true}}},"MessagingServiceCredentials":{"type":"object","properties":{"createdTime":{"type":"string","description":"The time the entity was created","example":"2021-12-31T20:30:57.920Z","readOnly":true},"updatedTime":{"type":"string","description":"The time the entity was last updated","example":"2021-12-31T20:30:57.920Z","readOnly":true},"createdBy":{"type":"string","description":"The user who created the entity","example":12345678,"readOnly":true},"changedBy":{"type":"string","description":"The user who last updated the entity","example":12345678,"readOnly":true},"id":{"type":"string","description":"Primary key set by the server.","example":"lkjdsfgew2","readOnly":true},"messagingServiceAuthenticationId":{"type":"string","description":"The ID of the authentication object associated to the credentials object.","example":"sdafgj23","readOnly":true},"name":{"type":"string","description":"The name of the credentials object.","example":"basic auth credentials"},"credentials":{"type":"object","additionalProperties":{},"description":"A JSON map containing the credentials information.","example":{"username":"User1","password":"secretPass"}},"type":{"type":"string","readOnly":true}},"required":["credentials","name"]},"MessagingServiceOperation":{"type":"object","properties":{"createdTime":{"type":"string","description":"The time the entity was created","example":"2021-12-31T20:30:57.920Z","readOnly":true},"updatedTime":{"type":"string","description":"The time the entity was last updated","example":"2021-12-31T20:30:57.920Z","readOnly":true},"createdBy":{"type":"string","description":"The user who created the entity","example":12345678,"readOnly":true},"changedBy":{"type":"string","description":"The user who last updated the entity","example":12345678,"readOnly":true},"id":{"type":"string","description":"Primary key set by the server.","example":"kljhwe32","readOnly":true},"scanTypes":{"type":"array","items":{"type":"string","description":"The list of scanTypes to be scanned.","enum":["KAFKA_ALL","CONFLUENT_SCHEMA_REGISTRY_SCHEMA","SOLACE_ALL"],"example":["KAFKA_ALL","CONFLUENT_SCHEMA_REGISTRY_SCHEMA"]},"minItems":1},"destinations":{"type":"array","items":{"type":"string","description":"The list of destinations for EMA to send results to.","enum":["EVENT_PORTAL","FILE_WRITER"],"example":["EVENT_PORTAL","FILE_WRITER"]}},"type":{"type":"string","readOnly":true}},"required":["scanTypes"]},"MessagingServiceOperationResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/MessagingServiceOperation"},"meta":{"type":"object","additionalProperties":{}}}},"MessagingServiceRemoveAssociation":{"type":"object","properties":{"association":{"type":"string","description":"The target association to be removed from the messaging service.","enum":["RUNTIME_AGENT","EVENT_MESH","EVENT_MANAGEMENT_AGENT"],"example":"EVENT_MANAGEMENT_AGENT"}}},"MessagingServiceResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/MessagingService"},"meta":{"type":"object","additionalProperties":{}}}},"MessagingServiceScan":{"type":"object","properties":{"createdTime":{"type":"string","description":"The time the entity was created","example":"2021-12-31T20:30:57.920Z","readOnly":true},"updatedTime":{"type":"string","description":"The time the entity was last updated","example":"2021-12-31T20:30:57.920Z","readOnly":true},"createdBy":{"type":"string","description":"The user who created the entity","example":12345678,"readOnly":true},"changedBy":{"type":"string","description":"The user who last updated the entity","example":12345678,"readOnly":true},"id":{"type":"string","description":"Primary key set by the server.","example":12345,"readOnly":true},"status":{"type":"string","description":"The status of the messaging service scan.","example":"FAILED","readOnly":true},"statusDescription":{"type":"string","description":"The description of the messaging service scan status.","example":"Scan failed because some scanTypes failed to complete.","readOnly":true},"messagingServiceId":{"type":"string","description":"The messagingServiceId of the scan.","example":"67890x23vh","readOnly":true},"messagingServiceName":{"type":"string","description":"The messagingServiceName of the scan.","example":"first solace messagingService","readOnly":true},"scanTypes":{"type":"string","description":"The scanTypes that were requested for the scan.","example":"KAFKA_ALL","readOnly":true},"destinations":{"type":"string","description":"The destinations which EMA will send the scan results.","example":"EVENT_PORTAL,FILE_WRITER","readOnly":true},"isUsedByAudit":{"type":"boolean","description":"Whether the scan is used by audit.","example":false,"readOnly":true},"type":{"type":"string","readOnly":true}}},"MessagingServiceScanData":{"type":"object","properties":{"createdTime":{"type":"string","description":"The time the entity was created","example":"2021-12-31T20:30:57.920Z","readOnly":true},"id":{"type":"string","description":"Primary key set by the server.","example":12345,"readOnly":true},"scanId":{"type":"string","description":"The ID of the scan.","example":"67890x23vh","readOnly":true},"dataCollectionType":{"type":"string","description":"The type of dataCollection this object holds scan data for.","enum":["brokerConfiguration","clusterConfiguration","consumerGroups","consumerGroupConfiguration","overrideTopicConfiguration","queueConfiguration","queueListing","schema","subscriptionConfiguration","topicConfiguration","topicListing"],"example":"consumerGroups","readOnly":true},"data":{"type":"string","description":"The scan data in JSON format.","example":{"name":"some solace queue name"},"readOnly":true},"type":{"type":"string","readOnly":true}}},"MessagingServiceScanDataListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MessagingServiceScanData"}},"meta":{"$ref":"#/components/schemas/meta"}}},"MessagingServiceScanDataResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/MessagingServiceScanData"},"meta":{"type":"object","additionalProperties":{}}}},"MessagingServiceScanLog":{"type":"object","properties":{"createdTime":{"type":"string","description":"The time the entity was created","example":"2021-12-31T20:30:57.920Z","readOnly":true},"id":{"type":"string","description":"Primary key set by the server.","example":12345,"readOnly":true},"scanId":{"type":"string","description":"The ID of the scan.","example":"67890x23vh","readOnly":true},"log":{"type":"string","description":"The log message.","example":"The Scan Is Done.","readOnly":true},"logLevel":{"type":"string","description":"The level of the log message.","example":"INFO","readOnly":true},"type":{"type":"string","readOnly":true}}},"MessagingServiceScanLogListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MessagingServiceScanLog"}},"meta":{"$ref":"#/components/schemas/meta"}}},"MessagingServiceScanResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/MessagingServiceScan"},"meta":{"type":"object","additionalProperties":{}}}},"MessagingServiceScansResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MessagingServiceScan"}},"meta":{"$ref":"#/components/schemas/meta"}}},"MessagingServicesResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MessagingService"}},"meta":{"$ref":"#/components/schemas/meta"}}},"ModeledEventBrokerInfoDTO":{"type":"object","properties":{"createdTime":{"type":"string","description":"The time the entity was created","example":"2021-12-31T20:30:57.920Z","readOnly":true},"updatedTime":{"type":"string","description":"The time the entity was last updated","example":"2021-12-31T20:30:57.920Z","readOnly":true},"createdBy":{"type":"string","description":"The user who created the entity","example":12345678,"readOnly":true},"changedBy":{"type":"string","description":"The user who last updated the entity","example":12345678,"readOnly":true},"name":{"type":"string","description":"The name of the modeled event broker.","example":"first broker"},"eventMeshId":{"type":"string","description":"The unique identifier of the modeled event mesh that contains the modeled event broker.","example":"67890x23vh"},"id":{"type":"string","description":"The unique identifier of the modeled event broker.","example":"asdkl234x","readOnly":true},"allowedActions":{"type":"array","description":"The types of modeled event broker information a user is permitted to retrieve. A user with 'get_info' action can use the 'about/modeledEventBrokers' API. Users with any other action can use the standard '/messagingServices' API.","example":"[get, get_info]","items":{"type":"string"},"readOnly":true,"uniqueItems":true},"type":{"type":"string","enum":["modeledEventBrokerInfo"],"readOnly":true}}},"ModeledEventBrokerInfoResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ModeledEventBrokerInfoDTO"}},"meta":{"$ref":"#/components/schemas/meta"}}},"Pagination":{"type":"object","properties":{"pageNumber":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"nextPage":{"type":"integer","format":"int32"},"totalPages":{"type":"integer","format":"int32"}}},"PreviewEntityConfigurationDTO":{"type":"object","properties":{"type":{"type":"string","description":"Type of the runtime entity","enum":["solaceQueue","solaceAcl","solaceRestDeliveryPoint","solaceRestDeliveryPointQueueBinding","solaceAuthorizationGroup","solaceAccess","solaceClientUsername","solaceClientCertificateUsername"]},"identifier":{"type":"string","description":"Identifier of the runtime entity"},"value":{"type":"object","additionalProperties":{},"description":"Configuration values for the runtime entity"},"errors":{"type":"array","description":"Errors related to the runtime entity that will prevent deployment","items":{"$ref":"#/components/schemas/DeploymentPreviewError"}}}},"ResponseEventPortalUsageStats":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EventPortalUsageStats"},"meta":{"type":"object","additionalProperties":{}}}},"Subscription":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"subscriptionType":{"type":"string","example":"topic"},"value":{"type":"string","example":"solace/cloud"},"attractedEventVersionIds":{"type":"array","items":{"$ref":"#/components/schemas/AttractedEventVersionTuple"},"readOnly":true}}},"ValidationMessageContext":{"type":"object","properties":{"entityNames":{"type":"array","items":{"type":"string"}},"ids":{"type":"array","items":{"type":"string"},"uniqueItems":true},"entityType":{"type":"string"}}},"ValidationMessageDTO":{"type":"object","properties":{"messageKey":{"type":"string"},"message":{"type":"string"},"context":{"$ref":"#/components/schemas/ValidationMessageContext"}}},"ValidationMessagesDTO":{"type":"object","properties":{"warnings":{"type":"array","items":{"$ref":"#/components/schemas/ValidationMessageDTO"}},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ValidationMessageDTO"}}}},"meta":{"type":"object","properties":{"pagination":{"$ref":"#/components/schemas/Pagination"}}}},"securitySchemes":{"APIToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}}},"x-readme":{"explorer-enabled":true,"proxy-enabled":true}}