Apps (Experimental) API

List all Apps

GET /v3/apps

Fields

Name	Description	Default	Valid Values	Example Values

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
sort	Value to sort by	created_at, updated_at, id
direction	Direction to sort by	asc, desc

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE4MiIsImVtYWlsIjoiZW1haWwtMTMzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQxMzczNjh9.KXhdXakNwNTUJjpmhN7c2_JS4ThKgRx9hhFsA-QZXaw
Host: example.org
Cookie: 

Route

GET /v3/apps?page=1&per_page=2&sort=created_at&direction=desc

Query Parameters

page: 1
per_page: 2
sort: created_at
direction: desc

cURL

curl "https://api.[your-domain.com]/v3/apps?page=1&per_page=2&sort=created_at&direction=desc" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE4MiIsImVtYWlsIjoiZW1haWwtMTMzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQxMzczNjh9.KXhdXakNwNTUJjpmhN7c2_JS4ThKgRx9hhFsA-QZXaw" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: bc4269ac-dc21-423c-a9e4-d7cb9e625880
Content-Length: 1380
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-e0601784-7904-4eff-9918-a66af13763e5",
      "name": "my_app3",
      "_links": {
        "self": {
          "href": "/v3/apps/guid-e0601784-7904-4eff-9918-a66af13763e5"
        },
        "processes": {
          "href": "/v3/apps/guid-e0601784-7904-4eff-9918-a66af13763e5/processes"
        },
        "packages": {
          "href": "/v3/apps/guid-e0601784-7904-4eff-9918-a66af13763e5/packages"
        },
        "space": {
          "href": "/v2/spaces/0f17c3c3-3781-47ec-9aad-da27aee9cc9a"
        }
      }
    },
    {
      "guid": "guid-b89e71e6-d21b-4e88-ae62-6c238f6a758b",
      "name": "my_app2",
      "_links": {
        "self": {
          "href": "/v3/apps/guid-b89e71e6-d21b-4e88-ae62-6c238f6a758b"
        },
        "processes": {
          "href": "/v3/apps/guid-b89e71e6-d21b-4e88-ae62-6c238f6a758b/processes"
        },
        "packages": {
          "href": "/v3/apps/guid-b89e71e6-d21b-4e88-ae62-6c238f6a758b/packages"
        },
        "space": {
          "href": "/v2/spaces/0f17c3c3-3781-47ec-9aad-da27aee9cc9a"
        }
      }
    }
  ]
}