Home
Version 3
Apps (Experimental) API

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.eyJ1c2VyX2lkIjoidWFhLWlkLTI1MCIsImVtYWlsIjoiZW1haWwtMTkxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjI5OTA4Nzh9.Nit43cqwH90Md1c6VoPbYRIsSW08FFNYBTgemIn3CFY
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.eyJ1c2VyX2lkIjoidWFhLWlkLTI1MCIsImVtYWlsIjoiZW1haWwtMTkxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjI5OTA4Nzh9.Nit43cqwH90Md1c6VoPbYRIsSW08FFNYBTgemIn3CFY" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 594bccd9-dc90-45e7-b110-d270858b2a46
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-bf5056e2-b07b-4f14-969b-64243d66cf3d",
      "name": "my_app1",
      "_links": {
        "self": {
          "href": "/v3/apps/guid-bf5056e2-b07b-4f14-969b-64243d66cf3d"
        },
        "processes": {
          "href": "/v3/apps/guid-bf5056e2-b07b-4f14-969b-64243d66cf3d/processes"
        },
        "packages": {
          "href": "/v3/apps/guid-bf5056e2-b07b-4f14-969b-64243d66cf3d/packages"
        },
        "space": {
          "href": "/v2/spaces/dc1200fa-2c5f-44f5-80b4-28563793b01d"
        }
      }
    },
    {
      "guid": "guid-cbceeb1a-abc9-4276-aeed-8998e65e8b1d",
      "name": "my_app2",
      "_links": {
        "self": {
          "href": "/v3/apps/guid-cbceeb1a-abc9-4276-aeed-8998e65e8b1d"
        },
        "processes": {
          "href": "/v3/apps/guid-cbceeb1a-abc9-4276-aeed-8998e65e8b1d/processes"
        },
        "packages": {
          "href": "/v3/apps/guid-cbceeb1a-abc9-4276-aeed-8998e65e8b1d/packages"
        },
        "space": {
          "href": "/v2/spaces/dc1200fa-2c5f-44f5-80b4-28563793b01d"
        }
      }
    }
  ]
}