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, 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 |
|
|
Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEzNyIsImVtYWlsIjoiZW1haWwtODlAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyNDEzNzM2Nn0.Sh2oygQAJDndk9FqYPb8BaLPX52l78t1oJNqG8YDFpc Host: example.org Cookie:
GET /v2/routes
curl "https://api.[your-domain.com]/v2/routes" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEzNyIsImVtYWlsIjoiZW1haWwtODlAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyNDEzNzM2Nn0.Sh2oygQAJDndk9FqYPb8BaLPX52l78t1oJNqG8YDFpc" \ -H "Host: example.org" \ -H "Cookie: "
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: 0b5861a0-d0ae-47a0-a501-b600b636a432 Content-Length: 740 X-Content-Type-Options: nosniff
200 OK
{ "total_results": 1, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "b239d161-63f6-4c4f-a457-d00f290a5600", "url": "/v2/routes/b239d161-63f6-4c4f-a457-d00f290a5600", "created_at": "2015-02-10T01:42:46Z", "updated_at": null }, "entity": { "host": "host-5", "domain_guid": "f8446a5d-a4ed-498a-8e1c-cbf26a0b8419", "space_guid": "d149c9bb-ecdc-4f26-ac71-2175b8b4b198", "domain_url": "/v2/domains/f8446a5d-a4ed-498a-8e1c-cbf26a0b8419", "space_url": "/v2/spaces/d149c9bb-ecdc-4f26-ac71-2175b8b4b198", "apps_url": "/v2/routes/b239d161-63f6-4c4f-a457-d00f290a5600/apps" } } ] }