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, 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 |
|
|
Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM2NyIsImVtYWlsIjoiZW1haWwtMjY5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQ0NzE3MDl9.NMaRmBRAlcMjdcaP9yCtYKnJ3ort9kC8G5MVyWhjtVI Host: example.org Cookie:
GET /v2/routes
curl "https://api.[your-domain.com]/v2/routes" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM2NyIsImVtYWlsIjoiZW1haWwtMjY5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQ0NzE3MDl9.NMaRmBRAlcMjdcaP9yCtYKnJ3ort9kC8G5MVyWhjtVI" \ -H "Host: example.org" \ -H "Cookie: "
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: b5690579-a26c-4f05-91b0-e93b502a3c1b Content-Length: 741 X-Content-Type-Options: nosniff
200 OK
{ "total_results": 1, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "80ed352f-705c-4c45-baf2-8135b11f9d37", "url": "/v2/routes/80ed352f-705c-4c45-baf2-8135b11f9d37", "created_at": "2015-02-13T22:35:09Z", "updated_at": null }, "entity": { "host": "host-13", "domain_guid": "cc067dba-b395-42c5-8905-1bdf8ecb5a01", "space_guid": "eab7c442-5d5b-46d7-a210-04c86dbf91e7", "domain_url": "/v2/domains/cc067dba-b395-42c5-8905-1bdf8ecb5a01", "space_url": "/v2/spaces/eab7c442-5d5b-46d7-a210-04c86dbf91e7", "apps_url": "/v2/routes/80ed352f-705c-4c45-baf2-8135b11f9d37/apps" } } ] }