Home
Version 3
Apps (Experimental) API

Apps (Experimental) API

List associated droplets

GET /v3/apps/:guid/droplets

Request

Route

GET /v3/apps/guid-045bed92-e03a-4a3c-965d-b21753f98e0d/droplets?page=1&per_page=2&order_by=-created_at

Parameters

Name Description Valid Values Example Values
states Droplet state to filter by
  • PENDING
  • STAGING
  • STAGED
  • FAILED
  • states=PENDING,STAGING
page Page to display
  • >= 1
per_page Number of results per page
  • 1-5000
order_by Value to sort by. Prepend with "+" or "-" to change sort direction to ascending or descending, respectively.
  • created_at
  • updated_at
page: 1
per_page: 2
order_by: -created_at

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTk0IiwiZW1haWwiOiJlbWFpbC02MkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIucmVhZCIsImNsb3VkX2NvbnRyb2xsZXIud3JpdGUiXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDQ0NzgyOTI0fQ.9LGEUJnPN42qgOTQOF2pszDpjJa5-GNXo5-QppDtJK4
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v3/apps/guid-045bed92-e03a-4a3c-965d-b21753f98e0d/droplets?page=1&per_page=2&order_by=-created_at" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTk0IiwiZW1haWwiOiJlbWFpbC02MkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIucmVhZCIsImNsb3VkX2NvbnRyb2xsZXIud3JpdGUiXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDQ0NzgyOTI0fQ.9LGEUJnPN42qgOTQOF2pszDpjJa5-GNXo5-QppDtJK4" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "pagination": {
    "total_results": 2,
    "first": {
      "href": "/v3/apps/guid-045bed92-e03a-4a3c-965d-b21753f98e0d/droplets?order_by=-created_at&page=1&per_page=2"
    },
    "last": {
      "href": "/v3/apps/guid-045bed92-e03a-4a3c-965d-b21753f98e0d/droplets?order_by=-created_at&page=1&per_page=2"
    },
    "next": null,
    "previous": null
  },
  "resources": [
    {
      "guid": "guid-bcd9d202-f217-4dd1-9137-970d75386b00",
      "state": "STAGED",
      "hash": {
        "type": "sha1",
        "value": "my-hash"
      },
      "buildpack": "https://github.com/cloudfoundry/my-buildpack.git",
      "error": null,
      "procfile": null,
      "environment_variables": {

      },
      "created_at": "1970-01-01T00:00:02Z",
      "updated_at": null,
      "links": {
        "self": {
          "href": "/v3/droplets/guid-bcd9d202-f217-4dd1-9137-970d75386b00"
        },
        "package": {
          "href": "/v3/packages/guid-00cfdaa4-7e5c-4747-9e12-afb605d64e2c"
        },
        "app": {
          "href": "/v3/apps/guid-045bed92-e03a-4a3c-965d-b21753f98e0d"
        },
        "assign_current_droplet": {
          "href": "/v3/apps/guid-045bed92-e03a-4a3c-965d-b21753f98e0d/current_droplet",
          "method": "PUT"
        }
      }
    },
    {
      "guid": "guid-28429e71-5206-487f-9952-785271936692",
      "state": "STAGING",
      "hash": {
        "type": "sha1",
        "value": null
      },
      "buildpack": "name-287",
      "error": null,
      "procfile": null,
      "environment_variables": {
        "yuu": "huuu"
      },
      "created_at": "1970-01-01T00:00:01Z",
      "updated_at": null,
      "links": {
        "self": {
          "href": "/v3/droplets/guid-28429e71-5206-487f-9952-785271936692"
        },
        "package": {
          "href": "/v3/packages/guid-00cfdaa4-7e5c-4747-9e12-afb605d64e2c"
        },
        "app": {
          "href": "/v3/apps/guid-045bed92-e03a-4a3c-965d-b21753f98e0d"
        },
        "assign_current_droplet": {
          "href": "/v3/apps/guid-045bed92-e03a-4a3c-965d-b21753f98e0d/current_droplet",
          "method": "PUT"
        },
        "buildpack": {
          "href": "/v2/buildpacks/2a0f9d04-1ba6-4d73-b786-316f4302ea82"
        }
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: f345d61a-73f6-49ef-9d51-242a36065707
Content-Length: 2259
X-Content-Type-Options: nosniff