---
updatedAt: 2026-07-28T13:53:04.000Z
---
# (EA) Create a preview of an application promotion
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.
Token Permissions: [ event_designer:access ]
# 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 Promotion Requests"
}
],
"paths": {
"/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.
Token Permissions: [ event_designer:access ]",
"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"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"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": {}
}
}
},
"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"
]
},
"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
}
}
```