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.eyJ1c2VyX2lkIjoidWFhLWlkLTE0MSIsImVtYWlsIjoiZW1haWwtMTAzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQ0NzE2OTF9.YwAf1nbeXEz28nEbbGcyKMtQuuP5Atti5rDrv9GrPpM
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.eyJ1c2VyX2lkIjoidWFhLWlkLTE0MSIsImVtYWlsIjoiZW1haWwtMTAzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQ0NzE2OTF9.YwAf1nbeXEz28nEbbGcyKMtQuuP5Atti5rDrv9GrPpM" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: c7acf2c6-00a3-4d22-99a3-7f6a66f29543
Content-Length: 1400
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-3daedcf0-6adc-4342-8b19-de3639fa31b3",
      "state": "STAGING",
      "hash": null,
      "buildpack_git_url": null,
      "failure_reason": null,
      "detected_start_command": null,
      "created_at": "2015-02-13T22:34:51Z",
      "_links": {
        "self": {
          "href": "/v3/droplets/guid-3daedcf0-6adc-4342-8b19-de3639fa31b3"
        },
        "package": {
          "href": "/v3/packages/guid-80f05859-2823-4eb3-8af3-9ea9fa52ec53"
        },
        "buildpack": {
          "href": "/v2/buildpacks/217b723f-5ad1-4242-991d-3998866b3c99"
        }
      }
    },
    {
      "guid": "guid-512520a0-dc11-432b-9751-55d66695980f",
      "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-02-13T22:34:51Z",
      "_links": {
        "self": {
          "href": "/v3/droplets/guid-512520a0-dc11-432b-9751-55d66695980f"
        },
        "package": {
          "href": "/v3/packages/guid-80f05859-2823-4eb3-8af3-9ea9fa52ec53"
        }
      }
    }
  ]
}