Home
Version 3
Apps (Experimental) API

Apps (Experimental) API

Filters apps by name and spaces and guids and orgs

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.eyJ1c2VyX2lkIjoidWFhLWlkLTE4MyIsImVtYWlsIjoiZW1haWwtMTM0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQxMzczNjh9.luuVT8sYbDp14spmFGkqtZX7cpaGyDD5aQkq_6ugB0s
Host: example.org
Cookie: 

Route

GET /v3/apps?names[]=my_app1&space_guids[]=62fd5380-8f80-4878-ba21-c5efb3b13561&space_guids[]=47357d42-ca01-43ea-9562-bd5bce34a31b&space_guids[]=9971a606-7e91-4453-bbfe-6e2bcd0acef9&page=1&per_page=2&sort=created_at&direction=desc

Query Parameters

names: ["my_app1"]
space_guids: ["62fd5380-8f80-4878-ba21-c5efb3b13561", "47357d42-ca01-43ea-9562-bd5bce34a31b", "9971a606-7e91-4453-bbfe-6e2bcd0acef9"]
page: 1
per_page: 2
sort: created_at
direction: desc

cURL

curl "https://api.[your-domain.com]/v3/apps?names[]=my_app1&space_guids[]=62fd5380-8f80-4878-ba21-c5efb3b13561&space_guids[]=47357d42-ca01-43ea-9562-bd5bce34a31b&space_guids[]=9971a606-7e91-4453-bbfe-6e2bcd0acef9&page=1&per_page=2&sort=created_at&direction=desc" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE4MyIsImVtYWlsIjoiZW1haWwtMTM0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQxMzczNjh9.luuVT8sYbDp14spmFGkqtZX7cpaGyDD5aQkq_6ugB0s" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 713716b2-35e0-4971-aeae-4929ec4840d9
Content-Length: 1887
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "pagination": {
    "total_results": 3,
    "first": {
      "href": "/v3/apps?names[]=my_app1&space_guids[]=62fd5380-8f80-4878-ba21-c5efb3b13561&space_guids[]=47357d42-ca01-43ea-9562-bd5bce34a31b&space_guids[]=9971a606-7e91-4453-bbfe-6e2bcd0acef9&page=1&per_page=2"
    },
    "last": {
      "href": "/v3/apps?names[]=my_app1&space_guids[]=62fd5380-8f80-4878-ba21-c5efb3b13561&space_guids[]=47357d42-ca01-43ea-9562-bd5bce34a31b&space_guids[]=9971a606-7e91-4453-bbfe-6e2bcd0acef9&page=2&per_page=2"
    },
    "next": {
      "href": "/v3/apps?names[]=my_app1&space_guids[]=62fd5380-8f80-4878-ba21-c5efb3b13561&space_guids[]=47357d42-ca01-43ea-9562-bd5bce34a31b&space_guids[]=9971a606-7e91-4453-bbfe-6e2bcd0acef9&page=2&per_page=2"
    },
    "previous": null
  },
  "resources": [
    {
      "guid": "guid-12e2ce6e-8848-4186-8993-993a39e65f56",
      "name": "my_app1",
      "_links": {
        "self": {
          "href": "/v3/apps/guid-12e2ce6e-8848-4186-8993-993a39e65f56"
        },
        "processes": {
          "href": "/v3/apps/guid-12e2ce6e-8848-4186-8993-993a39e65f56/processes"
        },
        "packages": {
          "href": "/v3/apps/guid-12e2ce6e-8848-4186-8993-993a39e65f56/packages"
        },
        "space": {
          "href": "/v2/spaces/9971a606-7e91-4453-bbfe-6e2bcd0acef9"
        }
      }
    },
    {
      "guid": "guid-a78457ba-940c-4e58-8068-caaccfaffd5e",
      "name": "my_app1",
      "_links": {
        "self": {
          "href": "/v3/apps/guid-a78457ba-940c-4e58-8068-caaccfaffd5e"
        },
        "processes": {
          "href": "/v3/apps/guid-a78457ba-940c-4e58-8068-caaccfaffd5e/processes"
        },
        "packages": {
          "href": "/v3/apps/guid-a78457ba-940c-4e58-8068-caaccfaffd5e/packages"
        },
        "space": {
          "href": "/v2/spaces/62fd5380-8f80-4878-ba21-c5efb3b13561"
        }
      }
    }
  ]
}