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, port |
|
|
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.eyJ1c2VyX2lkIjoidWFhLWlkLTE3MCIsImVtYWlsIjoiZW1haWwtMTM4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjE5NTg0MDJ9.k2FzNQms1f3n2QGkINf8Pd4HNNgPsdx0XewqaooUnAI Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/routes" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE3MCIsImVtYWlsIjoiZW1haWwtMTM4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjE5NTg0MDJ9.k2FzNQms1f3n2QGkINf8Pd4HNNgPsdx0XewqaooUnAI" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 1, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "fdfd83b8-aa42-43e9-94aa-9b2717df8955", "url": "/v2/routes/fdfd83b8-aa42-43e9-94aa-9b2717df8955", "created_at": "2016-04-22T19:33:21Z", "updated_at": null }, "entity": { "host": "host-15", "path": "", "domain_guid": "3153f17f-d1d2-4469-8d94-ec66faa99a3d", "space_guid": "1f454cea-23d0-4f26-bccd-acab5caed2c1", "service_instance_guid": "b76e3791-3bfd-4471-9c1d-f516e22ec101", "port": null, "domain_url": "/v2/domains/3153f17f-d1d2-4469-8d94-ec66faa99a3d", "space_url": "/v2/spaces/1f454cea-23d0-4f26-bccd-acab5caed2c1", "service_instance_url": "/v2/service_instances/b76e3791-3bfd-4471-9c1d-f516e22ec101", "apps_url": "/v2/routes/fdfd83b8-aa42-43e9-94aa-9b2717df8955/apps", "route_mappings_url": "/v2/routes/fdfd83b8-aa42-43e9-94aa-9b2717df8955/route_mappings" } } ] }
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: ace4da3c-ec35-4952-9345-8268d0b8c071 Content-Length: 1046 X-Content-Type-Options: nosniff