Droplets (Experimental) API

List all Droplets

GET /v3/droplets

Request

Route

GET /v3/droplets?page=1&per_page=2&order_by=-created_at

Parameters

Name	Description	Valid Values	Example Values
app_guids	Apps to filter by	app guids	app_guids=app_guid1,app_guid2
states	Droplet state to filter by	PENDING STAGING STAGED FAILED EXPIRED	states=PENDING,STAGING
page	Page to display	>= 1
per_page	Number of results per page	1-5000
order_by	Value to sort by. Prepend with "+" or "-" to change sort direction to ascending or descending, respectively.	created_at updated_at

page: 1
per_page: 2
order_by: -created_at

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMxNyIsImVtYWlsIjoiZW1haWwtMjIxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTM4MzcyNzh9.Fz53ctXZSg4Nr50GvJMwC6mYryDeYipogOtaJfzdJlU
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v3/droplets?page=1&per_page=2&order_by=-created_at" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMxNyIsImVtYWlsIjoiZW1haWwtMjIxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTM4MzcyNzh9.Fz53ctXZSg4Nr50GvJMwC6mYryDeYipogOtaJfzdJlU" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "pagination": {
    "total_results": 2,
    "first": {
      "href": "/v3/droplets?order_by=-created_at&page=1&per_page=2"
    },
    "last": {
      "href": "/v3/droplets?order_by=-created_at&page=1&per_page=2"
    },
    "next": null,
    "previous": null
  },
  "resources": [
    {
      "guid": "guid-999bff16-ded7-4e96-9619-b8293f6022f6",
      "state": "STAGED",
      "error": null,
      "lifecycle": {
        "type": "buildpack",
        "data": {
          "buildpack": "name-2074",
          "stack": "name-2075"
        }
      },
      "memory_limit": 123,
      "disk_limit": 456,
      "result": {
        "execution_metadata": "black-box-secrets",
        "process_types": {
          "web": "started"
        },
        "hash": {
          "type": "sha1",
          "value": "my-hash"
        },
        "buildpack": "https://github.com/cloudfoundry/detected-buildpack.git",
        "stack": null
      },
      "environment_variables": {

      },
      "created_at": "1970-01-01T00:00:02Z",
      "updated_at": "2016-01-19T19:41:17Z",
      "links": {
        "self": {
          "href": "/v3/droplets/guid-999bff16-ded7-4e96-9619-b8293f6022f6"
        },
        "package": {
          "href": "/v3/packages/guid-74dceaa3-7224-4410-bdd5-87bcb2f72788"
        },
        "app": {
          "href": "/v3/apps/guid-bb959097-7ab7-4e91-8756-1612ddc2a0ea"
        },
        "assign_current_droplet": {
          "href": "/v3/apps/guid-bb959097-7ab7-4e91-8756-1612ddc2a0ea/current_droplet",
          "method": "PUT"
        }
      }
    },
    {
      "guid": "guid-6a14bfc5-5e0f-4812-9566-562f9b6ae721",
      "state": "STAGING",
      "error": null,
      "lifecycle": {
        "type": "buildpack",
        "data": {
          "buildpack": "name-2076",
          "stack": "name-2077"
        }
      },
      "memory_limit": null,
      "disk_limit": null,
      "result": null,
      "environment_variables": {
        "yuu": "huuu"
      },
      "created_at": "1970-01-01T00:00:01Z",
      "updated_at": "2016-01-19T19:41:17Z",
      "links": {
        "self": {
          "href": "/v3/droplets/guid-6a14bfc5-5e0f-4812-9566-562f9b6ae721"
        },
        "package": {
          "href": "/v3/packages/guid-74dceaa3-7224-4410-bdd5-87bcb2f72788"
        },
        "app": {
          "href": "/v3/apps/guid-bb959097-7ab7-4e91-8756-1612ddc2a0ea"
        },
        "assign_current_droplet": {
          "href": "/v3/apps/guid-bb959097-7ab7-4e91-8756-1612ddc2a0ea/current_droplet",
          "method": "PUT"
        },
        "buildpack": {
          "href": "/v2/buildpacks/61244c89-64d3-4f31-a308-1a47adc466d4"
        }
      }
    }
  ]
}

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
X-Runtime: 0.018702
Content-Length: 2668