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 |
|
|
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.eyJ1c2VyX2lkIjoidWFhLWlkLTg2IiwiZW1haWwiOiJlbWFpbC01NkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDIyMzIzNTMzfQ.dgjdmD2FlpfdOCS2oz9SVXjC4JfO9WK6eJQbMg-BO0s Host: example.org Cookie:
GET /v2/routes
curl "https://api.[your-domain.com]/v2/routes" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTg2IiwiZW1haWwiOiJlbWFpbC01NkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDIyMzIzNTMzfQ.dgjdmD2FlpfdOCS2oz9SVXjC4JfO9WK6eJQbMg-BO0s" \ -H "Host: example.org" \ -H "Cookie: "
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: dd98a90a-2f29-4f89-b7d8-6c2ef1ee8ba5 Content-Length: 745 X-Content-Type-Options: nosniff
200 OK
{ "total_results": 1, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "68e07340-53b7-4da7-85c5-cf38b89cfb4a", "url": "/v2/routes/68e07340-53b7-4da7-85c5-cf38b89cfb4a", "created_at": "2015-01-20T01:52:13+00:00", "updated_at": null }, "entity": { "host": "host-2", "domain_guid": "ce8288c7-76a5-42e5-be06-9a3348afb211", "space_guid": "3eaf245c-ea65-45dc-b588-20b349502b4f", "domain_url": "/v2/domains/ce8288c7-76a5-42e5-be06-9a3348afb211", "space_url": "/v2/spaces/3eaf245c-ea65-45dc-b588-20b349502b4f", "apps_url": "/v2/routes/68e07340-53b7-4da7-85c5-cf38b89cfb4a/apps" } } ] }