Routes API

List all Routes

GET /v2/routes

Request

Route

GET /v2/routes

Parameters

Name	Description	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

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI0OSIsImVtYWlsIjoiZW1haWwtMTgyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDI2MDE1Mzl9.IcKp0tldG7CMhQHosehh0-A48HKM8euo53UZMYJaxGw
Host: example.org
Cookie:

cURL

curl "https://api.[your-domain.com]/v2/routes" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI0OSIsImVtYWlsIjoiZW1haWwtMTgyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDI2MDE1Mzl9.IcKp0tldG7CMhQHosehh0-A48HKM8euo53UZMYJaxGw" \
	-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": "554832b0-1753-4c9f-96b5-8ef4f7eb0915",
        "url": "/v2/routes/554832b0-1753-4c9f-96b5-8ef4f7eb0915",
        "created_at": "2015-09-11T18:38:59Z",
        "updated_at": null
      },
      "entity": {
        "host": "host-13",
        "path": "",
        "domain_guid": "1039bf60-15ba-485b-87a9-98f668e087f6",
        "space_guid": "f78aabf3-f9fc-479f-930c-f296f356e953",
        "service_instance_guid": "6780c5a0-40b0-4d9f-9ba8-449608d80a1e",
        "domain_url": "/v2/domains/1039bf60-15ba-485b-87a9-98f668e087f6",
        "space_url": "/v2/spaces/f78aabf3-f9fc-479f-930c-f296f356e953",
        "service_instance_url": "/v2/service_instances/6780c5a0-40b0-4d9f-9ba8-449608d80a1e",
        "apps_url": "/v2/routes/554832b0-1753-4c9f-96b5-8ef4f7eb0915/apps"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 81b9b9e9-95dc-4650-a738-30dc7023f011
Content-Length: 928
X-Content-Type-Options: nosniff