Apps (Experimental) API

Filters Apps by guids, names, spaces, and organizations

GET /v3/apps

Request

Route

GET /v3/apps?names[]=my_app1&space_guids[]=da9b76f8-2dd3-4d55-81b9-13efddaf75f6&space_guids[]=b8ffa286-eb2e-480f-938b-4d58d97445b5&space_guids[]=b4579b85-013c-47f2-ab33-178dbf75cbfe&page=1&per_page=2&order_by=created_at&order_direction=desc

Parameters

Name	Description	Valid Values	Example Values
names	Names of apps to filter by	array of strings	names[]=name1&names[]=name2
space_guids	Spaces to filter by	array of strings	space_guids[]=space_guid1&space_guids[]=space_guid2
organization_guids	Organizations to filter by	array of strings	organization_guids[]=org_guid1&organization_guids[]=org_guid2
guids	App guids to filter by	array of strings	guid[]=guid1&guid[]=guid2
page	Page to display	>= 1
per_page	Number of results per page	1 - 5000
order_by	Value to sort by	created_at, updated_at
order_direction	Direction to sort by	asc, desc

names: ["my_app1"]
space_guids: ["da9b76f8-2dd3-4d55-81b9-13efddaf75f6", "b8ffa286-eb2e-480f-938b-4d58d97445b5", "b4579b85-013c-47f2-ab33-178dbf75cbfe"]
page: 1
per_page: 2
order_by: created_at
order_direction: desc

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTcxIiwiZW1haWwiOiJlbWFpbC00MkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDM2ODI5Nzc2fQ.r200OaNS1VmMWyJeLIY9yeX24owWikZkygE3R1IFGpc
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v3/apps?names[]=my_app1&space_guids[]=da9b76f8-2dd3-4d55-81b9-13efddaf75f6&space_guids[]=b8ffa286-eb2e-480f-938b-4d58d97445b5&space_guids[]=b4579b85-013c-47f2-ab33-178dbf75cbfe&page=1&per_page=2&order_by=created_at&order_direction=desc" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTcxIiwiZW1haWwiOiJlbWFpbC00MkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDM2ODI5Nzc2fQ.r200OaNS1VmMWyJeLIY9yeX24owWikZkygE3R1IFGpc" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "pagination": {
    "total_results": 3,
    "first": {
      "href": "/v3/apps?names[]=my_app1&space_guids[]=da9b76f8-2dd3-4d55-81b9-13efddaf75f6&space_guids[]=b8ffa286-eb2e-480f-938b-4d58d97445b5&space_guids[]=b4579b85-013c-47f2-ab33-178dbf75cbfe&order_by=created_at&order_direction=desc&page=1&per_page=2"
    },
    "last": {
      "href": "/v3/apps?names[]=my_app1&space_guids[]=da9b76f8-2dd3-4d55-81b9-13efddaf75f6&space_guids[]=b8ffa286-eb2e-480f-938b-4d58d97445b5&space_guids[]=b4579b85-013c-47f2-ab33-178dbf75cbfe&order_by=created_at&order_direction=desc&page=2&per_page=2"
    },
    "next": {
      "href": "/v3/apps?names[]=my_app1&space_guids[]=da9b76f8-2dd3-4d55-81b9-13efddaf75f6&space_guids[]=b8ffa286-eb2e-480f-938b-4d58d97445b5&space_guids[]=b4579b85-013c-47f2-ab33-178dbf75cbfe&order_by=created_at&order_direction=desc&page=2&per_page=2"
    },
    "previous": null
  },
  "resources": [
    {
      "guid": "guid-f96cb2e0-a1a8-471a-813d-1a0c1e29d903",
      "name": "my_app1",
      "desired_state": "STOPPED",
      "total_desired_instances": 0,
      "buildpack": null,
      "created_at": "2015-07-06T23:22:56Z",
      "updated_at": null,
      "environment_variables": {

      },
      "_links": {
        "self": {
          "href": "/v3/apps/guid-f96cb2e0-a1a8-471a-813d-1a0c1e29d903"
        },
        "processes": {
          "href": "/v3/apps/guid-f96cb2e0-a1a8-471a-813d-1a0c1e29d903/processes"
        },
        "packages": {
          "href": "/v3/apps/guid-f96cb2e0-a1a8-471a-813d-1a0c1e29d903/packages"
        },
        "space": {
          "href": "/v2/spaces/da9b76f8-2dd3-4d55-81b9-13efddaf75f6"
        },
        "start": {
          "href": "/v3/apps/guid-f96cb2e0-a1a8-471a-813d-1a0c1e29d903/start",
          "method": "PUT"
        },
        "stop": {
          "href": "/v3/apps/guid-f96cb2e0-a1a8-471a-813d-1a0c1e29d903/stop",
          "method": "PUT"
        },
        "assign_current_droplet": {
          "href": "/v3/apps/guid-f96cb2e0-a1a8-471a-813d-1a0c1e29d903/current_droplet",
          "method": "PUT"
        }
      }
    },
    {
      "guid": "guid-2eec1388-994e-4acc-9e8a-241f3fccf642",
      "name": "my_app1",
      "desired_state": "STOPPED",
      "total_desired_instances": 0,
      "buildpack": null,
      "created_at": "2015-07-06T23:22:56Z",
      "updated_at": null,
      "environment_variables": {

      },
      "_links": {
        "self": {
          "href": "/v3/apps/guid-2eec1388-994e-4acc-9e8a-241f3fccf642"
        },
        "processes": {
          "href": "/v3/apps/guid-2eec1388-994e-4acc-9e8a-241f3fccf642/processes"
        },
        "packages": {
          "href": "/v3/apps/guid-2eec1388-994e-4acc-9e8a-241f3fccf642/packages"
        },
        "space": {
          "href": "/v2/spaces/b4579b85-013c-47f2-ab33-178dbf75cbfe"
        },
        "start": {
          "href": "/v3/apps/guid-2eec1388-994e-4acc-9e8a-241f3fccf642/start",
          "method": "PUT"
        },
        "stop": {
          "href": "/v3/apps/guid-2eec1388-994e-4acc-9e8a-241f3fccf642/stop",
          "method": "PUT"
        },
        "assign_current_droplet": {
          "href": "/v3/apps/guid-2eec1388-994e-4acc-9e8a-241f3fccf642/current_droplet",
          "method": "PUT"
        }
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 26961ace-948d-444b-bc70-5dd1929acb99
Content-Length: 3280
X-Content-Type-Options: nosniff