Filters Apps by guids, names, spaces, and organizations
GET /v3/apps
Request
Route
GET /v3/apps?names[]=my_app1&space_guids[]=e2ff105d-b8dd-4e82-9175-f031dceb35cb&space_guids[]=cfb06514-8102-4054-b104-1e79b7724b20&space_guids[]=28967e2e-64a7-4101-9a35-9bdf01cc1ed9&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
|
|
- names[]=name1&names[]=name2
|
space_guids
|
Spaces to filter by
|
|
- space_guids[]=space_guid1&space_guids[]=space_guid2
|
organization_guids
|
Organizations to filter by
|
|
- organization_guids[]=org_guid1&organization_guids[]=org_guid2
|
guids
|
App guids to filter by
|
|
- guid[]=guid1&guid[]=guid2
|
page
|
Page to display
|
|
|
per_page
|
Number of results per page
|
|
|
order_by
|
Value to sort by
|
|
|
order_direction
|
Direction to sort by
|
|
|
names: ["my_app1"]
space_guids: ["e2ff105d-b8dd-4e82-9175-f031dceb35cb", "cfb06514-8102-4054-b104-1e79b7724b20", "28967e2e-64a7-4101-9a35-9bdf01cc1ed9"]
page: 1
per_page: 2
order_by: created_at
order_direction: desc
Headers
cURL
curl "https://api.[your-domain.com]/v3/apps?names[]=my_app1&space_guids[]=e2ff105d-b8dd-4e82-9175-f031dceb35cb&space_guids[]=cfb06514-8102-4054-b104-1e79b7724b20&space_guids[]=28967e2e-64a7-4101-9a35-9bdf01cc1ed9&page=1&per_page=2&order_by=created_at&order_direction=desc" -X GET \
-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE1MiIsImVtYWlsIjoiZW1haWwtMTA2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mzg2NDE3OTV9.gTCw3Ej_GOIh7ULReEx23orpqoA1icWQMqXrt5nHK84" \
-H "Host: example.org" \
-H "Cookie: "
Response
Status
200 OK
Body
{
"pagination": {
"total_results": 3,
"first": {
"href": "/v3/apps?names[]=my_app1&space_guids[]=e2ff105d-b8dd-4e82-9175-f031dceb35cb&space_guids[]=cfb06514-8102-4054-b104-1e79b7724b20&space_guids[]=28967e2e-64a7-4101-9a35-9bdf01cc1ed9&order_by=created_at&order_direction=desc&page=1&per_page=2"
},
"last": {
"href": "/v3/apps?names[]=my_app1&space_guids[]=e2ff105d-b8dd-4e82-9175-f031dceb35cb&space_guids[]=cfb06514-8102-4054-b104-1e79b7724b20&space_guids[]=28967e2e-64a7-4101-9a35-9bdf01cc1ed9&order_by=created_at&order_direction=desc&page=2&per_page=2"
},
"next": {
"href": "/v3/apps?names[]=my_app1&space_guids[]=e2ff105d-b8dd-4e82-9175-f031dceb35cb&space_guids[]=cfb06514-8102-4054-b104-1e79b7724b20&space_guids[]=28967e2e-64a7-4101-9a35-9bdf01cc1ed9&order_by=created_at&order_direction=desc&page=2&per_page=2"
},
"previous": null
},
"resources": [
{
"guid": "guid-ef02213b-cfe8-454b-965c-cd2b003b7e58",
"name": "my_app1",
"desired_state": "STOPPED",
"total_desired_instances": 0,
"buildpack": null,
"created_at": "2015-07-27T22:43:15Z",
"updated_at": null,
"environment_variables": {
},
"_links": {
"self": {
"href": "/v3/apps/guid-ef02213b-cfe8-454b-965c-cd2b003b7e58"
},
"processes": {
"href": "/v3/apps/guid-ef02213b-cfe8-454b-965c-cd2b003b7e58/processes"
},
"packages": {
"href": "/v3/apps/guid-ef02213b-cfe8-454b-965c-cd2b003b7e58/packages"
},
"space": {
"href": "/v2/spaces/e2ff105d-b8dd-4e82-9175-f031dceb35cb"
},
"start": {
"href": "/v3/apps/guid-ef02213b-cfe8-454b-965c-cd2b003b7e58/start",
"method": "PUT"
},
"stop": {
"href": "/v3/apps/guid-ef02213b-cfe8-454b-965c-cd2b003b7e58/stop",
"method": "PUT"
},
"assign_current_droplet": {
"href": "/v3/apps/guid-ef02213b-cfe8-454b-965c-cd2b003b7e58/current_droplet",
"method": "PUT"
}
}
},
{
"guid": "guid-566fac0d-efe0-40dd-b6a2-9c1ea5ba4221",
"name": "my_app1",
"desired_state": "STOPPED",
"total_desired_instances": 0,
"buildpack": null,
"created_at": "2015-07-27T22:43:15Z",
"updated_at": null,
"environment_variables": {
},
"_links": {
"self": {
"href": "/v3/apps/guid-566fac0d-efe0-40dd-b6a2-9c1ea5ba4221"
},
"processes": {
"href": "/v3/apps/guid-566fac0d-efe0-40dd-b6a2-9c1ea5ba4221/processes"
},
"packages": {
"href": "/v3/apps/guid-566fac0d-efe0-40dd-b6a2-9c1ea5ba4221/packages"
},
"space": {
"href": "/v2/spaces/28967e2e-64a7-4101-9a35-9bdf01cc1ed9"
},
"start": {
"href": "/v3/apps/guid-566fac0d-efe0-40dd-b6a2-9c1ea5ba4221/start",
"method": "PUT"
},
"stop": {
"href": "/v3/apps/guid-566fac0d-efe0-40dd-b6a2-9c1ea5ba4221/stop",
"method": "PUT"
},
"assign_current_droplet": {
"href": "/v3/apps/guid-566fac0d-efe0-40dd-b6a2-9c1ea5ba4221/current_droplet",
"method": "PUT"
}
}
}
]
}
Headers