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&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
  • 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.eyJ1c2VyX2lkIjoidWFhLWlkLTM1MCIsImVtYWlsIjoiZW1haWwtMjUyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDU1NTc5NjV9.VpaSv9y_XxLnJ7-Ai621JKDbWUHIlFgQVUbCEUCENqE
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.eyJ1c2VyX2lkIjoidWFhLWlkLTM1MCIsImVtYWlsIjoiZW1haWwtMjUyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDU1NTc5NjV9.VpaSv9y_XxLnJ7-Ai621JKDbWUHIlFgQVUbCEUCENqE" \
	-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-11ea4e77-54b5-47bb-b120-266bac7b184c",
      "state": "STAGED",
      "error": null,
      "lifecycle": {
        "type": "buildpack",
        "data": {
          "buildpack": "https://github.com/cloudfoundry/requested-buildpack.git",
          "stack": null
        }
      },
      "memory_limit": 123,
      "disk_limit": 456,
      "result": {
        "buildpack": "https://github.com/cloudfoundry/detected-buildpack.git",
        "stack": null,
        "process_types": {
          "web": "started"
        },
        "hash": {
          "type": "sha1",
          "value": "my-hash"
        },
        "execution_metadata": "black-box-secrets"
      },
      "environment_variables": {

      },
      "created_at": "1970-01-01T00:00:02Z",
      "updated_at": null,
      "links": {
        "self": {
          "href": "/v3/droplets/guid-11ea4e77-54b5-47bb-b120-266bac7b184c"
        },
        "package": {
          "href": "/v3/packages/guid-5a177d83-e61b-447a-9a1d-dcdb5864b267"
        },
        "app": {
          "href": "/v3/apps/guid-412528e2-acfa-4ca0-b68d-c51cbf97f7f7"
        },
        "assign_current_droplet": {
          "href": "/v3/apps/guid-412528e2-acfa-4ca0-b68d-c51cbf97f7f7/current_droplet",
          "method": "PUT"
        }
      }
    },
    {
      "guid": "guid-d8ae62f2-629e-427d-8171-10c96b701384",
      "state": "STAGING",
      "error": null,
      "lifecycle": null,
      "memory_limit": null,
      "disk_limit": null,
      "result": {
        "buildpack": "name-2258",
        "stack": null,
        "process_types": null,
        "hash": {
          "type": "sha1",
          "value": null
        },
        "execution_metadata": null
      },
      "environment_variables": {
        "yuu": "huuu"
      },
      "created_at": "1970-01-01T00:00:01Z",
      "updated_at": null,
      "links": {
        "self": {
          "href": "/v3/droplets/guid-d8ae62f2-629e-427d-8171-10c96b701384"
        },
        "package": {
          "href": "/v3/packages/guid-5a177d83-e61b-447a-9a1d-dcdb5864b267"
        },
        "app": {
          "href": "/v3/apps/guid-412528e2-acfa-4ca0-b68d-c51cbf97f7f7"
        },
        "assign_current_droplet": {
          "href": "/v3/apps/guid-412528e2-acfa-4ca0-b68d-c51cbf97f7f7/current_droplet",
          "method": "PUT"
        },
        "buildpack": {
          "href": "/v2/buildpacks/fac51603-763e-469e-838b-fd0334ebcfbf"
        }
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: a56ee4d7-1297-4e12-bba3-70c1f57d7891
Content-Length: 2749
X-Content-Type-Options: nosniff