Home
Version 3
Routes API

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, 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.eyJ1c2VyX2lkIjoidWFhLWlkLTM3NCIsImVtYWlsIjoiZW1haWwtMjc2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDk1MzE1MzZ9.WFihr4iHwbjsJ0hVNy3dgCD4HZdecUyDh-ZR9dHyxcE
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/routes" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM3NCIsImVtYWlsIjoiZW1haWwtMjc2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDk1MzE1MzZ9.WFihr4iHwbjsJ0hVNy3dgCD4HZdecUyDh-ZR9dHyxcE" \
	-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": "74c1b87d-afba-4f2e-aa94-6784b8f31b82",
        "url": "/v2/routes/74c1b87d-afba-4f2e-aa94-6784b8f31b82",
        "created_at": "2015-11-30T23:38:55Z",
        "updated_at": null
      },
      "entity": {
        "host": "host-16",
        "path": "",
        "domain_guid": "b69308ac-71f8-43be-8909-cc611f7da961",
        "space_guid": "2d138908-9fbf-48b4-9ca1-2f4834e11daf",
        "service_instance_guid": "faf31999-1aed-4416-a9a6-3472e0828f98",
        "port": 0,
        "domain_url": "/v2/domains/b69308ac-71f8-43be-8909-cc611f7da961",
        "space_url": "/v2/spaces/2d138908-9fbf-48b4-9ca1-2f4834e11daf",
        "service_instance_url": "/v2/service_instances/faf31999-1aed-4416-a9a6-3472e0828f98",
        "apps_url": "/v2/routes/74c1b87d-afba-4f2e-aa94-6784b8f31b82/apps"
      }
    }
  ]
}

Headers

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