Home
Version 3
Apps (Experimental) API

Apps (Experimental) API

List associated droplets

GET /v3/apps/:guid/droplets

Request

Route

GET /v3/apps/guid-55706e39-3d73-4b70-a5c5-2aa940c5481d/droplets?page=1&per_page=2&order_by=created_at&order_direction=asc

Parameters

Name Description Valid Values Example Values
states Droplet state to filter by
  • PENDING
  • STAGING
  • STAGED
  • FAILED
  • states[]=PENDING&states[]=STAGING
page Page to display
  • >= 1
per_page Number of results per page
  • 1-5000
order_by Value to sort by
  • created_at
  • updated_at
order_direction Direction to sort by
  • asc
  • desc
page: 1
per_page: 2
order_by: created_at
order_direction: asc

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEzMSIsImVtYWlsIjoiZW1haWwtNzdAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLnJlYWQiLCJjbG91ZF9jb250cm9sbGVyLndyaXRlIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ0MTY2MjU5OH0.fBwU9z1D0zaycmqlx1tWbiUkTf69n0bb7GCxvWPKZ5s
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v3/apps/guid-55706e39-3d73-4b70-a5c5-2aa940c5481d/droplets?page=1&per_page=2&order_by=created_at&order_direction=asc" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEzMSIsImVtYWlsIjoiZW1haWwtNzdAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLnJlYWQiLCJjbG91ZF9jb250cm9sbGVyLndyaXRlIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ0MTY2MjU5OH0.fBwU9z1D0zaycmqlx1tWbiUkTf69n0bb7GCxvWPKZ5s" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "pagination": {
    "total_results": 2,
    "first": {
      "href": "/v3/apps/guid-55706e39-3d73-4b70-a5c5-2aa940c5481d/droplets?order_by=created_at&order_direction=asc&page=1&per_page=2"
    },
    "last": {
      "href": "/v3/apps/guid-55706e39-3d73-4b70-a5c5-2aa940c5481d/droplets?order_by=created_at&order_direction=asc&page=1&per_page=2"
    },
    "next": null,
    "previous": null
  },
  "resources": [
    {
      "guid": "guid-d7454274-ba61-4d77-b2fb-786b2c41a126",
      "state": "STAGING",
      "hash": {
        "type": "sha1",
        "value": null
      },
      "buildpack": "name-348",
      "error": null,
      "procfile": null,
      "environment_variables": {
        "yuu": "huuu"
      },
      "created_at": "1970-01-01T00:00:01Z",
      "updated_at": null,
      "_links": {
        "self": {
          "href": "/v3/droplets/guid-d7454274-ba61-4d77-b2fb-786b2c41a126"
        },
        "package": {
          "href": "/v3/packages/guid-fa165565-705a-4dc5-a0b2-12c86c2c603f"
        },
        "app": {
          "href": "/v3/apps/guid-55706e39-3d73-4b70-a5c5-2aa940c5481d"
        },
        "assign_current_droplet": {
          "href": "/v3/apps/guid-55706e39-3d73-4b70-a5c5-2aa940c5481d/current_droplet",
          "method": "PUT"
        },
        "buildpack": {
          "href": "/v2/buildpacks/75507788-e025-49cb-83fa-c511e5bc3a69"
        }
      }
    },
    {
      "guid": "guid-230dc854-210b-415f-bff9-d478c15da677",
      "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-230dc854-210b-415f-bff9-d478c15da677"
        },
        "package": {
          "href": "/v3/packages/guid-fa165565-705a-4dc5-a0b2-12c86c2c603f"
        },
        "app": {
          "href": "/v3/apps/guid-55706e39-3d73-4b70-a5c5-2aa940c5481d"
        },
        "assign_current_droplet": {
          "href": "/v3/apps/guid-55706e39-3d73-4b70-a5c5-2aa940c5481d/current_droplet",
          "method": "PUT"
        }
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: c2f023b4-15f4-4a82-b392-b09bc8dc967d
Content-Length: 2299
X-Content-Type-Options: nosniff