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.eyJ1c2VyX2lkIjoidWFhLWlkLTE4MSIsImVtYWlsIjoiZW1haWwtMTQzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjczMjM5Njd9.bkt6SUTuUNgj6n90jSYpC_KpP3b8-WAgLtdiEZY5dmw
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v3/droplets?page=1&per_page=2" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE4MSIsImVtYWlsIjoiZW1haWwtMTQzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjczMjM5Njd9.bkt6SUTuUNgj6n90jSYpC_KpP3b8-WAgLtdiEZY5dmw" \
	-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-66d3550d-3c35-4829-b2ef-ade3e17b92ff",
      "state": "STAGING",
      "hash": null,
      "buildpack_git_url": null,
      "failure_reason": null,
      "detected_start_command": null,
      "created_at": "2015-03-18T22:52:47Z",
      "_links": {
        "self": {
          "href": "/v3/droplets/guid-66d3550d-3c35-4829-b2ef-ade3e17b92ff"
        },
        "package": {
          "href": "/v3/packages/guid-9b378bd9-745e-4f19-88ae-1bd7f93e56e5"
        },
        "app": {
          "href": "/v3/apps/guid-036482e7-7bcd-42fc-b218-90378a5ab4ce"
        },
        "buildpack": {
          "href": "/v2/buildpacks/71a9736f-f5f2-4d0f-8f6c-40a8609d04a9"
        }
      }
    },
    {
      "guid": "guid-5010be5c-b0c5-45f5-a2ec-7028c9002390",
      "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-18T22:52:47Z",
      "_links": {
        "self": {
          "href": "/v3/droplets/guid-5010be5c-b0c5-45f5-a2ec-7028c9002390"
        },
        "package": {
          "href": "/v3/packages/guid-9b378bd9-745e-4f19-88ae-1bd7f93e56e5"
        },
        "app": {
          "href": "/v3/apps/guid-036482e7-7bcd-42fc-b218-90378a5ab4ce"
        }
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 0d3496d1-a1c5-4fe8-ac84-4e5bc523b4a2
Content-Length: 1598
X-Content-Type-Options: nosniff