Home
Version 3
Routes API

Routes API

List all Routes

GET /v2/routes

Fields

Name Description Default Valid Values Example Values

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
  • 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

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE1NSIsImVtYWlsIjoiZW1haWwtMTI4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTc0NjIzNjB9.fVHU2tDXQMREaSCjW33M0Az5DAeHJclumYMzprrnQe0
Host: example.org
Cookie: 

Route

GET /v2/routes

cURL

curl "https://api.[your-domain.com]/v2/routes" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE1NSIsImVtYWlsIjoiZW1haWwtMTI4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTc0NjIzNjB9.fVHU2tDXQMREaSCjW33M0Az5DAeHJclumYMzprrnQe0" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: b3cd22a9-d491-4907-ba4f-a0bc559f4faf
Content-Length: 745
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "c193f88f-9968-42e8-b3ad-0b11cc06b76c",
        "url": "/v2/routes/c193f88f-9968-42e8-b3ad-0b11cc06b76c",
        "created_at": "2014-11-24T19:32:40+00:00",
        "updated_at": null
      },
      "entity": {
        "host": "host-5",
        "domain_guid": "71a9ac35-fa03-4e8a-93ae-b589e675f18e",
        "space_guid": "0e569a5f-b4d3-4f5f-ac8f-942e37bbfcce",
        "domain_url": "/v2/domains/71a9ac35-fa03-4e8a-93ae-b589e675f18e",
        "space_url": "/v2/spaces/0e569a5f-b4d3-4f5f-ac8f-942e37bbfcce",
        "apps_url": "/v2/routes/c193f88f-9968-42e8-b3ad-0b11cc06b76c/apps"
      }
    }
  ]
}