Home
Version 3
Apps API

Apps API

List all Routes for the App

GET /v2/apps/:guid/routes

Request

Route

GET /v2/apps/0f80bd0b-b7f4-4392-8037-8bed6ddf875c/routes?route_guid=30f152f9-5514-46ff-b878-395e1f6f271e

Parameters

Name Description Valid Values Example Values
guid The guid of the App
route_guid The guid of the route
q Parameters used to filter the result set.
Format queries as <filter><op><value>
Valid ops: : >= <= < > IN
Valid filters: host, domain_guid, organization_guid, path
  • 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
route_guid: 30f152f9-5514-46ff-b878-395e1f6f271e

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE0NSIsImVtYWlsIjoiZW1haWwtOTFAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ0MTY2MjYwMH0.mr5AbolfbhVHRaKYslcKynm25E1-U2lgK2bZTmKQBVA
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/apps/0f80bd0b-b7f4-4392-8037-8bed6ddf875c/routes?route_guid=30f152f9-5514-46ff-b878-395e1f6f271e" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE0NSIsImVtYWlsIjoiZW1haWwtOTFAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ0MTY2MjYwMH0.mr5AbolfbhVHRaKYslcKynm25E1-U2lgK2bZTmKQBVA" \
	-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": "21793784-21c9-4d6c-a647-4e28f79153fb",
        "url": "/v2/routes/21793784-21c9-4d6c-a647-4e28f79153fb",
        "created_at": "2015-08-31T21:50:00Z",
        "updated_at": null
      },
      "entity": {
        "host": "host-10",
        "path": "",
        "domain_guid": "3e87e71f-163d-4b46-81d6-87bfabedbfa9",
        "space_guid": "056037d5-0421-4ea1-b138-17fea9569871",
        "service_instance_guid": null,
        "domain_url": "/v2/domains/3e87e71f-163d-4b46-81d6-87bfabedbfa9",
        "space_url": "/v2/spaces/056037d5-0421-4ea1-b138-17fea9569871",
        "apps_url": "/v2/routes/21793784-21c9-4d6c-a647-4e28f79153fb/apps"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: fbc88224-602d-46f8-9ae6-39608fe842e3
Content-Length: 800
X-Content-Type-Options: nosniff