Home
Version 3
Apps API

Apps API

List all Routes for the App

GET /v2/apps/:guid/routes

Request

Route

GET /v2/apps/ae70e31e-9655-4c37-88c7-f7d2d7ce8346/routes?route_guid=455b794e-b357-4de5-aaf8-547b8ce07714

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: 455b794e-b357-4de5-aaf8-547b8ce07714

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTU2IiwiZW1haWwiOiJlbWFpbC01NkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDM5NDI2MTk1fQ.v4AKYYzl3Elp0ZGvJ7XSoqaiQaWOd-NS2tAFw90hfGg
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/apps/ae70e31e-9655-4c37-88c7-f7d2d7ce8346/routes?route_guid=455b794e-b357-4de5-aaf8-547b8ce07714" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTU2IiwiZW1haWwiOiJlbWFpbC01NkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDM5NDI2MTk1fQ.v4AKYYzl3Elp0ZGvJ7XSoqaiQaWOd-NS2tAFw90hfGg" \
	-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": "c2fa670a-0e98-4216-879e-82cccbf98488",
        "url": "/v2/routes/c2fa670a-0e98-4216-879e-82cccbf98488",
        "created_at": "2015-08-06T00:36:35Z",
        "updated_at": null
      },
      "entity": {
        "host": "host-1",
        "path": "",
        "domain_guid": "4795af4c-755f-407d-af14-523e74d10e3c",
        "space_guid": "d9e9a2cc-4d93-4d97-81f7-3fe94d19554a",
        "domain_url": "/v2/domains/4795af4c-755f-407d-af14-523e74d10e3c",
        "space_url": "/v2/spaces/d9e9a2cc-4d93-4d97-81f7-3fe94d19554a",
        "apps_url": "/v2/routes/c2fa670a-0e98-4216-879e-82cccbf98488/apps"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 7faa6838-3166-4ba4-8642-9114ad7e58d6
Content-Length: 760
X-Content-Type-Options: nosniff