Home
Version 3
Apps (Experimental) API

Apps (Experimental) API

List associated droplets

GET /v3/apps/:guid/droplets

Request

Route

GET /v3/apps/guid-6b9f4c88-b82a-4c94-8d3d-16ffdc7088bb/droplets?page=1&per_page=2&order_by=-created_at

Parameters

Name Description Valid Values Example Values
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.eyJ1c2VyX2lkIjoidWFhLWlkLTE5MiIsImVtYWlsIjoiZW1haWwtMTU1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDcxMTY4NDB9.MwYZEAbyxkD782RS84JlpbpIxf7fduHIOVpVn-3G9o8
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v3/apps/guid-6b9f4c88-b82a-4c94-8d3d-16ffdc7088bb/droplets?page=1&per_page=2&order_by=-created_at" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE5MiIsImVtYWlsIjoiZW1haWwtMTU1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDcxMTY4NDB9.MwYZEAbyxkD782RS84JlpbpIxf7fduHIOVpVn-3G9o8" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "pagination": {
    "total_results": 2,
    "first": {
      "href": "/v3/apps/guid-6b9f4c88-b82a-4c94-8d3d-16ffdc7088bb/droplets?order_by=-created_at&page=1&per_page=2"
    },
    "last": {
      "href": "/v3/apps/guid-6b9f4c88-b82a-4c94-8d3d-16ffdc7088bb/droplets?order_by=-created_at&page=1&per_page=2"
    },
    "next": null,
    "previous": null
  },
  "resources": [
    {
      "guid": "guid-5b4f9e89-2726-4ac2-b7eb-f8e8e56f767e",
      "state": "STAGED",
      "error": null,
      "lifecycle": {
        "type": "buildpack",
        "data": {
          "buildpack": "name-908",
          "stack": "name-909"
        }
      },
      "memory_limit": null,
      "disk_limit": null,
      "result": {
        "buildpack": "https://github.com/cloudfoundry/my-buildpack.git",
        "stack": null,
        "process_types": "{\"web\":\"started\"}",
        "hash": {
          "type": "sha1",
          "value": "my-hash"
        },
        "execution_metadata": null
      },
      "environment_variables": {

      },
      "created_at": "1970-01-01T00:00:02Z",
      "updated_at": null,
      "links": {
        "self": {
          "href": "/v3/droplets/guid-5b4f9e89-2726-4ac2-b7eb-f8e8e56f767e"
        },
        "package": {
          "href": "/v3/packages/guid-44ee85de-0adc-454d-9761-be1168e64ba3"
        },
        "app": {
          "href": "/v3/apps/guid-6b9f4c88-b82a-4c94-8d3d-16ffdc7088bb"
        },
        "assign_current_droplet": {
          "href": "/v3/apps/guid-6b9f4c88-b82a-4c94-8d3d-16ffdc7088bb/current_droplet",
          "method": "PUT"
        }
      }
    },
    {
      "guid": "guid-c6ae847c-0f67-4dc0-94ac-c8a6a9153941",
      "state": "STAGING",
      "error": null,
      "lifecycle": {
        "type": "buildpack",
        "data": {
          "buildpack": "name-906",
          "stack": "name-907"
        }
      },
      "memory_limit": null,
      "disk_limit": null,
      "result": {
        "buildpack": "name-896",
        "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-c6ae847c-0f67-4dc0-94ac-c8a6a9153941"
        },
        "package": {
          "href": "/v3/packages/guid-44ee85de-0adc-454d-9761-be1168e64ba3"
        },
        "app": {
          "href": "/v3/apps/guid-6b9f4c88-b82a-4c94-8d3d-16ffdc7088bb"
        },
        "assign_current_droplet": {
          "href": "/v3/apps/guid-6b9f4c88-b82a-4c94-8d3d-16ffdc7088bb/current_droplet",
          "method": "PUT"
        },
        "buildpack": {
          "href": "/v2/buildpacks/49b7a080-d31e-48bd-b1ef-5c073e25b530"
        }
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 614ea293-bb81-44b8-a2e0-62f9025f7db6
Content-Length: 2894
X-Content-Type-Options: nosniff