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, 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.eyJ1c2VyX2lkIjoidWFhLWlkLTIzNCIsImVtYWlsIjoiZW1haWwtMTcwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTM4MzcyNzN9.222OZtQegQFKTgdFr-ARQKFHH7taTQlnc47HRJo7L5Y
Host: example.org
Cookie:

cURL

curl "https://api.[your-domain.com]/v2/routes" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIzNCIsImVtYWlsIjoiZW1haWwtMTcwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTM4MzcyNzN9.222OZtQegQFKTgdFr-ARQKFHH7taTQlnc47HRJo7L5Y" \
	-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": "f7f8cdfe-0a20-48dd-adb5-568aea68676f",
        "url": "/v2/routes/f7f8cdfe-0a20-48dd-adb5-568aea68676f",
        "created_at": "2016-01-19T19:41:13Z",
        "updated_at": null
      },
      "entity": {
        "host": "host-15",
        "path": "",
        "domain_guid": "9e6cf76b-e04b-4acc-8bc7-bfd722211ffa",
        "space_guid": "accef12c-13b9-4616-b995-73b0776cdbd2",
        "service_instance_guid": "b69d7f73-17cc-470c-96ad-e29949f36e4d",
        "port": 0,
        "domain_url": "/v2/domains/9e6cf76b-e04b-4acc-8bc7-bfd722211ffa",
        "space_url": "/v2/spaces/accef12c-13b9-4616-b995-73b0776cdbd2",
        "service_instance_url": "/v2/service_instances/b69d7f73-17cc-470c-96ad-e29949f36e4d",
        "apps_url": "/v2/routes/f7f8cdfe-0a20-48dd-adb5-568aea68676f/apps"
      }
    }
  ]
}

Headers

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