Apps (Experimental) API

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	array of strings	names[]=name1&names[]=name2
space_guids	Spaces to filter by	array of strings	space_guids[]=space_guid1&space_guids[]=space_guid2
organization_guids	Organizations to filter by	array of strings	organization_guids[]=org_guid1&organization_guids[]=org_guid2
guids	App guids to filter by	array of strings	guid[]=guid1&guid[]=guid2
page	Page to display	>= 1
per_page	Number of results per page	1 - 5000
order_by	Value to sort by	created_at, updated_at
order_direction	Direction to sort by	asc, desc

page: 1
per_page: 2
order_by: created_at
order_direction: desc

Body

Name	Description	Default	Valid Values	Example Values

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM2OSIsImVtYWlsIjoiZW1haWwtMjcxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjU5NDg2Nzl9._O0LVjB6eB3Qas7F1UTRgDlIvRQMrOkBlZh8oCDs43g
Host: example.org
Cookie: 

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.eyJ1c2VyX2lkIjoidWFhLWlkLTM2OSIsImVtYWlsIjoiZW1haWwtMjcxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjU5NDg2Nzl9._O0LVjB6eB3Qas7F1UTRgDlIvRQMrOkBlZh8oCDs43g" \
	-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-2813f99d-0ad0-4e12-aeaf-f31d5502fcc6",
      "name": "my_app3",
      "_links": {
        "self": {
          "href": "/v3/apps/guid-2813f99d-0ad0-4e12-aeaf-f31d5502fcc6"
        },
        "processes": {
          "href": "/v3/apps/guid-2813f99d-0ad0-4e12-aeaf-f31d5502fcc6/processes"
        },
        "packages": {
          "href": "/v3/apps/guid-2813f99d-0ad0-4e12-aeaf-f31d5502fcc6/packages"
        },
        "space": {
          "href": "/v2/spaces/b398888f-47d4-4526-be60-464ea7717deb"
        }
      }
    },
    {
      "guid": "guid-8fddb442-39a5-4490-be2e-bffa82a2bae6",
      "name": "my_app2",
      "_links": {
        "self": {
          "href": "/v3/apps/guid-8fddb442-39a5-4490-be2e-bffa82a2bae6"
        },
        "processes": {
          "href": "/v3/apps/guid-8fddb442-39a5-4490-be2e-bffa82a2bae6/processes"
        },
        "packages": {
          "href": "/v3/apps/guid-8fddb442-39a5-4490-be2e-bffa82a2bae6/packages"
        },
        "space": {
          "href": "/v2/spaces/b398888f-47d4-4526-be60-464ea7717deb"
        }
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: eb9fc87c-1aaf-4019-9478-3133ba0c7508
Content-Length: 1503
X-Content-Type-Options: nosniff