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.eyJ1c2VyX2lkIjoidWFhLWlkLTc5IiwiZW1haWwiOiJlbWFpbC01MEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI5NjY0MTM1fQ.w_QMP1gl8INM_8qpuCMA6NZ_dG5R0AZSpdQi3YFkqls Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/domains" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTc5IiwiZW1haWwiOiJlbWFpbC01MEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI5NjY0MTM1fQ.w_QMP1gl8INM_8qpuCMA6NZ_dG5R0AZSpdQi3YFkqls" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 4, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "5129feb4-0d79-4a1f-9d14-66785acc3a72", "url": "/v2/domains/5129feb4-0d79-4a1f-9d14-66785acc3a72", "created_at": "2015-04-15T00:55:31Z", "updated_at": null }, "entity": { "name": "customer-app-domain1.com" } }, { "metadata": { "guid": "99e05307-e90c-4e50-af4b-0d1e4c29f0a0", "url": "/v2/domains/99e05307-e90c-4e50-af4b-0d1e4c29f0a0", "created_at": "2015-04-15T00:55:31Z", "updated_at": null }, "entity": { "name": "customer-app-domain2.com" } }, { "metadata": { "guid": "0e160e60-dd8e-41bb-8d6b-d9a20c2bef0a", "url": "/v2/domains/0e160e60-dd8e-41bb-8d6b-d9a20c2bef0a", "created_at": "2015-04-15T00:55:31Z", "updated_at": null }, "entity": { "name": "vcap.me", "owning_organization_guid": "c94aa39f-1ce3-4a0f-b6f6-1c49e35cc9c7", "owning_organization_url": "/v2/organizations/c94aa39f-1ce3-4a0f-b6f6-1c49e35cc9c7", "spaces_url": "/v2/domains/0e160e60-dd8e-41bb-8d6b-d9a20c2bef0a/spaces" } }, { "metadata": { "guid": "283d32b3-2d2a-4c95-98e2-cd5edbdc44ef", "url": "/v2/domains/283d32b3-2d2a-4c95-98e2-cd5edbdc44ef", "created_at": "2015-04-15T00:55:35Z", "updated_at": null }, "entity": { "name": "domain-6.example.com" } } ] }
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: 030883c6-0fff-4220-a452-b202ce6f83da X-Cf-Warnings: Endpoint+deprecated Content-Length: 1562 X-Content-Type-Options: nosniff