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, space_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.eyJ1c2VyX2lkIjoidWFhLWlkLTIwMCIsImVtYWlsIjoiZW1haWwtMTMzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDQ3ODI5MzR9.q-DlLp6SahWkzHJf1fUYt70zsfomWKDNVt3UUawKG0M Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/domains" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIwMCIsImVtYWlsIjoiZW1haWwtMTMzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDQ3ODI5MzR9.q-DlLp6SahWkzHJf1fUYt70zsfomWKDNVt3UUawKG0M" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 4, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "bd13a981-7d26-4ba6-9447-c204df595f38", "url": "/v2/domains/bd13a981-7d26-4ba6-9447-c204df595f38", "created_at": "2015-10-07T00:35:26Z", "updated_at": null }, "entity": { "name": "customer-app-domain1.com", "router_group_guid": null } }, { "metadata": { "guid": "fc08231c-3ac7-499f-b15c-97641a8ff7c6", "url": "/v2/domains/fc08231c-3ac7-499f-b15c-97641a8ff7c6", "created_at": "2015-10-07T00:35:26Z", "updated_at": null }, "entity": { "name": "customer-app-domain2.com", "router_group_guid": null } }, { "metadata": { "guid": "f7fd789d-4550-4191-9ba6-3dc1a6f57bbb", "url": "/v2/domains/f7fd789d-4550-4191-9ba6-3dc1a6f57bbb", "created_at": "2015-10-07T00:35:26Z", "updated_at": null }, "entity": { "name": "vcap.me", "owning_organization_guid": "5ea42db0-9b13-4c8c-8ea9-c11453321a44", "owning_organization_url": "/v2/organizations/5ea42db0-9b13-4c8c-8ea9-c11453321a44", "spaces_url": "/v2/domains/f7fd789d-4550-4191-9ba6-3dc1a6f57bbb/spaces" } }, { "metadata": { "guid": "885cf4d7-b5db-4415-99cc-cd48316fff81", "url": "/v2/domains/885cf4d7-b5db-4415-99cc-cd48316fff81", "created_at": "2015-10-07T00:35:34Z", "updated_at": null }, "entity": { "name": "domain-16.example.com", "router_group_guid": null } } ] }
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: 9a6ec8fa-74af-4db5-bbb0-b4d31e53fc74 X-Cf-Warnings: Endpoint+deprecated Content-Length: 1668 X-Content-Type-Options: nosniff