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

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 79322e8b-b298-49ca-ace4-e0200f45406b
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-851ec0c0-7e60-4edf-8e2b-58cde690b1ab",
      "name": "my_app3",
      "_links": {
        "self": {
          "href": "/v3/apps/guid-851ec0c0-7e60-4edf-8e2b-58cde690b1ab"
        },
        "processes": {
          "href": "/v3/apps/guid-851ec0c0-7e60-4edf-8e2b-58cde690b1ab/processes"
        },
        "packages": {
          "href": "/v3/apps/guid-851ec0c0-7e60-4edf-8e2b-58cde690b1ab/packages"
        },
        "space": {
          "href": "/v2/spaces/877793cb-88cc-4fab-a6cb-3bb08052f297"
        }
      }
    },
    {
      "guid": "guid-e60b47f7-d617-4488-84ad-112a2197778a",
      "name": "my_app2",
      "_links": {
        "self": {
          "href": "/v3/apps/guid-e60b47f7-d617-4488-84ad-112a2197778a"
        },
        "processes": {
          "href": "/v3/apps/guid-e60b47f7-d617-4488-84ad-112a2197778a/processes"
        },
        "packages": {
          "href": "/v3/apps/guid-e60b47f7-d617-4488-84ad-112a2197778a/packages"
        },
        "space": {
          "href": "/v2/spaces/877793cb-88cc-4fab-a6cb-3bb08052f297"
        }
      }
    }
  ]
}