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

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: d6071ba7-751b-44a7-81c5-8ee0c96c0eef
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-dbe489df-f5ce-4f77-b7a3-d3b71cd70c6c",
      "state": "STAGING",
      "hash": null,
      "buildpack_git_url": null,
      "failure_reason": null,
      "detected_start_command": null,
      "created_at": "2015-02-12T01:42:12Z",
      "_links": {
        "self": {
          "href": "/v3/droplets/guid-dbe489df-f5ce-4f77-b7a3-d3b71cd70c6c"
        },
        "package": {
          "href": "/v3/packages/guid-e19e37ab-082f-4cbd-ba47-027c68f90326"
        },
        "buildpack": {
          "href": "/v2/buildpacks/ef710f81-a85b-49eb-86cc-a5b466d38606"
        }
      }
    },
    {
      "guid": "guid-0b283577-fe87-427c-b2b1-9289a5cfad6d",
      "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-12T01:42:12Z",
      "_links": {
        "self": {
          "href": "/v3/droplets/guid-0b283577-fe87-427c-b2b1-9289a5cfad6d"
        },
        "package": {
          "href": "/v3/packages/guid-e19e37ab-082f-4cbd-ba47-027c68f90326"
        }
      }
    }
  ]
}