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.eyJ1c2VyX2lkIjoidWFhLWlkLTk3IiwiZW1haWwiOiJlbWFpbC03NkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIucmVhZCIsImNsb3VkX2NvbnRyb2xsZXIud3JpdGUiXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDMyNzc0OTgyfQ.rXCnV1WdK5fV2qXCs5gdn_JfIg--M-pJrOgpKpyq-JU
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v3/droplets?page=1&per_page=2" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTk3IiwiZW1haWwiOiJlbWFpbC03NkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIucmVhZCIsImNsb3VkX2NvbnRyb2xsZXIud3JpdGUiXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDMyNzc0OTgyfQ.rXCnV1WdK5fV2qXCs5gdn_JfIg--M-pJrOgpKpyq-JU" \
	-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-864157f7-4b02-41ee-afa4-ad315e958ba2",
      "state": "STAGING",
      "hash": null,
      "buildpack_git_url": null,
      "failure_reason": null,
      "detected_start_command": null,
      "procfile": null,
      "environment_variables": {
        "yuu": "huuu"
      },
      "created_at": "2015-05-21T01:03:02Z",
      "updated_at": null,
      "_links": {
        "self": {
          "href": "/v3/droplets/guid-864157f7-4b02-41ee-afa4-ad315e958ba2"
        },
        "package": {
          "href": "/v3/packages/guid-713e4643-651d-4d38-bf79-60e65dbbb2b7"
        },
        "app": {
          "href": "/v3/apps/guid-612594ec-c4cf-41fe-b109-0e769e60083a"
        },
        "buildpack": {
          "href": "/v2/buildpacks/da687c40-f440-4bc4-ac3d-368a419ac206"
        }
      }
    },
    {
      "guid": "guid-d7c121b9-96d9-4617-97f3-2a6e8f796afd",
      "state": "STAGED",
      "hash": "my-hash",
      "buildpack_git_url": "https://github.com/cloudfoundry/my-buildpack.git",
      "failure_reason": null,
      "detected_start_command": null,
      "procfile": null,
      "environment_variables": {

      },
      "created_at": "2015-05-21T01:03:02Z",
      "updated_at": null,
      "_links": {
        "self": {
          "href": "/v3/droplets/guid-d7c121b9-96d9-4617-97f3-2a6e8f796afd"
        },
        "package": {
          "href": "/v3/packages/guid-713e4643-651d-4d38-bf79-60e65dbbb2b7"
        },
        "app": {
          "href": "/v3/apps/guid-612594ec-c4cf-41fe-b109-0e769e60083a"
        }
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: a290a9d1-71ce-44db-8743-2354c5e3e4b0
Content-Length: 1805
X-Content-Type-Options: nosniff