List all Apps
GET /v3/apps
Request
Route
GET /v3/apps?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
|
|
|
page: 1
per_page: 2
order_by: created_at
order_direction: desc
Body
Name |
Description |
Default |
Valid Values |
Example Values |
Headers
cURL
curl "https://api.[your-domain.com]/v3/apps?page=1&per_page=2&order_by=created_at&order_direction=desc" -X GET \
-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI4MyIsImVtYWlsIjoiZW1haWwtMjE1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mjc0ODA4NjR9.31kPpjXv5z2wTLHZzIFJo2IfU9dkTHT__QwVH9H8UH4" \
-H "Host: example.org" \
-H "Cookie: "
Response
Status
200 OK
Body
{
"pagination": {
"total_results": 3,
"first": {
"href": "/v3/apps?order_by=created_at&order_direction=desc&page=1&per_page=2"
},
"last": {
"href": "/v3/apps?order_by=created_at&order_direction=desc&page=2&per_page=2"
},
"next": {
"href": "/v3/apps?order_by=created_at&order_direction=desc&page=2&per_page=2"
},
"previous": null
},
"resources": [
{
"guid": "guid-7bc4af4a-13f3-4433-9123-74dc58b57f37",
"name": "my_app3",
"desired_state": "STOPPED",
"_links": {
"self": {
"href": "/v3/apps/guid-7bc4af4a-13f3-4433-9123-74dc58b57f37"
},
"processes": {
"href": "/v3/apps/guid-7bc4af4a-13f3-4433-9123-74dc58b57f37/processes"
},
"packages": {
"href": "/v3/apps/guid-7bc4af4a-13f3-4433-9123-74dc58b57f37/packages"
},
"space": {
"href": "/v2/spaces/da426b8e-3c4b-42fe-808e-217f733e1492"
}
}
},
{
"guid": "guid-0a3987fc-bf72-4ae5-b4d0-974d17d01ee3",
"name": "my_app2",
"desired_state": "STOPPED",
"_links": {
"self": {
"href": "/v3/apps/guid-0a3987fc-bf72-4ae5-b4d0-974d17d01ee3"
},
"processes": {
"href": "/v3/apps/guid-0a3987fc-bf72-4ae5-b4d0-974d17d01ee3/processes"
},
"packages": {
"href": "/v3/apps/guid-0a3987fc-bf72-4ae5-b4d0-974d17d01ee3/packages"
},
"space": {
"href": "/v2/spaces/da426b8e-3c4b-42fe-808e-217f733e1492"
}
}
}
]
}
Headers