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 |
|
|
Name | Description | Default | Valid Values | Example Values |
---|
Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEyMiIsImVtYWlsIjoiZW1haWwtNzFAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQzMTY0NjYzMX0.ajUpaZfn_Isa36P-lhGliq6hX_z2Pg-UZUqgaBdRj9o Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/routes" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEyMiIsImVtYWlsIjoiZW1haWwtNzFAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQzMTY0NjYzMX0.ajUpaZfn_Isa36P-lhGliq6hX_z2Pg-UZUqgaBdRj9o" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 1, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "a1fede1c-6c49-44cd-b1d4-da924120eee0", "url": "/v2/routes/a1fede1c-6c49-44cd-b1d4-da924120eee0", "created_at": "2015-05-07T23:37:11Z", "updated_at": null }, "entity": { "host": "host-6", "domain_guid": "f376e260-4088-4d38-b7e1-963bbb7e6a90", "space_guid": "78bf3d9a-876e-4dcb-9514-3b5d2c4179b9", "path": "", "domain_url": "/v2/domains/f376e260-4088-4d38-b7e1-963bbb7e6a90", "space_url": "/v2/spaces/78bf3d9a-876e-4dcb-9514-3b5d2c4179b9", "apps_url": "/v2/routes/a1fede1c-6c49-44cd-b1d4-da924120eee0/apps" } } ] }
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: ece4cf65-f6c6-4afb-9d13-7e47ba340a4e Content-Length: 760 X-Content-Type-Options: nosniff