Deployment API - Deploy Package

Supported Versions

Below are the versions of the API that support this endpoint.

Overview

This endpoint executes a deployment on an Appian environment. You can specify the name and description of the deployment, as well as upload Admin Console settings, a deployment package, import customization file, plug-in file, and/or database scripts.

A deployment package is a single ZIP file that contains objects from one or many packages or applications.

• HTTP Request Method: POST
• Header: Action-Type: import
• Endpoint: /deployments

Request

When performing a POST request, you must define a request body using the multipart/form-data content type. Form data allows you to send key-value pairs and upload files, such as your deployment package.

Each POST request’s body must include a JSON object (application/json content type) and form parameters (uploaded files). The JSON object is a list of key-value pairs, as listed below.

Version 3

JSON object parameters

¹At least one of the following parameters must be provided to successfully deploy:

• adminConsoleFileName
• packageFileName
• customizationFileName
• pluginsFileName
• databaseScriptsFileName

Any combination of these files can be deployed together but at least one must be present for the deployment to be successful.

Request example

In addition to the JSON object below, the request should have the referenced files attached.

Request

1
POST /deployments

JSON object example

1
2
3
4
5
6
7
8
9
{
   "name": "Fraud Investigation Management Release 1.0",
   "description": "Base functionality to input and manage fraud cases",
   "adminConsoleSettingsFileName": "ACME Brand Standards.zip",
   "packageFileName": "Fraud Investigation Management.zip",
   "customizationFileName": "Fraud Investigation Management.properties",
   "pluginsFileName": "DEV Fraud Investigation Management Plug-ins.zip",
   "databaseScriptsFileName": "DEV Fraud Investigation Management DB Scripts.zip"
}

cURL example

If you’re calling the API from a command line interface, you can use cURL to make a request. The cURL command with the above JSON object and its corresponding files looks like:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
curl --location --request \
POST 'https://mysite.appiancloud.com/suite/deployment-management/v3/deployments' \
--header 'Authorization: Bearer <access_token>' \
--header 'Action-Type: import' \
--form json='{
      "name": "Fraud Investigation Management Release 1.0",
      "description": "Base functionality to input and manage fraud cases", 
      "packageFileName": "Fraud Investigation Management.zip",
      "customizationFileName": "Fraud Investigation Management.properties",
      "adminConsoleSettingsFileName": "ACME Brand Standards.zip",
      "pluginsFileName": "DEV Fraud Investigation Management Plug-ins.zip",
      "databaseScriptsFileName":  "DEV Fraud Investigation Management DB Scripts.zip"
   }' \
--form packageFileName=@'/tmp/Fraud Investigation Management.zip' \
--form customizationFileName=@'Fraud Investigation Management.properties' \
--form adminConsoleSettingsFileName=@'ACME Brand Standards.zip' \
--form pluginsFileName=@'DEV Fraud Investigation Management Plug-ins.zip' \
--form databaseScriptsFileName=@'DEV Fraud Investigation Management DB Scripts.zip'

Each form parameter requires a key name. Key names do not need to match anything in the JSON object.

Response

Successful response

Response example

1
2
3
4
5
{
   "uuid": "d243b14c-3ba5-41c3-9f51-76da51beb8f5",
   "url": "https://mysite.appiancloud.com/suite/deployment-management/v3/deployments/d243b14c-3ba5-41c3-9f51-76da51beb8f5/",
   "status": "IN_PROGRESS"
}

Version 1 and 2

JSON object parameters

¹ A adminConsoleSettingsFileName, packageFileName, customizationFileName, pluginsFileName, or dataSource with accompanying databaseScripts must be provided in order to create a valid deployment. Any combination of these can be deployed together but at least one must be present for the deployment to be successful.

Request example

In addition to the JSON object below, the request should have the referenced files attached.

Request

1
POST /deployments

JSON object example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{
   "name": "Fraud Investigation Management Release 1.0",
   "description": "Base functionality to input and manage fraud cases",
   "adminConsoleSettingsFileName": "ACME Brand Standards.zip",
   "packageFileName": "Fraud Investigation Management.zip",
   "customizationFileName": "Fraud Investigation Management.properties",
   "pluginsFileName": "DEV Fraud Investigation Management Plug-ins.zip",
   "dataSource": "jdbc/AppianAnywhere",
   "databaseScripts": [
      {
         "fileName": "Create Tables.sql", "orderId": "1"
      },
      {
         "fileName": "Update Reference Data.sql", "orderId": "2"
      }
   ]
}

cURL example

If you’re calling the API from a command line interface, you can use cURL to make a request. The cURL command with the above JSON object and its corresponding files looks like:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
curl --location --request \
POST 'https://mysite.appiancloud.com/suite/deployment-management/v2/deployments' \
--header 'Authorization: Bearer <access_token>' \
--header 'Action-Type: import' \
--form json='{
      "name": "Fraud Investigation Management Release 1.0",
      "description": "Base functionality to input and manage fraud cases", 
      "packageFileName": "Fraud Investigation Management.zip",
      "customizationFileName": "Fraud Investigation Management.properties",
      "adminConsoleSettingsFileName": "ACME Brand Standards.zip",
      "pluginsFileName": "DEV Fraud Investigation Management Plug-ins.zip",
      "dataSource": "jdbc/AppianAnywhere",
      "databaseScripts": [
         {
            "fileName": "Create Tables.sql", "orderId": "1"
         },
         {
            "fileName": "Update Reference Data.sql", "orderId": "2"
         }
      ]
   }' \
--form packageFileName=@'/tmp/Fraud Investigation Management.zip' \
--form customizationFileName=@'Fraud Investigation Management.properties' \
--form adminConsoleSettingsFileName=@'ACME Brand Standards.zip' \
--form pluginsFileName=@'DEV Fraud Investigation Management Plug-ins.zip' \
--form databaseScript1=@'Create Tables.sql' \
--form databaseScript2=@'Update Reference Data.sql'

Each form parameter requires a key name. Key names do not need to match anything in the JSON object.

Response

Successful response

Response example

1
2
3
4
5
{
   "uuid": "d243b14c-3ba5-41c3-9f51-76da51beb8f5",
   "url": "https://mysite.appiancloud.com/suite/deployment-management/v2/deployments/d243b14c-3ba5-41c3-9f51-76da51beb8f5/",
   "status": "IN_PROGRESS"
}

Feedback