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[]=7d2283a4-adc7-46c7-a319-4ea245a7f20b&space_guids[]=d52c7af8-c489-4cd0-b6d3-cf8a552e76b3&space_guids[]=c5defb21-3411-48c0-8c82-9c04c685aaf0&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: ["7d2283a4-adc7-46c7-a319-4ea245a7f20b", "d52c7af8-c489-4cd0-b6d3-cf8a552e76b3", "c5defb21-3411-48c0-8c82-9c04c685aaf0"]
page: 1
per_page: 2
order_by: created_at
order_direction: desc

Body

Name Description Default Valid Values Example Values

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM3MCIsImVtYWlsIjoiZW1haWwtMjcyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjU5NDg2Nzl9.HcR8TxUCj07jis-fcmb3XTXBMmmacDMHaYqcwYA5bbY
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v3/apps?names[]=my_app1&space_guids[]=7d2283a4-adc7-46c7-a319-4ea245a7f20b&space_guids[]=d52c7af8-c489-4cd0-b6d3-cf8a552e76b3&space_guids[]=c5defb21-3411-48c0-8c82-9c04c685aaf0&page=1&per_page=2&order_by=created_at&order_direction=desc" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM3MCIsImVtYWlsIjoiZW1haWwtMjcyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjU5NDg2Nzl9.HcR8TxUCj07jis-fcmb3XTXBMmmacDMHaYqcwYA5bbY" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "pagination": {
    "total_results": 3,
    "first": {
      "href": "/v3/apps?names[]=my_app1&space_guids[]=7d2283a4-adc7-46c7-a319-4ea245a7f20b&space_guids[]=d52c7af8-c489-4cd0-b6d3-cf8a552e76b3&space_guids[]=c5defb21-3411-48c0-8c82-9c04c685aaf0&order_by=created_at&order_direction=desc&page=1&per_page=2"
    },
    "last": {
      "href": "/v3/apps?names[]=my_app1&space_guids[]=7d2283a4-adc7-46c7-a319-4ea245a7f20b&space_guids[]=d52c7af8-c489-4cd0-b6d3-cf8a552e76b3&space_guids[]=c5defb21-3411-48c0-8c82-9c04c685aaf0&order_by=created_at&order_direction=desc&page=2&per_page=2"
    },
    "next": {
      "href": "/v3/apps?names[]=my_app1&space_guids[]=7d2283a4-adc7-46c7-a319-4ea245a7f20b&space_guids[]=d52c7af8-c489-4cd0-b6d3-cf8a552e76b3&space_guids[]=c5defb21-3411-48c0-8c82-9c04c685aaf0&order_by=created_at&order_direction=desc&page=2&per_page=2"
    },
    "previous": null
  },
  "resources": [
    {
      "guid": "guid-6383689a-2afa-442c-92b0-5dbddc709e18",
      "name": "my_app1",
      "_links": {
        "self": {
          "href": "/v3/apps/guid-6383689a-2afa-442c-92b0-5dbddc709e18"
        },
        "processes": {
          "href": "/v3/apps/guid-6383689a-2afa-442c-92b0-5dbddc709e18/processes"
        },
        "packages": {
          "href": "/v3/apps/guid-6383689a-2afa-442c-92b0-5dbddc709e18/packages"
        },
        "space": {
          "href": "/v2/spaces/c5defb21-3411-48c0-8c82-9c04c685aaf0"
        }
      }
    },
    {
      "guid": "guid-17b231ae-5bc9-49ed-80f9-0b734ae0e3bb",
      "name": "my_app1",
      "_links": {
        "self": {
          "href": "/v3/apps/guid-17b231ae-5bc9-49ed-80f9-0b734ae0e3bb"
        },
        "processes": {
          "href": "/v3/apps/guid-17b231ae-5bc9-49ed-80f9-0b734ae0e3bb/processes"
        },
        "packages": {
          "href": "/v3/apps/guid-17b231ae-5bc9-49ed-80f9-0b734ae0e3bb/packages"
        },
        "space": {
          "href": "/v2/spaces/7d2283a4-adc7-46c7-a319-4ea245a7f20b"
        }
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: d11be896-22ee-48c5-97b8-7090a0d36600
Content-Length: 2010
X-Content-Type-Options: nosniff