Home
Version 3
Apps API

Apps API

List all Routes for the App

GET /v2/apps/:guid/routes

Request

Route

GET /v2/apps/2bc72fce-c818-4468-81ad-35b88f51c08f/routes

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, organization_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

Body

Name Description Default Valid Values Example Values

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEyOSIsImVtYWlsIjoiZW1haWwtOTFAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyNzMyMzk2Mn0.7PNzyT0By0-W2sZRU2TwcP0KshS1yGHUODGC4u7Pb94
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/apps/2bc72fce-c818-4468-81ad-35b88f51c08f/routes" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEyOSIsImVtYWlsIjoiZW1haWwtOTFAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyNzMyMzk2Mn0.7PNzyT0By0-W2sZRU2TwcP0KshS1yGHUODGC4u7Pb94" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "35d7421c-eb3c-46f4-b142-8f19ea52f382",
        "url": "/v2/routes/35d7421c-eb3c-46f4-b142-8f19ea52f382",
        "created_at": "2015-03-18T22:52:42Z",
        "updated_at": null
      },
      "entity": {
        "host": "host-12",
        "domain_guid": "71fe25b7-26bd-4658-888e-4355b4698da7",
        "space_guid": "a64026c5-f314-4576-86d8-b8f8dab67da7",
        "domain_url": "/v2/domains/71fe25b7-26bd-4658-888e-4355b4698da7",
        "space_url": "/v2/spaces/a64026c5-f314-4576-86d8-b8f8dab67da7",
        "apps_url": "/v2/routes/35d7421c-eb3c-46f4-b142-8f19ea52f382/apps"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 96f1abac-06e6-4d64-964e-b86a6d9c5bd1
Content-Length: 741
X-Content-Type-Options: nosniff