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.eyJ1c2VyX2lkIjoidWFhLWlkLTM4NSIsImVtYWlsIjoiZW1haWwtMjg3QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQ0NzE3MTB9.hjXfTjbKdps-pvdPGmM1ccRA6hiTzzgOnedEKGCgNso
Host: example.org
Cookie: 

Route

GET /v3/apps?names[]=my_app1&space_guids[]=f9bb0dc1-7bc6-4fc2-bf38-5163718ae488&space_guids[]=01e83236-8d51-45ba-bd84-f212b6b4375a&space_guids[]=d1ba3ad5-6943-4f5c-b016-fe0d31e414ce&page=1&per_page=2&sort=created_at&direction=desc

Query Parameters

names: ["my_app1"]
space_guids: ["f9bb0dc1-7bc6-4fc2-bf38-5163718ae488", "01e83236-8d51-45ba-bd84-f212b6b4375a", "d1ba3ad5-6943-4f5c-b016-fe0d31e414ce"]
page: 1
per_page: 2
sort: created_at
direction: desc

cURL

curl "https://api.[your-domain.com]/v3/apps?names[]=my_app1&space_guids[]=f9bb0dc1-7bc6-4fc2-bf38-5163718ae488&space_guids[]=01e83236-8d51-45ba-bd84-f212b6b4375a&space_guids[]=d1ba3ad5-6943-4f5c-b016-fe0d31e414ce&page=1&per_page=2&sort=created_at&direction=desc" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM4NSIsImVtYWlsIjoiZW1haWwtMjg3QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQ0NzE3MTB9.hjXfTjbKdps-pvdPGmM1ccRA6hiTzzgOnedEKGCgNso" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 319f4ee8-8cac-4bcf-9dd1-c7d1f044dbae
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[]=f9bb0dc1-7bc6-4fc2-bf38-5163718ae488&space_guids[]=01e83236-8d51-45ba-bd84-f212b6b4375a&space_guids[]=d1ba3ad5-6943-4f5c-b016-fe0d31e414ce&page=1&per_page=2"
    },
    "last": {
      "href": "/v3/apps?names[]=my_app1&space_guids[]=f9bb0dc1-7bc6-4fc2-bf38-5163718ae488&space_guids[]=01e83236-8d51-45ba-bd84-f212b6b4375a&space_guids[]=d1ba3ad5-6943-4f5c-b016-fe0d31e414ce&page=2&per_page=2"
    },
    "next": {
      "href": "/v3/apps?names[]=my_app1&space_guids[]=f9bb0dc1-7bc6-4fc2-bf38-5163718ae488&space_guids[]=01e83236-8d51-45ba-bd84-f212b6b4375a&space_guids[]=d1ba3ad5-6943-4f5c-b016-fe0d31e414ce&page=2&per_page=2"
    },
    "previous": null
  },
  "resources": [
    {
      "guid": "guid-708cda43-f998-4ea0-9cd0-709d0a89ab3b",
      "name": "my_app1",
      "_links": {
        "self": {
          "href": "/v3/apps/guid-708cda43-f998-4ea0-9cd0-709d0a89ab3b"
        },
        "processes": {
          "href": "/v3/apps/guid-708cda43-f998-4ea0-9cd0-709d0a89ab3b/processes"
        },
        "packages": {
          "href": "/v3/apps/guid-708cda43-f998-4ea0-9cd0-709d0a89ab3b/packages"
        },
        "space": {
          "href": "/v2/spaces/d1ba3ad5-6943-4f5c-b016-fe0d31e414ce"
        }
      }
    },
    {
      "guid": "guid-89662519-1aaa-4651-9fca-8478731ef9ee",
      "name": "my_app1",
      "_links": {
        "self": {
          "href": "/v3/apps/guid-89662519-1aaa-4651-9fca-8478731ef9ee"
        },
        "processes": {
          "href": "/v3/apps/guid-89662519-1aaa-4651-9fca-8478731ef9ee/processes"
        },
        "packages": {
          "href": "/v3/apps/guid-89662519-1aaa-4651-9fca-8478731ef9ee/packages"
        },
        "space": {
          "href": "/v2/spaces/f9bb0dc1-7bc6-4fc2-bf38-5163718ae488"
        }
      }
    }
  ]
}