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.eyJ1c2VyX2lkIjoidWFhLWlkLTI3OCIsImVtYWlsIjoiZW1haWwtMTg0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTE0MTM2ODl9.uNZJ2fzqC-k5fvobTZ67BXcGMpVqcyqlgEeLWU_LPek Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/routes" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI3OCIsImVtYWlsIjoiZW1haWwtMTg0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTE0MTM2ODl9.uNZJ2fzqC-k5fvobTZ67BXcGMpVqcyqlgEeLWU_LPek" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 1, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "81519c2a-ef5d-4558-97b9-484c2acec3ba", "url": "/v2/routes/81519c2a-ef5d-4558-97b9-484c2acec3ba", "created_at": "2015-12-22T18:28:09Z", "updated_at": null }, "entity": { "host": "host-18", "path": "", "domain_guid": "9fda853a-355d-4293-8a72-e55a46d262c1", "space_guid": "52d9bd7d-d505-4a1a-8b4b-5005a28d6f41", "service_instance_guid": "eab2efb1-435a-468d-8829-d60a34ba8e2d", "port": 0, "domain_url": "/v2/domains/9fda853a-355d-4293-8a72-e55a46d262c1", "space_url": "/v2/spaces/52d9bd7d-d505-4a1a-8b4b-5005a28d6f41", "service_instance_url": "/v2/service_instances/eab2efb1-435a-468d-8829-d60a34ba8e2d", "apps_url": "/v2/routes/81519c2a-ef5d-4558-97b9-484c2acec3ba/apps" } } ] }
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: Content-Length: 947 X-Content-Type-Options: nosniff