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.eyJ1c2VyX2lkIjoidWFhLWlkLTQxIiwiZW1haWwiOiJlbWFpbC00MUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI5MDM4Njk5fQ.yeyvlwV0F_xakk12tWqyNExQh3UDVGwQJmzhz3KkJfA Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/routes" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQxIiwiZW1haWwiOiJlbWFpbC00MUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI5MDM4Njk5fQ.yeyvlwV0F_xakk12tWqyNExQh3UDVGwQJmzhz3KkJfA" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 1, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "ed1da734-4c0e-46f3-8660-6f9ea5a5bc85", "url": "/v2/routes/ed1da734-4c0e-46f3-8660-6f9ea5a5bc85", "created_at": "2015-04-07T19:11:39Z", "updated_at": null }, "entity": { "host": "host-7", "domain_guid": "33046392-424f-4e06-a882-d9220fc6a08a", "space_guid": "4c3dcfec-14cb-4039-81ed-ecb7efb077c8", "domain_url": "/v2/domains/33046392-424f-4e06-a882-d9220fc6a08a", "space_url": "/v2/spaces/4c3dcfec-14cb-4039-81ed-ecb7efb077c8", "apps_url": "/v2/routes/ed1da734-4c0e-46f3-8660-6f9ea5a5bc85/apps" } } ] }
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: e83f6897-2510-4e88-8f7e-a4bf9b50cc47 Content-Length: 740 X-Content-Type-Options: nosniff