Home
Version 3
Droplets (Experimental) API

Droplets (Experimental) API

List all Droplets

GET /v3/droplets

Fields

Name Description Default Valid Values Example Values

Parameters

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

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIzIiwiZW1haWwiOiJlbWFpbC0yM0Bzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIucmVhZCIsImNsb3VkX2NvbnRyb2xsZXIud3JpdGUiXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI0MTM3MzYzfQ.1eWTJFGg1wXhx-ZQzTWU4JODL89eg1j1mJ0OZJENS4s
Host: example.org
Cookie: 

Route

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

Query Parameters

page: 1
per_page: 2

cURL

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

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 2867c632-1e95-437c-a04c-5cb9577f9086
Content-Length: 1264
X-Content-Type-Options: nosniff

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-eaf55efe-ec48-4f64-8996-f6bd8bcb96a0",
      "state": "STAGING",
      "hash": null,
      "buildpack_git_url": null,
      "created_at": "2015-02-10T01:42:43Z",
      "_links": {
        "self": {
          "href": "/v3/droplets/guid-eaf55efe-ec48-4f64-8996-f6bd8bcb96a0"
        },
        "package": {
          "href": "/v3/packages/guid-64599097-ced9-4ec7-9fbd-659dd8790a83"
        },
        "buildpack": {
          "href": "/v2/buildpacks/b1da69dd-e835-4e6d-a163-b5c7aeaba11b"
        }
      }
    },
    {
      "guid": "guid-595f0bc7-1cf7-4a68-bbfa-ce00d28e4331",
      "state": "STAGED",
      "hash": "my-hash",
      "buildpack_git_url": "https://github.com/cloudfoundry/my-buildpack.git",
      "created_at": "2015-02-10T01:42:43Z",
      "_links": {
        "self": {
          "href": "/v3/droplets/guid-595f0bc7-1cf7-4a68-bbfa-ce00d28e4331"
        },
        "package": {
          "href": "/v3/packages/guid-64599097-ced9-4ec7-9fbd-659dd8790a83"
        }
      }
    }
  ]
}