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.eyJ1c2VyX2lkIjoidWFhLWlkLTI5IiwiZW1haWwiOiJlbWFpbC0yOEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDM1MTAyODQ2fQ.EpRn4-iNAP5L2A11LZlJSfww_OL2CG5ZTdj8M0FNWbk Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/domains" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI5IiwiZW1haWwiOiJlbWFpbC0yOEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDM1MTAyODQ2fQ.EpRn4-iNAP5L2A11LZlJSfww_OL2CG5ZTdj8M0FNWbk" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 4, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "886f0391-d28e-46bd-a4c8-28ec9bed6623", "url": "/v2/domains/886f0391-d28e-46bd-a4c8-28ec9bed6623", "created_at": "2015-06-16T23:40:41Z", "updated_at": null }, "entity": { "name": "customer-app-domain1.com" } }, { "metadata": { "guid": "e903e7f7-a570-4d58-8da6-d87a1a16ae37", "url": "/v2/domains/e903e7f7-a570-4d58-8da6-d87a1a16ae37", "created_at": "2015-06-16T23:40:41Z", "updated_at": null }, "entity": { "name": "customer-app-domain2.com" } }, { "metadata": { "guid": "6d07beec-57dc-4d6c-b1ed-559550b27604", "url": "/v2/domains/6d07beec-57dc-4d6c-b1ed-559550b27604", "created_at": "2015-06-16T23:40:41Z", "updated_at": null }, "entity": { "name": "vcap.me", "owning_organization_guid": "13fd7e95-5dc7-483d-a6c0-e55c6332a100", "owning_organization_url": "/v2/organizations/13fd7e95-5dc7-483d-a6c0-e55c6332a100", "spaces_url": "/v2/domains/6d07beec-57dc-4d6c-b1ed-559550b27604/spaces" } }, { "metadata": { "guid": "d5f782f8-a494-49b2-aae4-26067f3ff568", "url": "/v2/domains/d5f782f8-a494-49b2-aae4-26067f3ff568", "created_at": "2015-06-16T23:40:45Z", "updated_at": null }, "entity": { "name": "domain-26.example.com" } } ] }
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: 10c84c54-7dcd-4f2b-a76b-b8c9b77ae88b X-Cf-Warnings: Endpoint+deprecated Content-Length: 1563 X-Content-Type-Options: nosniff