Deployment API - Get Deployment Results

Overview

This endpoint retrieves information about a deployment on an Appian environment, given the UUID of the deployment.

  • HTTP Request Method: GET
  • Endpoint: /deployments/<uuid>

Request

When performing a GET request, you don’t need a request body. However, you do need to specify the UUID of the deployment you’re querying for. This is done by adding a path parameter to the end of the URL, such as: https://<domain>/suite/deployment-management/v1/deployments/<UUID>

Request example

Request

1
GET /deployments/<uuid>

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 deployment UUID looks like:

1
2
3
curl --location --request
GET 'https://mysite.appiancloud.com/suite/deployment-management/v1/deployments/d243b14c-3ba5-41c3-9f51-76da51beb8f5/' \
--header 'Appian-API-Key: <API key>'

Response

Successful response

Attribute Value
summary Overview of the number of database scripts and objects that were deployed.
summary.databaseScripts The total number of database scripts included in the original deployment request.
summary.objects Overview of deployment results for the objects included in the original deployment request, as part of the package (.zip).
summary.objects.total The total number of objects in the package.
summary.objects.imported The number of objects in the package that successfully imported.
summary.objects.failed The number of objects in the package that were skipped, because there were no changes.
summary.objects.skipped Overview of the number of database scripts and objects that were deployed.
deploymentLogUrl The URL to use to retrieve the deployment log of this deployment.
status Status of the deployment. These correspond to the statuses that appear on the deployments view in Appian Designer.

Possible statuses: IN_PROGRESS, COMPLETED, COMPLETED_WITH_ERRORS, FAILED, PENDING_REVIEW, or REJECTED.

Response example

1
2
3
4
5
6
7
8
9
10
11
12
13
{
    "summary": {
        "databaseScripts": 0,
        "objects": {
            "total": 22,
            "imported": 22,
            "failed": 0,
            "skipped": 0
        },
        "deploymentLogUrl": "https://mysite.appiancloud.com/suite/deployment-management/v1/deployments/d243b14c-3ba5-41c3-9f51-76da51beb8f5/log/"
    },
    "status": "COMPLETED"
}
Open in Github Built: Fri, Jun 24, 2022 (02:10:55 PM)

On This Page

FEEDBACK