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.eyJ1c2VyX2lkIjoidWFhLWlkLTI1MSIsImVtYWlsIjoiZW1haWwtMTgyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjY2MzM5MTB9.TgQh21pvUpn7JpNW70PHRq9XtOdrzfmWvh1NNDHrlEc
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v3/droplets?page=1&per_page=2" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI1MSIsImVtYWlsIjoiZW1haWwtMTgyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjY2MzM5MTB9.TgQh21pvUpn7JpNW70PHRq9XtOdrzfmWvh1NNDHrlEc" \
	-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-c5391512-e187-4c50-867a-b0333987021b",
      "state": "STAGING",
      "hash": null,
      "buildpack_git_url": null,
      "failure_reason": null,
      "detected_start_command": null,
      "created_at": "2015-03-10T23:11:50Z",
      "_links": {
        "self": {
          "href": "/v3/droplets/guid-c5391512-e187-4c50-867a-b0333987021b"
        },
        "package": {
          "href": "/v3/packages/guid-2d8853b7-9ae6-49e0-9131-a4f4258304d5"
        },
        "app": {
          "href": "/v3/apps/guid-4b03d54e-fb57-4b94-b371-d3bcdea8b6ec"
        },
        "buildpack": {
          "href": "/v2/buildpacks/17da994f-73f7-42c8-912e-b29b0956000d"
        }
      }
    },
    {
      "guid": "guid-4b631056-f477-4be3-9bc6-0c8f53d0a6dc",
      "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-10T23:11:50Z",
      "_links": {
        "self": {
          "href": "/v3/droplets/guid-4b631056-f477-4be3-9bc6-0c8f53d0a6dc"
        },
        "package": {
          "href": "/v3/packages/guid-2d8853b7-9ae6-49e0-9131-a4f4258304d5"
        },
        "app": {
          "href": "/v3/apps/guid-4b03d54e-fb57-4b94-b371-d3bcdea8b6ec"
        }
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: f15b01d3-4093-4adf-8a2b-4528c66270b0
Content-Length: 1598
X-Content-Type-Options: nosniff