Routes API

List all Routes

GET /v2/routes

Request

Route

GET /v2/routes

Parameters

Name	Description	Valid Values	Example Values
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

Body

Name	Description	Default	Valid Values	Example Values

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTg1IiwiZW1haWwiOiJlbWFpbC04NEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDM1MTAyODUwfQ.NfMDcSV8y5clD721QTP4p11YYBYXwTU_Xnm2PEZ5NhE
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/routes" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTg1IiwiZW1haWwiOiJlbWFpbC04NEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDM1MTAyODUwfQ.NfMDcSV8y5clD721QTP4p11YYBYXwTU_Xnm2PEZ5NhE" \
	-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": "b911ab1d-fd21-407c-8292-0e0bea70c0b8",
        "url": "/v2/routes/b911ab1d-fd21-407c-8292-0e0bea70c0b8",
        "created_at": "2015-06-16T23:40:50Z",
        "updated_at": null
      },
      "entity": {
        "host": "host-16",
        "path": "",
        "domain_guid": "97b968e9-66ef-4652-bba6-55fd350465af",
        "space_guid": "337f1c4b-00ad-46bd-a975-fd0cedd4cdd8",
        "domain_url": "/v2/domains/97b968e9-66ef-4652-bba6-55fd350465af",
        "space_url": "/v2/spaces/337f1c4b-00ad-46bd-a975-fd0cedd4cdd8",
        "apps_url": "/v2/routes/b911ab1d-fd21-407c-8292-0e0bea70c0b8/apps"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 1945781d-1d35-4caf-aa83-20b5b5b9e342
Content-Length: 761
X-Content-Type-Options: nosniff