Home
Version 3
Apps API

Apps API

List all Routes for the App

GET /v2/apps/:guid/routes

Fields

Name Description Default Valid Values Example Values

Parameters

Name Description Valid Values Example Values
guid The guid of the App
q Parameters used to filter the result set.
Format queries as <filter><op><value>
Valid ops: : >= <= < > IN
Valid filters: host, domain_guid
  • q=filter:value
  • q=filter>value
  • q=filter IN a,b,c
page Page of results to fetch
results-per-page Number of results per page
order-direction Order of the results: asc (default) or desc
inline-relations-depth 0 - don't inline any relations and return URLs. Otherwise, inline to depth N.
orphan-relations 0 - de-duplicate object entries in response
exclude-relations comma-delimited list of relations to drop from response
include-relations comma-delimited list of the only relations to include in response

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE0OCIsImVtYWlsIjoiZW1haWwtMTAwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTk5ODk5Njh9.gHHqlHQ16H-0rQMBoXIS0IzIowSW31eKva2qhsCyhpE
Host: example.org
Cookie: 

Route

GET /v2/apps/31bc80f2-079e-4d07-a4fb-28b22dd31cab/routes

cURL

curl "https://api.[your-domain.com]/v2/apps/31bc80f2-079e-4d07-a4fb-28b22dd31cab/routes" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE0OCIsImVtYWlsIjoiZW1haWwtMTAwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTk5ODk5Njh9.gHHqlHQ16H-0rQMBoXIS0IzIowSW31eKva2qhsCyhpE" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 65d08295-41f5-485f-bf97-735d63427bd0
Content-Length: 745
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "1e294004-e000-426a-a6d6-90d8cedf346e",
        "url": "/v2/routes/1e294004-e000-426a-a6d6-90d8cedf346e",
        "created_at": "2014-12-24T01:39:28+00:00",
        "updated_at": null
      },
      "entity": {
        "host": "host-3",
        "domain_guid": "583c348c-eede-4a64-9a83-f569fd22f7d2",
        "space_guid": "b2cee844-d073-469e-99a5-63c5ae1faf17",
        "domain_url": "/v2/domains/583c348c-eede-4a64-9a83-f569fd22f7d2",
        "space_url": "/v2/spaces/b2cee844-d073-469e-99a5-63c5ae1faf17",
        "apps_url": "/v2/routes/1e294004-e000-426a-a6d6-90d8cedf346e/apps"
      }
    }
  ]
}