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.eyJ1c2VyX2lkIjoidWFhLWlkLTE3OSIsImVtYWlsIjoiZW1haWwtMTMwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjU5NDg2NjZ9.zSSqav5j4wSnyZFVQ4FOQYniBz9PUSzdr0gn_MPx1iY
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v3/droplets?page=1&per_page=2" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE3OSIsImVtYWlsIjoiZW1haWwtMTMwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjU5NDg2NjZ9.zSSqav5j4wSnyZFVQ4FOQYniBz9PUSzdr0gn_MPx1iY" \
	-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-3ad43317-9d39-4dd9-a7c8-70689153ece5",
      "state": "STAGING",
      "hash": null,
      "buildpack_git_url": null,
      "failure_reason": null,
      "detected_start_command": null,
      "created_at": "2015-03-03T00:51:06Z",
      "_links": {
        "self": {
          "href": "/v3/droplets/guid-3ad43317-9d39-4dd9-a7c8-70689153ece5"
        },
        "package": {
          "href": "/v3/packages/guid-21b857b5-f89b-42c1-9ba5-0a59dbbd02b8"
        },
        "app": {
          "href": "/v3/apps/guid-3c5bc93f-1b04-42bb-b6b2-9a3765d2eea9"
        },
        "buildpack": {
          "href": "/v2/buildpacks/4c64dd24-2880-42a6-9daa-7cf06204715a"
        }
      }
    },
    {
      "guid": "guid-c9a15231-250e-4e7b-9640-359a2d62f97c",
      "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-03T00:51:06Z",
      "_links": {
        "self": {
          "href": "/v3/droplets/guid-c9a15231-250e-4e7b-9640-359a2d62f97c"
        },
        "package": {
          "href": "/v3/packages/guid-21b857b5-f89b-42c1-9ba5-0a59dbbd02b8"
        },
        "app": {
          "href": "/v3/apps/guid-3c5bc93f-1b04-42bb-b6b2-9a3765d2eea9"
        }
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 6c5bc248-5576-4b60-b962-92a8ca99dcc1
Content-Length: 1598
X-Content-Type-Options: nosniff