Home
Version 3
Apps (Experimental) API

Apps (Experimental) API

List associated droplets

GET /v3/apps/:guid/droplets

Request

Route

GET /v3/apps/guid-7098082f-0843-4a44-a224-da72d8626349/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
  • EXPIRED
  • 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.eyJ1c2VyX2lkIjoidWFhLWlkLTQwNSIsImVtYWlsIjoiZW1haWwtMjc3QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTQ0NTE2MzN9.AfjppjZIQ2lpwgbof1RmteeOjf8es2UHV6bHSzmJVoI
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v3/apps/guid-7098082f-0843-4a44-a224-da72d8626349/droplets?page=1&per_page=2&order_by=-created_at" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQwNSIsImVtYWlsIjoiZW1haWwtMjc3QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTQ0NTE2MzN9.AfjppjZIQ2lpwgbof1RmteeOjf8es2UHV6bHSzmJVoI" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "pagination": {
    "total_results": 2,
    "first": {
      "href": "/v3/apps/guid-7098082f-0843-4a44-a224-da72d8626349/droplets?order_by=-created_at&page=1&per_page=2"
    },
    "last": {
      "href": "/v3/apps/guid-7098082f-0843-4a44-a224-da72d8626349/droplets?order_by=-created_at&page=1&per_page=2"
    },
    "next": null,
    "previous": null
  },
  "resources": [
    {
      "guid": "guid-03f27a7a-9121-4dd4-833b-4a36eabfc801",
      "state": "STAGED",
      "error": null,
      "lifecycle": {
        "type": "buildpack",
        "data": {
          "buildpack": "name-2303",
          "stack": "name-2304"
        }
      },
      "memory_limit": null,
      "disk_limit": null,
      "result": {
        "execution_metadata": null,
        "process_types": "{\"web\":\"started\"}",
        "hash": {
          "type": "sha1",
          "value": "my-hash"
        },
        "buildpack": "https://github.com/cloudfoundry/my-buildpack.git",
        "stack": null
      },
      "environment_variables": {

      },
      "created_at": "1970-01-01T00:00:02Z",
      "updated_at": "2016-01-26T22:20:33Z",
      "links": {
        "self": {
          "href": "/v3/droplets/guid-03f27a7a-9121-4dd4-833b-4a36eabfc801"
        },
        "package": {
          "href": "/v3/packages/guid-a4c16d72-13e7-4578-a2be-1684b4c484d9"
        },
        "app": {
          "href": "/v3/apps/guid-7098082f-0843-4a44-a224-da72d8626349"
        },
        "assign_current_droplet": {
          "href": "/v3/apps/guid-7098082f-0843-4a44-a224-da72d8626349/current_droplet",
          "method": "PUT"
        }
      }
    },
    {
      "guid": "guid-87d3fe05-1d32-4063-99c5-cdfbf2f66eae",
      "state": "STAGING",
      "error": null,
      "lifecycle": {
        "type": "buildpack",
        "data": {
          "buildpack": "name-2301",
          "stack": "name-2302"
        }
      },
      "memory_limit": null,
      "disk_limit": null,
      "result": null,
      "environment_variables": {
        "yuu": "huuu"
      },
      "created_at": "1970-01-01T00:00:01Z",
      "updated_at": "2016-01-26T22:20:33Z",
      "links": {
        "self": {
          "href": "/v3/droplets/guid-87d3fe05-1d32-4063-99c5-cdfbf2f66eae"
        },
        "package": {
          "href": "/v3/packages/guid-a4c16d72-13e7-4578-a2be-1684b4c484d9"
        },
        "app": {
          "href": "/v3/apps/guid-7098082f-0843-4a44-a224-da72d8626349"
        },
        "assign_current_droplet": {
          "href": "/v3/apps/guid-7098082f-0843-4a44-a224-da72d8626349/current_droplet",
          "method": "PUT"
        },
        "buildpack": {
          "href": "/v2/buildpacks/11f0ea63-2116-42ea-93e8-275ab6d912b6"
        }
      }
    }
  ]
}

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
X-Runtime: 0.059490
Content-Length: 2728