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, generate_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.eyJ1c2VyX2lkIjoidWFhLWlkLTkzIiwiZW1haWwiOiJlbWFpbC01OEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDQ4MDM4OTQ2fQ.Vio3gcAVlXTvsJOkzd5nCfbY1l7mkQkk5GUVSH8W8Oc Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/routes" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTkzIiwiZW1haWwiOiJlbWFpbC01OEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDQ4MDM4OTQ2fQ.Vio3gcAVlXTvsJOkzd5nCfbY1l7mkQkk5GUVSH8W8Oc" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 1, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "614d9eb7-810d-44cc-bf7d-85b245657672", "url": "/v2/routes/614d9eb7-810d-44cc-bf7d-85b245657672", "created_at": "2015-11-13T17:02:26Z", "updated_at": null }, "entity": { "host": "host-5", "path": "", "domain_guid": "bda0d0f3-b91c-4396-996d-c7a0db02867f", "space_guid": "d45bebac-f2cd-4ceb-b94e-b8c7c0295cf8", "service_instance_guid": "f9b7919a-7b42-475f-b808-76e98d544a43", "port": 0, "domain_url": "/v2/domains/bda0d0f3-b91c-4396-996d-c7a0db02867f", "space_url": "/v2/spaces/d45bebac-f2cd-4ceb-b94e-b8c7c0295cf8", "service_instance_url": "/v2/service_instances/f9b7919a-7b42-475f-b808-76e98d544a43", "apps_url": "/v2/routes/614d9eb7-810d-44cc-bf7d-85b245657672/apps" } } ] }
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: Content-Length: 946 X-Content-Type-Options: nosniff