You can view update profiles and update profile types of a deployed application. You can also use the APIs to create and delete update profiles, override update profile property values, schedule scale-in and scale-out update process, view the last failed update process, and rollback an update process.

Retrieves a paginated list of update profiles for a deployment.

All of the vCloud Application Director predefined user accounts and associated roles can access this API.

GET

https://ApplicationDirectorServerIP:8443/darwin/api/2.0/update-profile?deployment-id=DeploymentID&page=Page&page-size=PageSize

You must type the URI syntax because the copy and paste operation removes formatting from the text.

Example URI syntax:

https://ApplicationDirectorServerIP:8443/darwin/api/2.0/update-profile?deployment-id=19&page=0&page-size=10
{
  "errors": false,  
  "messageList": [],
  "count": 2,
  "results": [
   {
     "updateProfileRefs": [
        {
          "updateProfileRef": {
            "id": "19",
            "name": "increase8",
            "uri": "/darwin/api/2.0/update-profile/19"
          },
          "updateType": "SCALE_OUT"
        },
        {
          "updateProfileRef": {
            "id": "21",
            "name": "scalein1",
            "uri": "/darwin/api/2.0/update-profile/21"
          },
          "updateType": "SCALE_IN"
        }
      ]
    }
  ]
}

Retrieves a paginated list of update profiles for a deployment and update type.

All of the vCloud Application Director predefined user accounts and associated roles can access this API.

GET

https://ApplicationDirectorServerIP:8443/darwin/api/2.0/update-profile?deployment-id=DeploymentID&update-type=UpdateType&page=Page&page-size=PageSize

You must type the URI syntax because the copy and paste operation removes formatting from the text.

Example URI syntax:

https://ApplicationDirectorServerIP:8443/darwin/api/2.0/update-profile?deployment-id=19&update-type=SCALE_OUT&page=0&page-size=10
{
  "errors": false,
  "messageList": [],
  "count":1,
  "results": [
    {
      "updateProfileRefs": [
        {
          "updateProfileRef": {
            "id": "19",
            "name": "increase8",
            "uri": "/darwin/api/2.0/update-profile/19"
          },
          "update-type": "SCALE_OUT"
        }
      ]
    }
  ]
}

Retrieves an update profile for a deployment based on the provided update profile identification.

All of the vCloud Application Director predefined user accounts and associated roles can access this API.

GET

https://ApplicationDirectorServerIP:8443/darwin/api/2.0/update-profile/UpdateProfileID

You must type the URI syntax because the copy and paste operation removes formatting from the text.

Example URI syntax:

https://ApplicationDirectorServerIP:8443/darwin/api/2.0/update-profile/2
{
  "errors": false,
  "messageList": [],
  "result": {
    "id": "19",
    "lockVersion": 1,
    "name": "increase8",
    "description": "increase8 Description",
    "created": "2013-08-01T17:22:34+05:30",
    "lastUpdated": "2013-08-01T17:22:34+05:30",
    "lastUpdateUser": "admin",
    "createUser": "admin",
    "deploymentRef": {
      "id": "8",
      "name": "appd-Linux Smoke 01-1.0.0-admin-8-3ab14c68-5ac1-4357-b403-c04603c12b14",
      "uri": "/darwin/api/2.0/deployment/8"
     },
     "updateType": "SCALE_OUT",
     "configUpdateProperties":null,
     "scaleoutPropertiesInfo": {
       "clusterNode": [
         {
           "name": "Clustered_Producer",
           "currentClusterSize": 3,
           "nodeInstanceNames": [
             "SpringTravel_0_",
             "SpringTravel_1_",
             "SpringTravel_2_"
           ]
         }
       ]
     }     
   }
}

Creates an update profile based on the name provided in the request section and schedules its execution. If an update profile name is not provided, the designated name appears in the response section with the associated identification. If the update profile name already exists, an error message appears.

The user account with the ROLE_DEPLOYER deployer role can access this API.

POST

https://ApplicationDirectorServerIP:8443/darwin/api/2.0/update-profile

You must type the URI syntax because the copy and paste operation removes formatting from the text.

Example URI syntax:

https://ApplicationDirectorServerIP:8443/darwin/api/2.0/update-profile
{
  "deploymentId": 2,
  "updateType": "SCALE_OUT",
  "name": "scaleOutTest",
  "description" :
 "scaleOutTest Desc",
  "scaleoutProperties":      {
     "clusterNode": [
      {
       "name": "SpringTravel",
       "scaleOutBy": 1
      }
     ]
   }
}
{
  "errors": false,
  "message-list": [
    {
      "message-type": "INFO",
      "message": "Deployment update scheduled successfully.",
      "message-key": "deployment.update.scheduled.msg"
     }
   ]
  "result": {
    "id": "1",
    "lockVersion": 0,
    "name": "scaleOutTest",
    "description" :"scaleOutTest Desc",
    "deploymentTaskRef" : {
      "uri": "/darwin/api/2.0/deployment-task/76",
      "id": "76",
      "name": "appd-Spring Travel-1.0.0-admin-14-759a3d26-0ad5-4e58-a3d2-6f34214e3637"
    }
  }
}

