List all Apps
GET /v3/apps
Request
Route
GET /v3/apps?page=1&per_page=2&order_by=-created_at
Parameters
| Name |
Description |
Valid Values |
Example Values |
|
names
|
Names of apps to filter by
|
|
|
|
space_guids
|
Spaces to filter by
|
|
- space_guids=space_guid1,space_guid2
|
|
organization_guids
|
Organizations to filter by
|
|
- organization_guids=org_guid1,org_guid2
|
|
guids
|
App guids to filter by
|
|
|
|
page
|
Page to display
|
|
|
|
per_page
|
Number of results per page
|
|
|
|
order_by
|
Value to sort by. Prepend with "+" or "-" to change sort direction to ascending or descending, respectively.
|
|
|
page: 1
per_page: 2
order_by: -created_at
Headers
cURL
curl "https://api.[your-domain.com]/v3/apps?page=1&per_page=2&order_by=-created_at" -X GET \
-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEiLCJlbWFpbCI6ImVtYWlsLTFAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLnJlYWQiLCJjbG91ZF9jb250cm9sbGVyLndyaXRlIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ0NzExNjgyM30.VYGkffwRv5kqBJpdjrGrBI5kU1zN-Wof41uJszQLvJI" \
-H "Host: example.org" \
-H "Cookie: "
Response
Status
200 OK
Body
{
"pagination": {
"total_results": 3,
"first": {
"href": "/v3/apps?order_by=-created_at&page=1&per_page=2"
},
"last": {
"href": "/v3/apps?order_by=-created_at&page=2&per_page=2"
},
"next": {
"href": "/v3/apps?order_by=-created_at&page=2&per_page=2"
},
"previous": null
},
"resources": [
{
"guid": "guid-ace25895-ed26-4db6-b4bb-5635bb24f00b",
"name": "my_app3",
"desired_state": "STOPPED",
"total_desired_instances": 0,
"created_at": "1970-01-01T00:00:03Z",
"updated_at": null,
"lifecycle": {
"type": "buildpack",
"data": {
"buildpack": "name-12",
"stack": "name-13"
}
},
"environment_variables": {
"magic": "beautiful"
},
"links": {
"self": {
"href": "/v3/apps/guid-ace25895-ed26-4db6-b4bb-5635bb24f00b"
},
"space": {
"href": "/v2/spaces/e6435ba7-55df-491f-a06e-b5e84175f75c"
},
"processes": {
"href": "/v3/apps/guid-ace25895-ed26-4db6-b4bb-5635bb24f00b/processes"
},
"routes": {
"href": "/v3/apps/guid-ace25895-ed26-4db6-b4bb-5635bb24f00b/routes"
},
"packages": {
"href": "/v3/apps/guid-ace25895-ed26-4db6-b4bb-5635bb24f00b/packages"
},
"droplets": {
"href": "/v3/apps/guid-ace25895-ed26-4db6-b4bb-5635bb24f00b/droplets"
},
"start": {
"href": "/v3/apps/guid-ace25895-ed26-4db6-b4bb-5635bb24f00b/start",
"method": "PUT"
},
"stop": {
"href": "/v3/apps/guid-ace25895-ed26-4db6-b4bb-5635bb24f00b/stop",
"method": "PUT"
},
"assign_current_droplet": {
"href": "/v3/apps/guid-ace25895-ed26-4db6-b4bb-5635bb24f00b/current_droplet",
"method": "PUT"
}
}
},
{
"guid": "guid-64c76abe-9c7e-450f-bb67-4d257e3c6d44",
"name": "my_app2",
"desired_state": "STOPPED",
"total_desired_instances": 0,
"created_at": "1970-01-01T00:00:02Z",
"updated_at": null,
"lifecycle": {
"type": "buildpack",
"data": {
"buildpack": "name-10",
"stack": "name-11"
}
},
"environment_variables": {
},
"links": {
"self": {
"href": "/v3/apps/guid-64c76abe-9c7e-450f-bb67-4d257e3c6d44"
},
"space": {
"href": "/v2/spaces/e6435ba7-55df-491f-a06e-b5e84175f75c"
},
"processes": {
"href": "/v3/apps/guid-64c76abe-9c7e-450f-bb67-4d257e3c6d44/processes"
},
"routes": {
"href": "/v3/apps/guid-64c76abe-9c7e-450f-bb67-4d257e3c6d44/routes"
},
"packages": {
"href": "/v3/apps/guid-64c76abe-9c7e-450f-bb67-4d257e3c6d44/packages"
},
"droplets": {
"href": "/v3/apps/guid-64c76abe-9c7e-450f-bb67-4d257e3c6d44/droplets"
},
"start": {
"href": "/v3/apps/guid-64c76abe-9c7e-450f-bb67-4d257e3c6d44/start",
"method": "PUT"
},
"stop": {
"href": "/v3/apps/guid-64c76abe-9c7e-450f-bb67-4d257e3c6d44/stop",
"method": "PUT"
},
"assign_current_droplet": {
"href": "/v3/apps/guid-64c76abe-9c7e-450f-bb67-4d257e3c6d44/current_droplet",
"method": "PUT"
}
}
}
]
}
Headers