Apps (Experimental) API

List all Apps

GET /v3/apps

Fields

Name	Description	Default	Valid Values	Example Values

Parameters

Name	Description	Valid Values	Example Values
page	Page to display	>= 1
per_page	Number of results per page	1-5000

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTYyIiwiZW1haWwiOiJlbWFpbC0zMkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIucmVhZCIsImNsb3VkX2NvbnRyb2xsZXIud3JpdGUiXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDIyMzIzNTMwfQ.OAiBNjOlGEE9jQKReUxAYZnkdzCXZpy4R_XZL327y88
Host: example.org
Cookie: 

Route

GET /v3/apps?page=1&per_page=2

Query Parameters

page: 1
per_page: 2

cURL

curl "https://api.[your-domain.com]/v3/apps?page=1&per_page=2" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTYyIiwiZW1haWwiOiJlbWFpbC0zMkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIucmVhZCIsImNsb3VkX2NvbnRyb2xsZXIud3JpdGUiXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDIyMzIzNTMwfQ.OAiBNjOlGEE9jQKReUxAYZnkdzCXZpy4R_XZL327y88" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: e72f533e-a7fc-4776-9d67-24bab2084b86
Content-Length: 1154
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "pagination": {
    "total_results": 3,
    "first": {
      "href": "/v3/apps?page=1&per_page=2"
    },
    "last": {
      "href": "/v3/apps?page=2&per_page=2"
    },
    "next": {
      "href": "/v3/apps?page=2&per_page=2"
    },
    "previous": null
  },
  "resources": [
    {
      "guid": "guid-89df5d86-63d0-4e7e-88c2-904436917345",
      "name": "my_app1",
      "_links": {
        "self": {
          "href": "/v3/apps/guid-89df5d86-63d0-4e7e-88c2-904436917345"
        },
        "processes": {
          "href": "/v3/apps/guid-89df5d86-63d0-4e7e-88c2-904436917345/processes"
        },
        "space": {
          "href": "/v2/spaces/07c1ad00-6433-4aac-be2a-a0848373fa25"
        }
      }
    },
    {
      "guid": "guid-ed8738ee-5545-497b-a835-cc46807b2c8d",
      "name": "my_app2",
      "_links": {
        "self": {
          "href": "/v3/apps/guid-ed8738ee-5545-497b-a835-cc46807b2c8d"
        },
        "processes": {
          "href": "/v3/apps/guid-ed8738ee-5545-497b-a835-cc46807b2c8d/processes"
        },
        "space": {
          "href": "/v2/spaces/07c1ad00-6433-4aac-be2a-a0848373fa25"
        }
      }
    }
  ]
}