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, path |
|
|
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.eyJ1c2VyX2lkIjoidWFhLWlkLTM3NyIsImVtYWlsIjoiZW1haWwtMjc5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDUzNjIzMTl9.4SDLV9F63984WHBUS3GjAJpLm4MaNpxqSC-OG9e7ips Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/routes" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM3NyIsImVtYWlsIjoiZW1haWwtMjc5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDUzNjIzMTl9.4SDLV9F63984WHBUS3GjAJpLm4MaNpxqSC-OG9e7ips" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 1, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "673d3d13-f40e-40dc-a8c3-65938fc314f5", "url": "/v2/routes/673d3d13-f40e-40dc-a8c3-65938fc314f5", "created_at": "2015-10-13T17:31:59Z", "updated_at": null }, "entity": { "host": "host-18", "path": "", "domain_guid": "687eee1d-f79d-4910-92e8-89e00b0fa6ee", "space_guid": "a9c2d548-5ce4-4987-ae12-e1b2177b7c3e", "service_instance_guid": "2eeff854-fb2d-4e53-9b66-54445d4eac50", "port": 0, "domain_url": "/v2/domains/687eee1d-f79d-4910-92e8-89e00b0fa6ee", "space_url": "/v2/spaces/a9c2d548-5ce4-4987-ae12-e1b2177b7c3e", "service_instance_url": "/v2/service_instances/2eeff854-fb2d-4e53-9b66-54445d4eac50", "apps_url": "/v2/routes/673d3d13-f40e-40dc-a8c3-65938fc314f5/apps" } } ] }
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: 7f704ba5-e849-475c-a0cf-1582a8a30d69 Content-Length: 947 X-Content-Type-Options: nosniff