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.eyJ1c2VyX2lkIjoidWFhLWlkLTM1NCIsImVtYWlsIjoiZW1haWwtMjU1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjkwMzg3MTl9.2hfdZDZX00SbXzW71SQ1D_L76rtvAYyBcvRmJ2B93GI
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v3/droplets?page=1&per_page=2" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM1NCIsImVtYWlsIjoiZW1haWwtMjU1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjkwMzg3MTl9.2hfdZDZX00SbXzW71SQ1D_L76rtvAYyBcvRmJ2B93GI" \
	-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-8db8e666-0cfb-4c5b-8716-6e2cb450212c",
      "state": "STAGING",
      "hash": null,
      "buildpack_git_url": null,
      "failure_reason": null,
      "detected_start_command": null,
      "procfile": null,
      "environment_variables": {
        "yuu": "huuu"
      },
      "created_at": "2015-04-07T19:11:59Z",
      "_links": {
        "self": {
          "href": "/v3/droplets/guid-8db8e666-0cfb-4c5b-8716-6e2cb450212c"
        },
        "package": {
          "href": "/v3/packages/guid-14a28ab1-6c24-4bbf-8fdf-e90ccdc3db7d"
        },
        "app": {
          "href": "/v3/apps/guid-d538446a-2736-4e15-aefc-1f68a1c953f4"
        },
        "buildpack": {
          "href": "/v2/buildpacks/7a17d27e-a054-4507-9612-cb8523d6a987"
        }
      }
    },
    {
      "guid": "guid-debd590b-3d87-4d76-adf4-ef2fc1847c56",
      "state": "STAGED",
      "hash": "my-hash",
      "buildpack_git_url": "https://github.com/cloudfoundry/my-buildpack.git",
      "failure_reason": null,
      "detected_start_command": null,
      "procfile": null,
      "environment_variables": {

      },
      "created_at": "2015-04-07T19:11:59Z",
      "_links": {
        "self": {
          "href": "/v3/droplets/guid-debd590b-3d87-4d76-adf4-ef2fc1847c56"
        },
        "package": {
          "href": "/v3/packages/guid-14a28ab1-6c24-4bbf-8fdf-e90ccdc3db7d"
        },
        "app": {
          "href": "/v3/apps/guid-d538446a-2736-4e15-aefc-1f68a1c953f4"
        }
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 002c2b7e-ecf4-4ab8-a0d0-e7fe6fd45fe0
Content-Length: 1753
X-Content-Type-Options: nosniff