Home
Version 3
Apps API

Apps API

List all Routes for the App

GET /v2/apps/:guid/routes

Request

Route

GET /v2/apps/188a5ddd-8872-47e2-b82c-23b8214d5a48/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, 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

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTYzIiwiZW1haWwiOiJlbWFpbC02MkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDU2NDUyMjI1fQ.Y0WAHKp-BMwIvUy7ydEFcALRab-VjjsXn7UGm9UarAk
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/apps/188a5ddd-8872-47e2-b82c-23b8214d5a48/routes" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTYzIiwiZW1haWwiOiJlbWFpbC02MkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDU2NDUyMjI1fQ.Y0WAHKp-BMwIvUy7ydEFcALRab-VjjsXn7UGm9UarAk" \
	-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": "75ed1c00-8d81-4c6c-bcfa-c2bbf306c7c9",
        "url": "/v2/routes/75ed1c00-8d81-4c6c-bcfa-c2bbf306c7c9",
        "created_at": "2016-02-19T02:03:45Z",
        "updated_at": null
      },
      "entity": {
        "host": "host-5",
        "path": "",
        "domain_guid": "d692c556-92fe-460f-b113-6ede19ffa3bd",
        "space_guid": "0804fbb0-9da9-41fe-87de-589598058e72",
        "service_instance_guid": null,
        "port": 0,
        "domain_url": "/v2/domains/d692c556-92fe-460f-b113-6ede19ffa3bd",
        "space_url": "/v2/spaces/0804fbb0-9da9-41fe-87de-589598058e72",
        "apps_url": "/v2/routes/75ed1c00-8d81-4c6c-bcfa-c2bbf306c7c9/apps"
      }
    }
  ]
}

Headers

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