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.eyJ1c2VyX2lkIjoidWFhLWlkLTI2OCIsImVtYWlsIjoiZW1haWwtMTg5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mjk2NjQxNDd9.GJfHUkOppmJQkhUeUUan4myyEUBoksmaUQJz5lvGgbk
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v3/droplets?page=1&per_page=2" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI2OCIsImVtYWlsIjoiZW1haWwtMTg5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mjk2NjQxNDd9.GJfHUkOppmJQkhUeUUan4myyEUBoksmaUQJz5lvGgbk" \
	-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-c6cb70e9-1545-4120-8a9f-7f5c102c25df",
      "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-15T00:55:47Z",
      "updated_at": null,
      "_links": {
        "self": {
          "href": "/v3/droplets/guid-c6cb70e9-1545-4120-8a9f-7f5c102c25df"
        },
        "package": {
          "href": "/v3/packages/guid-ded00055-1d68-41da-ae2b-e8afc0028124"
        },
        "app": {
          "href": "/v3/apps/guid-535f1dba-b8dd-4198-8dba-fe2220df07a9"
        },
        "buildpack": {
          "href": "/v2/buildpacks/2d3b4f26-8c9f-4a69-8fcc-6d2ef56e87e6"
        }
      }
    },
    {
      "guid": "guid-3ebdc39c-3d3a-4634-b263-a68e6d0a9b8f",
      "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-15T00:55:47Z",
      "updated_at": null,
      "_links": {
        "self": {
          "href": "/v3/droplets/guid-3ebdc39c-3d3a-4634-b263-a68e6d0a9b8f"
        },
        "package": {
          "href": "/v3/packages/guid-ded00055-1d68-41da-ae2b-e8afc0028124"
        },
        "app": {
          "href": "/v3/apps/guid-535f1dba-b8dd-4198-8dba-fe2220df07a9"
        }
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 3ba24edb-3ad3-4d0a-9bbe-7eee5988708b
Content-Length: 1805
X-Content-Type-Options: nosniff