Home
Version 3
Apps API

Apps API

List all Routes for the App

GET /v2/apps/:guid/routes

Request

Route

GET /v2/apps/12f03088-dbf5-4dcc-96f5-df0177440083/routes?route_guid=c7796946-b332-4366-9f1f-d9e31936390f

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, port
  • 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: c7796946-b332-4366-9f1f-d9e31936390f

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTg5IiwiZW1haWwiOiJlbWFpbC01NkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDQ5NTMxNTExfQ.4FB8KFqhsMZ4rECDVtdDoKiFT-j-vXcI6AxAR1E4ntk
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/apps/12f03088-dbf5-4dcc-96f5-df0177440083/routes?route_guid=c7796946-b332-4366-9f1f-d9e31936390f" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTg5IiwiZW1haWwiOiJlbWFpbC01NkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDQ5NTMxNTExfQ.4FB8KFqhsMZ4rECDVtdDoKiFT-j-vXcI6AxAR1E4ntk" \
	-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": "02fd9886-0869-4fad-a204-dc17e28fbb75",
        "url": "/v2/routes/02fd9886-0869-4fad-a204-dc17e28fbb75",
        "created_at": "2015-11-30T23:38:31Z",
        "updated_at": null
      },
      "entity": {
        "host": "host-7",
        "path": "",
        "domain_guid": "c2071cc4-3422-46da-883c-8dfb4e93f52c",
        "space_guid": "2a4d7354-18d6-40c4-93aa-a9cf51e37598",
        "service_instance_guid": null,
        "port": 0,
        "domain_url": "/v2/domains/c2071cc4-3422-46da-883c-8dfb4e93f52c",
        "space_url": "/v2/spaces/2a4d7354-18d6-40c4-93aa-a9cf51e37598",
        "apps_url": "/v2/routes/02fd9886-0869-4fad-a204-dc17e28fbb75/apps"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 
Content-Length: 818
X-Content-Type-Options: nosniff