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

Body

Name Description Default Valid Values Example Values

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI3OSIsImVtYWlsIjoiZW1haWwtMTk2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzM5ODExMTN9.ylQMaiVvqRKL01SoIKNv2MA5Zm1OpzMkDxhnisSyF68
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/routes" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI3OSIsImVtYWlsIjoiZW1haWwtMTk2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzM5ODExMTN9.ylQMaiVvqRKL01SoIKNv2MA5Zm1OpzMkDxhnisSyF68" \
	-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": "826536be-e4cb-4750-ac7b-cdb2a0db4166",
        "url": "/v2/routes/826536be-e4cb-4750-ac7b-cdb2a0db4166",
        "created_at": "2015-06-04T00:05:13Z",
        "updated_at": null
      },
      "entity": {
        "host": "host-9",
        "path": "",
        "domain_guid": "5030289f-4216-4758-844f-4baf85ded272",
        "space_guid": "d5ffd2dd-7b5e-4254-9426-d157f66f6c36",
        "domain_url": "/v2/domains/5030289f-4216-4758-844f-4baf85ded272",
        "space_url": "/v2/spaces/d5ffd2dd-7b5e-4254-9426-d157f66f6c36",
        "apps_url": "/v2/routes/826536be-e4cb-4750-ac7b-cdb2a0db4166/apps"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: a9fef292-a47b-4682-a2f5-a8dcd7110d9f
Content-Length: 760
X-Content-Type-Options: nosniff