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.eyJ1c2VyX2lkIjoidWFhLWlkLTEwMiIsImVtYWlsIjoiZW1haWwtNzNAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLnJlYWQiLCJjbG91ZF9jb250cm9sbGVyLndyaXRlIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyNjE4Nzc0MX0.MecT4VOfiw_yQQRzSLCeT57MHETTz6dBxSgAM6nqNoc
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v3/droplets?page=1&per_page=2" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEwMiIsImVtYWlsIjoiZW1haWwtNzNAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLnJlYWQiLCJjbG91ZF9jb250cm9sbGVyLndyaXRlIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyNjE4Nzc0MX0.MecT4VOfiw_yQQRzSLCeT57MHETTz6dBxSgAM6nqNoc" \
	-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-b8be80db-1e3d-46b5-a418-13ba757cf79e",
      "state": "STAGING",
      "hash": null,
      "buildpack_git_url": null,
      "failure_reason": null,
      "detected_start_command": null,
      "created_at": "2015-03-05T19:15:41Z",
      "_links": {
        "self": {
          "href": "/v3/droplets/guid-b8be80db-1e3d-46b5-a418-13ba757cf79e"
        },
        "package": {
          "href": "/v3/packages/guid-15d68436-7c15-493c-a402-8f0ef371b2c5"
        },
        "app": {
          "href": "/v3/apps/guid-608a5b24-6645-4d94-aedb-04b4eab733df"
        },
        "buildpack": {
          "href": "/v2/buildpacks/63223885-695f-48b7-bbfb-6f89742a5e5e"
        }
      }
    },
    {
      "guid": "guid-ae32e688-8514-4dfe-bbdd-deb76ae9191b",
      "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-05T19:15:41Z",
      "_links": {
        "self": {
          "href": "/v3/droplets/guid-ae32e688-8514-4dfe-bbdd-deb76ae9191b"
        },
        "package": {
          "href": "/v3/packages/guid-15d68436-7c15-493c-a402-8f0ef371b2c5"
        },
        "app": {
          "href": "/v3/apps/guid-608a5b24-6645-4d94-aedb-04b4eab733df"
        }
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: bf8e6a63-ea7c-4b31-8f9a-cca64487e2d4
Content-Length: 1598
X-Content-Type-Options: nosniff