View an application

Last Updated: Jan 09, 2018

Description

View the application details according to the application name.

Request information

Request line (RequestLine)

  1. GET /projects/{name} HTTP/1.1

Request line parameter (URI Param)

Name Type Required? Description
name string Yes Application name

Special request header (RequestHead)

None

Request body (RequestBody)

None

Response information

Response line (ResponseLine)

  1. HTTP/1.1 200 OK

Special response header (ResponseHead)

None

Response body (ResponseBody)

  1. {
  2. "name": "string",
  3. "description": "string",
  4. "template": "string",
  5. "version": "string",
  6. "created": "datetime",
  7. "updated": "datetime",
  8. "desired_state": "string",
  9. "current_state": "string",
  10. "environment": {
  11. "key": "value",
  12. ...
  13. }
  14. "services": [
  15. ...
  16. ]
  17. }

Response body explanation

Application format

Name Type Description
namestring The application name.
descriptionstring The application description.
templatestringThe application Compose template.
version string The application version.
createddatetimeThe created time of the application.
updated datetime The updated time of the application.
desired_statestringThe expected status (if the current status is the intermediate status, the expected status indicates the final status of the change).
current_state stringThe current status.
environment mapThe environment variable key/value.
servicesarrayThe service list.

Example

Request example

  1. GET /projects/test HTTP/1.1

Return example

  1. HTTP/1.1 200 Ok
  2. Content-Type:application/json;charset=UTF-8
  3. {
  4. "name": "test",
  5. "description": "This is a test application",
  6. "template": "...",
  7. "version": "1.0",
  8. "environment": {
  9. "COMPOSE_PROJECT_NAME": "test"
  10. },
  11. "created": "2016-02-02T07:45:13.113833319Z",
  12. "updated": "2016-02-02T07:45:16.03142154Z",
  13. "desired_state": "running",
  14. "current_state": "running",
  15. "services": [
  16. ...
  17. ]
  18. }
Thank you! We've received your feedback.