edit-icon download-icon

Update application configurations

Last Updated: Jan 09, 2018


Update the application configurations.

Request information

Request line (RequestLine)

  1. POST /projects/{name}/update HTTP/1.1

Request line parameter (URI Param)

Name Type Required? Description
name string Yes Application name

Special request header (RequestHead)

  1. Content-Type: application/json

Request body (RequestBody)

JSON object

  1. {
  2. "description": "string",
  3. "template": "string",
  4. "version": "string",
  5. "latest_image": true,
  6. "environment": {
  7. "key": "value",
  8. ...
  9. }
  10. }

Request body explanation

Name Type Required? Description
description stringNoThe updated application description.
templatestringYesThe updated Compose yaml template, which must be escaped in the JSON format.
version stringNoThe updated application version. The updated version must be different from the original version. Otherwise, HTTP code 409 is returned.
latest_image boolNoWhether or not to pull the latest image.
environmentmapEnvironment variablekey/value used to replace the environment variable in the Compose template.

Response information

Response line (ResponseLine)

  1. HTTP/1.1 202 Accepted

Special response header (ResponseHead)


Response body (ResponseBody)



Request example

  1. POST /projects/test/update HTTP/1.1
  2. Content-Type: application/json
  3. {
  4. "description": "This is a test application",
  5. "template": "web:\r\n image: nginx",
  6. "version": "2.0",
  7. "latest_image": true,
  8. "environment": {
  9. "USER": "abc",
  10. "PWD": "newpwd"
  11. }
  12. }

Return example

  1. HTTP/1.1 202 Accepted
Thank you! We've received your feedback.