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.eyJ1c2VyX2lkIjoidWFhLWlkLTE5NiIsImVtYWlsIjoiZW1haWwtMTE3QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mjk2NjQxNDB9.bE4vCpfwxFAqrYRWVtYM3lUGekNWsdbpauNa5hYwrL8" \
-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-3f340b4e-6fc8-4860-89ae-7ce974778bbd",
"name": "my_app3",
"desired_state": "STOPPED",
"total_desired_instances": 0,
"created_at": "1970-01-01T00:00:03Z",
"updated_at": null,
"environment_variables": {
"magic": "beautiful"
},
"_links": {
"self": {
"href": "/v3/apps/guid-3f340b4e-6fc8-4860-89ae-7ce974778bbd"
},
"processes": {
"href": "/v3/apps/guid-3f340b4e-6fc8-4860-89ae-7ce974778bbd/processes"
},
"packages": {
"href": "/v3/apps/guid-3f340b4e-6fc8-4860-89ae-7ce974778bbd/packages"
},
"space": {
"href": "/v2/spaces/ec4322a3-2d8f-4453-9692-2b4f48e4106d"
},
"start": {
"href": "/v3/apps/guid-3f340b4e-6fc8-4860-89ae-7ce974778bbd/start",
"method": "PUT"
},
"stop": {
"href": "/v3/apps/guid-3f340b4e-6fc8-4860-89ae-7ce974778bbd/stop",
"method": "PUT"
},
"assign_current_droplet": {
"href": "/v3/apps/guid-3f340b4e-6fc8-4860-89ae-7ce974778bbd/current_droplet",
"method": "PUT"
}
}
},
{
"guid": "guid-5b104dca-21b0-4b49-8905-2b0c05a90179",
"name": "my_app2",
"desired_state": "STOPPED",
"total_desired_instances": 0,
"created_at": "1970-01-01T00:00:02Z",
"updated_at": null,
"environment_variables": {
},
"_links": {
"self": {
"href": "/v3/apps/guid-5b104dca-21b0-4b49-8905-2b0c05a90179"
},
"processes": {
"href": "/v3/apps/guid-5b104dca-21b0-4b49-8905-2b0c05a90179/processes"
},
"packages": {
"href": "/v3/apps/guid-5b104dca-21b0-4b49-8905-2b0c05a90179/packages"
},
"space": {
"href": "/v2/spaces/ec4322a3-2d8f-4453-9692-2b4f48e4106d"
},
"start": {
"href": "/v3/apps/guid-5b104dca-21b0-4b49-8905-2b0c05a90179/start",
"method": "PUT"
},
"stop": {
"href": "/v3/apps/guid-5b104dca-21b0-4b49-8905-2b0c05a90179/stop",
"method": "PUT"
},
"assign_current_droplet": {
"href": "/v3/apps/guid-5b104dca-21b0-4b49-8905-2b0c05a90179/current_droplet",
"method": "PUT"
}
}
}
]
}
Headers