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.eyJ1c2VyX2lkIjoidWFhLWlkLTI2NyIsImVtYWlsIjoiZW1haWwtMTcxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDU1NTc5NTR9.lcT1oP5UKX8pam1VCVRiAGmGjYcgNZO8iaGymjBvNI4" \
-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-48a21069-6e43-4304-90a5-57db76ee6abd",
"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-1904"
}
},
"environment_variables": {
"magic": "beautiful"
},
"links": {
"self": {
"href": "/v3/apps/guid-48a21069-6e43-4304-90a5-57db76ee6abd"
},
"space": {
"href": "/v2/spaces/87206c01-3864-4e62-bae4-437256f3e17c"
},
"processes": {
"href": "/v3/apps/guid-48a21069-6e43-4304-90a5-57db76ee6abd/processes"
},
"routes": {
"href": "/v3/apps/guid-48a21069-6e43-4304-90a5-57db76ee6abd/routes"
},
"packages": {
"href": "/v3/apps/guid-48a21069-6e43-4304-90a5-57db76ee6abd/packages"
},
"droplets": {
"href": "/v3/apps/guid-48a21069-6e43-4304-90a5-57db76ee6abd/droplets"
},
"start": {
"href": "/v3/apps/guid-48a21069-6e43-4304-90a5-57db76ee6abd/start",
"method": "PUT"
},
"stop": {
"href": "/v3/apps/guid-48a21069-6e43-4304-90a5-57db76ee6abd/stop",
"method": "PUT"
},
"assign_current_droplet": {
"href": "/v3/apps/guid-48a21069-6e43-4304-90a5-57db76ee6abd/current_droplet",
"method": "PUT"
}
}
},
{
"guid": "guid-a8552dc4-84fc-4b75-9eec-51b7d11d5487",
"name": "my_app2",
"desired_state": "STOPPED",
"total_desired_instances": 0,
"created_at": "1970-01-01T00:00:02Z",
"updated_at": null,
"lifecycle": null,
"environment_variables": {
},
"links": {
"self": {
"href": "/v3/apps/guid-a8552dc4-84fc-4b75-9eec-51b7d11d5487"
},
"space": {
"href": "/v2/spaces/87206c01-3864-4e62-bae4-437256f3e17c"
},
"processes": {
"href": "/v3/apps/guid-a8552dc4-84fc-4b75-9eec-51b7d11d5487/processes"
},
"routes": {
"href": "/v3/apps/guid-a8552dc4-84fc-4b75-9eec-51b7d11d5487/routes"
},
"packages": {
"href": "/v3/apps/guid-a8552dc4-84fc-4b75-9eec-51b7d11d5487/packages"
},
"droplets": {
"href": "/v3/apps/guid-a8552dc4-84fc-4b75-9eec-51b7d11d5487/droplets"
},
"start": {
"href": "/v3/apps/guid-a8552dc4-84fc-4b75-9eec-51b7d11d5487/start",
"method": "PUT"
},
"stop": {
"href": "/v3/apps/guid-a8552dc4-84fc-4b75-9eec-51b7d11d5487/stop",
"method": "PUT"
},
"assign_current_droplet": {
"href": "/v3/apps/guid-a8552dc4-84fc-4b75-9eec-51b7d11d5487/current_droplet",
"method": "PUT"
}
}
}
]
}
Headers