---
updatedAt: 2026-07-28T13:53:00.000Z
---
# (EA) Create a preview of the application deployment
Create a preview of the resulting changes in an application's event broker resources for the specified deployment action.
The preview is provided in the data/requested section of the response.
Your token must have one of the permissions listed in the Token Permissions.
Token Permissions: [ `application_deployment_preview:create:*` **and** `application:get:*` ]
# OpenAPI definition
```json
{
"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 Deployments"
}
],
"paths": {
"/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
Token Permissions: [ `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"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"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": {}
}
}
},
"DeploymentPreviewError": {
"type": "object",
"properties": {
"conflictType": {
"type": "string",
"enum": [
"clientUsername",
"authorizationGroupName",
"queueName",
"aclProfileName"
]
},
"configurationTypeId": {
"type": "string"
},
"type": {
"type": "string"
},
"subType": {
"type": "string"
}
}
},
"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
}
}
},
"PreviewEntityConfigurationDTO": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Type of the runtime entity",
"enum": [
"solaceQueue",
"solaceAcl",
"solaceRestDeliveryPoint",
"solaceRestDeliveryPointQueueBinding",
"solaceAuthorizationGroup",
"solaceAccess",
"solaceMicroIntegrationFlow",
"solaceTransformations",
"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"
}
}
}
}
},
"securitySchemes": {
"APIToken": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT"
}
}
},
"x-readme": {
"explorer-enabled": true,
"proxy-enabled": true
}
}
```