Appian · JSON Structure

Deployment Rest Deployment Request Structure

Request body for creating a deployment operation. For exports, provide the JSON configuration with export type and UUIDs. For imports, provide package files along with the JSON configuration.

Type: object Properties: 5
AutomationBPMBusiness Process ManagementEnterprise SoftwareLow-CodeProcess AutomationRPAWorkflow

DeploymentRequest is a JSON Structure definition published by Appian, describing 5 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

json packageFileName adminConsoleSettingsFileName customizationFileName pluginsFileName

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/appian/refs/heads/main/json-structure/deployment-rest-deployment-request-structure.json",
  "name": "DeploymentRequest",
  "description": "Request body for creating a deployment operation. For exports, provide the JSON configuration with export type and UUIDs. For imports, provide package files along with the JSON configuration.",
  "type": "object",
  "properties": {
    "json": {
      "description": "JSON string containing the deployment configuration. For exports, includes exportType and uuids. For imports, includes name, description, and file name references.",
      "type": "string"
    },
    "packageFileName": {
      "description": "The deployment package ZIP file to import. Required for import operations.",
      "type": "string"
    },
    "adminConsoleSettingsFileName": {
      "description": "Admin Console settings ZIP file to import alongside the package.",
      "type": "string"
    },
    "customizationFileName": {
      "description": "Import customization properties file that maps source environment values to target environment values.",
      "type": "string"
    },
    "pluginsFileName": {
      "description": "Plug-ins ZIP file containing plug-ins to deploy.",
      "type": "string"
    }
  }
}