Name | Description | Default | Valid Values | Example Values |
---|
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 |
|
|
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 |
|
|
Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIwMyIsImVtYWlsIjoiZW1haWwtMTU1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTk5ODk5NzN9.145iTyhnibkuo_QRcLqVZz572pOl_XNPOiCSvOcQq0U Host: example.org Cookie:
GET /v2/routes
curl "https://api.[your-domain.com]/v2/routes" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIwMyIsImVtYWlsIjoiZW1haWwtMTU1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTk5ODk5NzN9.145iTyhnibkuo_QRcLqVZz572pOl_XNPOiCSvOcQq0U" \ -H "Host: example.org" \ -H "Cookie: "
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: a295b5c9-95c4-4c1c-93a5-8738395802c3 Content-Length: 746 X-Content-Type-Options: nosniff
200 OK
{ "total_results": 1, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "ceb648e6-d8cf-4852-a7dd-4b1e53ce3247", "url": "/v2/routes/ceb648e6-d8cf-4852-a7dd-4b1e53ce3247", "created_at": "2014-12-24T01:39:33+00:00", "updated_at": null }, "entity": { "host": "host-10", "domain_guid": "92586b88-e84b-48e4-ad69-ebea58bf157f", "space_guid": "d73d77d8-6cb3-4c3d-81b7-32d4bf9aff25", "domain_url": "/v2/domains/92586b88-e84b-48e4-ad69-ebea58bf157f", "space_url": "/v2/spaces/d73d77d8-6cb3-4c3d-81b7-32d4bf9aff25", "apps_url": "/v2/routes/ceb648e6-d8cf-4852-a7dd-4b1e53ce3247/apps" } } ] }