GET /v2/routes
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 |
|
|
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 |
|
|
Name | Description | Default | Valid Values | Example Values |
---|
Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE5MCIsImVtYWlsIjoiZW1haWwtMTQyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjYxODc3NDZ9.hAq50aSyJURROHhdTM8NqbjpT87Zd3adPSZ7gAGL3Ns Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/routes" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE5MCIsImVtYWlsIjoiZW1haWwtMTQyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjYxODc3NDZ9.hAq50aSyJURROHhdTM8NqbjpT87Zd3adPSZ7gAGL3Ns" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 1, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "f24f55b9-0085-498a-9871-2e14c08ad677", "url": "/v2/routes/f24f55b9-0085-498a-9871-2e14c08ad677", "created_at": "2015-03-05T19:15:46Z", "updated_at": null }, "entity": { "host": "host-4", "domain_guid": "e8291eef-f6bc-4f58-89c8-5cb1f6001e20", "space_guid": "8ca967cf-b92d-4b13-b815-237c12031350", "domain_url": "/v2/domains/e8291eef-f6bc-4f58-89c8-5cb1f6001e20", "space_url": "/v2/spaces/8ca967cf-b92d-4b13-b815-237c12031350", "apps_url": "/v2/routes/f24f55b9-0085-498a-9871-2e14c08ad677/apps" } } ] }
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: d80e5d93-e024-4a51-9f3b-76ea97087c5d Content-Length: 740 X-Content-Type-Options: nosniff