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 |
|
|
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.eyJ1c2VyX2lkIjoidWFhLWlkLTE2MyIsImVtYWlsIjoiZW1haWwtMTMwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTQ0NTE2MTd9.t3JD6MfSsIwZnBccghuDO74MT29lPO3-22Vwwk-_hLM Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/routes" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE2MyIsImVtYWlsIjoiZW1haWwtMTMwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTQ0NTE2MTd9.t3JD6MfSsIwZnBccghuDO74MT29lPO3-22Vwwk-_hLM" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 1, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "97c0947e-f03a-48ce-96a0-5dd3e8e2fdda", "url": "/v2/routes/97c0947e-f03a-48ce-96a0-5dd3e8e2fdda", "created_at": "2016-01-26T22:20:17Z", "updated_at": null }, "entity": { "host": "host-15", "path": "", "domain_guid": "d30171fe-a07d-4313-beef-f55e654e68e5", "space_guid": "a23206cd-7ce3-4b1b-9d78-0bc738f3f685", "service_instance_guid": "db1b9235-e1db-4362-bd86-39b0b3fa2a79", "port": 0, "domain_url": "/v2/domains/d30171fe-a07d-4313-beef-f55e654e68e5", "space_url": "/v2/spaces/a23206cd-7ce3-4b1b-9d78-0bc738f3f685", "service_instance_url": "/v2/service_instances/db1b9235-e1db-4362-bd86-39b0b3fa2a79", "apps_url": "/v2/routes/97c0947e-f03a-48ce-96a0-5dd3e8e2fdda/apps" } } ] }
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: Content-Length: 947 X-Content-Type-Options: nosniff