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.eyJ1c2VyX2lkIjoidWFhLWlkLTg1IiwiZW1haWwiOiJlbWFpbC01MkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDUzMzEwOTczfQ.BWFnFApGVV8JYcYDE8XjxiUhEnAwbk0iM9DZ-aAXBEU Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/domains" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTg1IiwiZW1haWwiOiJlbWFpbC01MkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDUzMzEwOTczfQ.BWFnFApGVV8JYcYDE8XjxiUhEnAwbk0iM9DZ-aAXBEU" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 4, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "4d3835a6-5ae4-4766-aeca-8fa12db8f320", "url": "/v2/domains/4d3835a6-5ae4-4766-aeca-8fa12db8f320", "created_at": "2016-01-13T17:29:29Z", "updated_at": null }, "entity": { "name": "customer-app-domain1.com", "router_group_guid": null } }, { "metadata": { "guid": "dc55bc95-b14d-43e5-a700-38aec9b28b17", "url": "/v2/domains/dc55bc95-b14d-43e5-a700-38aec9b28b17", "created_at": "2016-01-13T17:29:29Z", "updated_at": null }, "entity": { "name": "customer-app-domain2.com", "router_group_guid": null } }, { "metadata": { "guid": "baeb2436-6800-451b-88ee-30bb4530ca44", "url": "/v2/domains/baeb2436-6800-451b-88ee-30bb4530ca44", "created_at": "2016-01-13T17:29:29Z", "updated_at": null }, "entity": { "name": "vcap.me", "owning_organization_guid": "b4284bff-2641-40cc-8141-541b359b2074", "owning_organization_url": "/v2/organizations/b4284bff-2641-40cc-8141-541b359b2074", "spaces_url": "/v2/domains/baeb2436-6800-451b-88ee-30bb4530ca44/spaces" } }, { "metadata": { "guid": "2df35007-ee7d-4edc-9265-d5e0cb0c7503", "url": "/v2/domains/2df35007-ee7d-4edc-9265-d5e0cb0c7503", "created_at": "2016-01-13T17:29:33Z", "updated_at": null }, "entity": { "name": "domain-8.example.com", "router_group_guid": null } } ] }
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: X-Cf-Warnings: Endpoint+deprecated Content-Length: 1667 X-Content-Type-Options: nosniff