Deployment API - Deploy Package

Overview

This endpoint executes a deployment on an Appian environment. You can specify the name and description of the deployment, as well as upload a deployment package, import customization file, and database scripts.

• HTTP Request Method: POST
• 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.

JSON object parameters

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
{
   "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",
   "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
curl --location --request
POST 'https://mysite.appiancloud.com/suite/deployment-management/v1/deployments' \
--header 'Appian-API-Key: <API key>' \
--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\",
      \"dataSource\": \"jdbc/AppianAnywhere\",
      \"databaseScripts\": [
         {
            \"fileName\": \"Create Tables.sql\", \"orderId\": \"1\"
         },
         {
            \"fileName\": \"Update Reference Data.sql\", \"orderId\": \"2\"
         }
      ]
   }"' \
--form 'randomKey1=@"Fraud Investigation Management Release 1.0.zip"' \
--form 'randomKey2=@"Fraud Investigation Management Release 1.0.properties"' \
--form 'randomKey3=@"Create Tables.sql"' \
--form 'randomKey4=@"Update Reference Data.sql"'

Each form parameter requires a key name, as indicated by randomKey1, but these can be arbitrarily named and 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/v1/deployments/d243b14c-3ba5-41c3-9f51-76da51beb8f5/",
   "status": "IN_PROGRESS"
}

Feedback