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.eyJ1c2VyX2lkIjoidWFhLWlkLTY4IiwiZW1haWwiOiJlbWFpbC0zOUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI0MzEwMTIyfQ.K5-Ejh2_TrHeMRBvmyGa3AI35VZoSs4VAocpFSDJnBg
Host: example.org
Cookie: 

Route

GET /v3/apps?names[]=my_app1&space_guids[]=1b218f3b-ee99-4751-9363-e75eb9c87dac&space_guids[]=13ea0cae-cf06-4c45-8975-0b139ec5c7db&space_guids[]=055645bf-b728-4e87-8684-12dc27a52b9d&page=1&per_page=2&sort=created_at&direction=desc

Query Parameters

names: ["my_app1"]
space_guids: ["1b218f3b-ee99-4751-9363-e75eb9c87dac", "13ea0cae-cf06-4c45-8975-0b139ec5c7db", "055645bf-b728-4e87-8684-12dc27a52b9d"]
page: 1
per_page: 2
sort: created_at
direction: desc

cURL

curl "https://api.[your-domain.com]/v3/apps?names[]=my_app1&space_guids[]=1b218f3b-ee99-4751-9363-e75eb9c87dac&space_guids[]=13ea0cae-cf06-4c45-8975-0b139ec5c7db&space_guids[]=055645bf-b728-4e87-8684-12dc27a52b9d&page=1&per_page=2&sort=created_at&direction=desc" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTY4IiwiZW1haWwiOiJlbWFpbC0zOUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI0MzEwMTIyfQ.K5-Ejh2_TrHeMRBvmyGa3AI35VZoSs4VAocpFSDJnBg" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 3e1a4e9d-504a-45a2-b516-f1d3b6ab0937
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[]=1b218f3b-ee99-4751-9363-e75eb9c87dac&space_guids[]=13ea0cae-cf06-4c45-8975-0b139ec5c7db&space_guids[]=055645bf-b728-4e87-8684-12dc27a52b9d&page=1&per_page=2"
    },
    "last": {
      "href": "/v3/apps?names[]=my_app1&space_guids[]=1b218f3b-ee99-4751-9363-e75eb9c87dac&space_guids[]=13ea0cae-cf06-4c45-8975-0b139ec5c7db&space_guids[]=055645bf-b728-4e87-8684-12dc27a52b9d&page=2&per_page=2"
    },
    "next": {
      "href": "/v3/apps?names[]=my_app1&space_guids[]=1b218f3b-ee99-4751-9363-e75eb9c87dac&space_guids[]=13ea0cae-cf06-4c45-8975-0b139ec5c7db&space_guids[]=055645bf-b728-4e87-8684-12dc27a52b9d&page=2&per_page=2"
    },
    "previous": null
  },
  "resources": [
    {
      "guid": "guid-6aaf129e-5430-4887-8340-18a257920f0c",
      "name": "my_app1",
      "_links": {
        "self": {
          "href": "/v3/apps/guid-6aaf129e-5430-4887-8340-18a257920f0c"
        },
        "processes": {
          "href": "/v3/apps/guid-6aaf129e-5430-4887-8340-18a257920f0c/processes"
        },
        "packages": {
          "href": "/v3/apps/guid-6aaf129e-5430-4887-8340-18a257920f0c/packages"
        },
        "space": {
          "href": "/v2/spaces/055645bf-b728-4e87-8684-12dc27a52b9d"
        }
      }
    },
    {
      "guid": "guid-94e47ff8-6ef7-4ca9-b059-a3efc5e77638",
      "name": "my_app1",
      "_links": {
        "self": {
          "href": "/v3/apps/guid-94e47ff8-6ef7-4ca9-b059-a3efc5e77638"
        },
        "processes": {
          "href": "/v3/apps/guid-94e47ff8-6ef7-4ca9-b059-a3efc5e77638/processes"
        },
        "packages": {
          "href": "/v3/apps/guid-94e47ff8-6ef7-4ca9-b059-a3efc5e77638/packages"
        },
        "space": {
          "href": "/v2/spaces/1b218f3b-ee99-4751-9363-e75eb9c87dac"
        }
      }
    }
  ]
}