GET /v2/domains
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: name, owning_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 |
|
|
Name | Description | Default | Valid Values | Example Values |
---|---|---|---|---|
guid | The guid of the domain. |
|
|
|
name | The name of the domain. |
|
|
|
wildcard | Allow routes with non-empty hosts |
|
|
|
owning_organization_guid | The organization that owns the domain. If not specified, the domain is shared. |
|
|
Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE4MSIsImVtYWlsIjoiZW1haWwtMTEzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjEzNzQ2MzB9.RxgSadqh1FIKyfTNYC3jUaw3QH9GCTAwh9Kpu-zBJWw Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/domains" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE4MSIsImVtYWlsIjoiZW1haWwtMTEzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjEzNzQ2MzB9.RxgSadqh1FIKyfTNYC3jUaw3QH9GCTAwh9Kpu-zBJWw" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 4, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "95fdf12f-7474-46f1-a028-d2b33ab3c651", "url": "/v2/domains/95fdf12f-7474-46f1-a028-d2b33ab3c651", "created_at": "2016-04-16T01:23:45Z", "updated_at": null }, "entity": { "name": "customer-app-domain1.com", "router_group_guid": null, "router_group_type": null } }, { "metadata": { "guid": "f72de718-5750-4ac2-b28d-f1cdcc40a7ea", "url": "/v2/domains/f72de718-5750-4ac2-b28d-f1cdcc40a7ea", "created_at": "2016-04-16T01:23:45Z", "updated_at": null }, "entity": { "name": "customer-app-domain2.com", "router_group_guid": null, "router_group_type": null } }, { "metadata": { "guid": "e205ca45-e6ab-4818-acb8-1ad269d54766", "url": "/v2/domains/e205ca45-e6ab-4818-acb8-1ad269d54766", "created_at": "2016-04-16T01:23:45Z", "updated_at": null }, "entity": { "name": "vcap.me", "owning_organization_guid": "987056a4-f070-41d6-8968-348b427f4fe5", "owning_organization_url": "/v2/organizations/987056a4-f070-41d6-8968-348b427f4fe5", "spaces_url": "/v2/domains/e205ca45-e6ab-4818-acb8-1ad269d54766/spaces" } }, { "metadata": { "guid": "ef6f0ffd-1c31-4cf9-b1cb-baf653d4edd1", "url": "/v2/domains/ef6f0ffd-1c31-4cf9-b1cb-baf653d4edd1", "created_at": "2016-04-16T01:23:50Z", "updated_at": null }, "entity": { "name": "domain-30.example.com", "router_group_guid": null, "router_group_type": null } } ] }
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: ad4b53ea-6072-42b0-9567-55f887646879 X-Cf-Warnings: Endpoint+deprecated Content-Length: 1773 X-Content-Type-Options: nosniff