Overrides property values in an update profile based on the provided update profile identification and schedules its execution. The request body contains the changes to apply to the existing update profile with the given ID.

The user account with the ROLE_DEPLOYER deployer role can access this API.

POST

https://ApplicationDirectorServerIP:8443/darwin/api/2.0/update-profile/UpdateProfileID

You must type the URI syntax because the copy and paste operation removes formatting from the text.

Example URI syntax:

https://ApplicationDirectorServerIP:8443/darwin/api/2.0/update-profile/2
{
  "lockVersion": 1,
  "updateType": "SCALE_OUT",
  "scaleoutProperties":    {
    "clusterNode": [
      {
        "name": "SpringTravel",
      "scaleOutBy": 1
      }
    ]
  }
}
{
  "errors": false,
  "message-list": [
    {
      "message-type": "INFO",
      "message": "Deployment update scheduled successfully.",
      "message-key": "deployment.update.scheduled.msg"
     }
  ]
  "result": {
    "id": "1",
    "lockVersion": 0,
    "name": "scaleOutTest",
    "description" :"scaleOutTest Desc", 
    "deploymentTaskRef": {
      "uri": "/darwin/api/2.0/deployment-task/76",
      "id": "76",
      "name": "appd-Spring Travel-1.0.0-admin-14-759a3d26-0ad5-4e58-a3d2-6f34214e3637"
    }
  } 
}

Schedules an update process to scale in a deployed application based on the modified cluster size of a node in the update profile.

The user account with the ROLE_DEPLOYER deployer role can access this API.

POST

https://ApplicationDirectorServerIP:8443/darwin/api/2.0/update-profile/UpdateProfileID

You must type the URI syntax because the copy and paste operation removes formatting from the text.

Example URI syntax:

https://ApplicationDirectorServerIP:8443/darwin/api/2.0/update-profile/15
{
  "lockVersion": 1,
  "updateType": "SCALE_IN",
  "name": "ExternalScaleInTest1",
  "description": "ExternalScaleInTest1",
  "scaleinProperties": {
   "clusterNode": [
    {
     "name": SpringTravel",
    "nodeInstanceNames":       [
      "SpringTravel_4_",
      "SpringTravel_2_"
     ],
     "scaleInBy": 2
    }
   ]
  }
}
{
  "errors": false,
  "message-list": [
    {
      "message-type": "INFO",
      "message": "Deployment update scheduled successfully.",
      "message-key": "deployment.update.scheduled.msg"
    }
  ]
  "result": {
    "id": "15",
    "lockVersion": 1,
    "name": "ExternalScaleInTest1",
    "description": "ExternalScaleInTest1 description",
    "deploymentTaskRef":
      {
        "uri": "/darwin/api/2.0/deployment-task/76",
        "id": "76",
        "name": "appd-Spring Travel-1.0.0-admin-14-759a3d26-0ad5-4e58-a3d2-6f34214e3637"
      }
    }
}

Deletes an update profile based on the provided identification.

The user account with the ROLE_DEPLOYER deployer role can access this API.

DELETE

https://ApplicationDirectorServerIP:8443/darwin/api/2.0/update-profile/UpdateProfileID

You must type the URI syntax because the copy and paste operation removes formatting from the text.

Example URI syntax:

https://ApplicationDirectorServerIP:8443/darwin/api/2.0/update-profile/2
{
  "errors": false,
  "message-list": [
    {
      "message-type": "INFO",
      "message": "Successfully deleted UpdateProfile.",
      "message-key": "delete.msg"
     }
  ]
}

Retrieves the last failed update process.

The user account with the ROLE_DEPLOYER deployer role can access this API.

GET

https://ApplicationDirectorServerIP:8443/darwin/api/2.0/deployment/DeploymentID/failed-deployment-task

You must type the URI syntax because the copy and paste operation removes formatting from the text.

Example URI syntax:

https://ApplicationDirectorServerIP:8443/darwin/api/2.0/deployment/1/failed-deployment-task

If a last failed deployment task is not available, the following response appears.

{ 
  "errors": false,
  "messageList": [
    {
      "messageType": "INFO",
      "message": "No latest failed update deployment found.",
      "messageKey":
"valid.failed.updateProfile.deployment.not.found",     
    }
  ],
  "result": null
}

Performs a rollback on a failed or last successful update process based on the provided deployment identification.

The user account with the ROLE_DEPLOYER deployer role can access this API.

POST

https://ApplicationDirectorServerIP:8443/darwin/api/2.0/update-profile/

You must type the URI syntax because the copy and paste operation removes formatting from the text.

Example URI syntax:

https://ApplicationDirectorServerIP:8443/darwin/api/2.0/update-profile
{
   "deployment-id": 2,
    "operation": "ROLLBACK"
}
{
  "errors": false,
  "message-list": [
    {
      "message-type": "INFO",
      "message": "Deployment rollback scheduled successfully.",
      "message-key": "deployment.rollback.scheduled.msg"
      }
    ],
    "result": {
        "deployment-task-ref": {
            "@type": "Reference",
            "id": "8",
            "uri": "/darwin/api/2.0/deployment-task/8"
        }
    }
}