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
  • 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.eyJ1c2VyX2lkIjoidWFhLWlkLTI0MyIsImVtYWlsIjoiZW1haWwtMTQ3QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDU1NTc5NDh9.BR_-PfkQkgUJnQLEZCeckA6z9cTqFixz1V2zNu7hBvM
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/routes" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI0MyIsImVtYWlsIjoiZW1haWwtMTQ3QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDU1NTc5NDh9.BR_-PfkQkgUJnQLEZCeckA6z9cTqFixz1V2zNu7hBvM" \
	-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": "d76ab329-573b-47d8-8e4a-96090152cce4",
        "url": "/v2/routes/d76ab329-573b-47d8-8e4a-96090152cce4",
        "created_at": "2015-10-15T23:52:28Z",
        "updated_at": null
      },
      "entity": {
        "host": "host-9",
        "path": "",
        "domain_guid": "c280f55d-3104-479c-accd-ed9f267fd651",
        "space_guid": "f303d7ad-e044-4cb0-85ff-e61a7cad8e15",
        "service_instance_guid": "770c99b5-7274-49d6-a6c9-4b112e31c077",
        "port": 0,
        "domain_url": "/v2/domains/c280f55d-3104-479c-accd-ed9f267fd651",
        "space_url": "/v2/spaces/f303d7ad-e044-4cb0-85ff-e61a7cad8e15",
        "service_instance_url": "/v2/service_instances/770c99b5-7274-49d6-a6c9-4b112e31c077",
        "apps_url": "/v2/routes/d76ab329-573b-47d8-8e4a-96090152cce4/apps"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: f989a655-3b84-4411-9683-19cf56314a30
Content-Length: 946
X-Content-Type-Options: nosniff