Home
Version 3
Droplets (Experimental) API

Droplets (Experimental) API

List all Droplets

GET /v3/droplets

Request

Route

GET /v3/droplets?page=1&per_page=2

Parameters

Name Description Valid Values Example Values
page Page to display
  • >= 1
per_page Number of results per page
  • 1-5000
page: 1
per_page: 2

Body

Name Description Default Valid Values Example Values

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMwNCIsImVtYWlsIjoiZW1haWwtMjM2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mjc0ODA4NjZ9.Qj7mWaa0oM_Ot6-gT0O7_xlJMNjllzXYN1BRknPhi30
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v3/droplets?page=1&per_page=2" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMwNCIsImVtYWlsIjoiZW1haWwtMjM2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mjc0ODA4NjZ9.Qj7mWaa0oM_Ot6-gT0O7_xlJMNjllzXYN1BRknPhi30" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "pagination": {
    "total_results": 2,
    "first": {
      "href": "/v3/droplets?page=1&per_page=2"
    },
    "last": {
      "href": "/v3/droplets?page=1&per_page=2"
    },
    "next": null,
    "previous": null
  },
  "resources": [
    {
      "guid": "guid-a00fe4f0-afa5-466d-928d-52d4ec759c82",
      "state": "STAGING",
      "hash": null,
      "buildpack_git_url": null,
      "failure_reason": null,
      "detected_start_command": null,
      "created_at": "2015-03-20T18:27:46Z",
      "_links": {
        "self": {
          "href": "/v3/droplets/guid-a00fe4f0-afa5-466d-928d-52d4ec759c82"
        },
        "package": {
          "href": "/v3/packages/guid-dd8c0a03-ed45-488a-ab43-dfc03fcc8dee"
        },
        "app": {
          "href": "/v3/apps/guid-0865a4ea-aa52-477c-bd38-64e3957d704f"
        },
        "buildpack": {
          "href": "/v2/buildpacks/6ebaf88d-d85b-470d-b016-c4185c49a808"
        }
      }
    },
    {
      "guid": "guid-e2b57f4d-4540-4bab-ad9f-af18679a8a3c",
      "state": "STAGED",
      "hash": "my-hash",
      "buildpack_git_url": "https://github.com/cloudfoundry/my-buildpack.git",
      "failure_reason": null,
      "detected_start_command": null,
      "created_at": "2015-03-20T18:27:46Z",
      "_links": {
        "self": {
          "href": "/v3/droplets/guid-e2b57f4d-4540-4bab-ad9f-af18679a8a3c"
        },
        "package": {
          "href": "/v3/packages/guid-dd8c0a03-ed45-488a-ab43-dfc03fcc8dee"
        },
        "app": {
          "href": "/v3/apps/guid-0865a4ea-aa52-477c-bd38-64e3957d704f"
        }
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 308f6b37-988c-489c-a313-cb184e9ce0a3
Content-Length: 1598
X-Content-Type-Options: nosniff