Appian · Schema

DeploymentRequest

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.

AutomationBPMBusiness Process ManagementEnterprise SoftwareLow-CodeProcess AutomationRPAWorkflows

Properties

Name Type Description
json string JSON string containing the deployment configuration. For exports, includes exportType and uuids. For imports, includes name, description, and file name references.
packageFileName string The deployment package ZIP file to import. Required for import operations.
adminConsoleSettingsFileName string Admin Console settings ZIP file to import alongside the package.
customizationFileName string Import customization properties file that maps source environment values to target environment values.
pluginsFileName string Plug-ins ZIP file containing plug-ins to deploy.
View JSON Schema on GitHub

JSON Schema

deployment-rest-deployment-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/appian/refs/heads/main/json-schema/deployment-rest-deployment-request-schema.json",
  "title": "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": {
      "type": "string",
      "description": "JSON string containing the deployment configuration. For exports, includes exportType and uuids. For imports, includes name, description, and file name references."
    },
    "packageFileName": {
      "type": "string",
      "format": "binary",
      "description": "The deployment package ZIP file to import. Required for import operations."
    },
    "adminConsoleSettingsFileName": {
      "type": "string",
      "format": "binary",
      "description": "Admin Console settings ZIP file to import alongside the package."
    },
    "customizationFileName": {
      "type": "string",
      "format": "binary",
      "description": "Import customization properties file that maps source environment values to target environment values."
    },
    "pluginsFileName": {
      "type": "string",
      "format": "binary",
      "description": "Plug-ins ZIP file containing plug-ins to deploy."
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/deployment-rest-deployment-request"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.