Home
Version 3
Apps (Experimental) API

Apps (Experimental) API

Filters apps by name and spaces and guids and orgs

GET /v3/apps

Request

Route

GET /v3/apps?names[]=my_app1&space_guids[]=7ff706f5-2fef-4319-942b-80b471df678e&space_guids[]=dd2a09d8-5750-49c4-a580-75d57944b064&space_guids[]=12d9952d-b31a-45d8-b015-5769d2590948&page=1&per_page=2&order_by=created_at&order_direction=desc

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
order_by Value to sort by
  • created_at, updated_at
order_direction Direction to sort by
  • asc, desc
names: ["my_app1"]
space_guids: ["7ff706f5-2fef-4319-942b-80b471df678e", "dd2a09d8-5750-49c4-a580-75d57944b064", "12d9952d-b31a-45d8-b015-5769d2590948"]
page: 1
per_page: 2
order_by: created_at
order_direction: desc

Body

Name Description Default Valid Values Example Values

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTExIiwiZW1haWwiOiJlbWFpbC0xMEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI2NjMzODk0fQ.jeoYT8U4CZgfF2eVfooDw8s44a-AC4j48wHiEszo9bM
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v3/apps?names[]=my_app1&space_guids[]=7ff706f5-2fef-4319-942b-80b471df678e&space_guids[]=dd2a09d8-5750-49c4-a580-75d57944b064&space_guids[]=12d9952d-b31a-45d8-b015-5769d2590948&page=1&per_page=2&order_by=created_at&order_direction=desc" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTExIiwiZW1haWwiOiJlbWFpbC0xMEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI2NjMzODk0fQ.jeoYT8U4CZgfF2eVfooDw8s44a-AC4j48wHiEszo9bM" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "pagination": {
    "total_results": 3,
    "first": {
      "href": "/v3/apps?names[]=my_app1&space_guids[]=7ff706f5-2fef-4319-942b-80b471df678e&space_guids[]=dd2a09d8-5750-49c4-a580-75d57944b064&space_guids[]=12d9952d-b31a-45d8-b015-5769d2590948&order_by=created_at&order_direction=desc&page=1&per_page=2"
    },
    "last": {
      "href": "/v3/apps?names[]=my_app1&space_guids[]=7ff706f5-2fef-4319-942b-80b471df678e&space_guids[]=dd2a09d8-5750-49c4-a580-75d57944b064&space_guids[]=12d9952d-b31a-45d8-b015-5769d2590948&order_by=created_at&order_direction=desc&page=2&per_page=2"
    },
    "next": {
      "href": "/v3/apps?names[]=my_app1&space_guids[]=7ff706f5-2fef-4319-942b-80b471df678e&space_guids[]=dd2a09d8-5750-49c4-a580-75d57944b064&space_guids[]=12d9952d-b31a-45d8-b015-5769d2590948&order_by=created_at&order_direction=desc&page=2&per_page=2"
    },
    "previous": null
  },
  "resources": [
    {
      "guid": "guid-782294bd-354e-4de9-8924-2423cd811a0f",
      "name": "my_app1",
      "_links": {
        "self": {
          "href": "/v3/apps/guid-782294bd-354e-4de9-8924-2423cd811a0f"
        },
        "processes": {
          "href": "/v3/apps/guid-782294bd-354e-4de9-8924-2423cd811a0f/processes"
        },
        "packages": {
          "href": "/v3/apps/guid-782294bd-354e-4de9-8924-2423cd811a0f/packages"
        },
        "space": {
          "href": "/v2/spaces/12d9952d-b31a-45d8-b015-5769d2590948"
        }
      }
    },
    {
      "guid": "guid-4faf778f-8d7f-4ef7-8f56-4605a21a5ea3",
      "name": "my_app1",
      "_links": {
        "self": {
          "href": "/v3/apps/guid-4faf778f-8d7f-4ef7-8f56-4605a21a5ea3"
        },
        "processes": {
          "href": "/v3/apps/guid-4faf778f-8d7f-4ef7-8f56-4605a21a5ea3/processes"
        },
        "packages": {
          "href": "/v3/apps/guid-4faf778f-8d7f-4ef7-8f56-4605a21a5ea3/packages"
        },
        "space": {
          "href": "/v2/spaces/7ff706f5-2fef-4319-942b-80b471df678e"
        }
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: b66dd8b9-cf07-44fc-912f-83c42d86bc2b
Content-Length: 2010
X-Content-Type-Options: nosniff