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.eyJ1c2VyX2lkIjoidWFhLWlkLTIxIiwiZW1haWwiOiJlbWFpbC0yMUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDMyMzEzNjA0fQ.1Kc5eyejLbsCPVIqCWrx1WUcpXf-QKWFiE6Ti5L2n9c Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/domains" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIxIiwiZW1haWwiOiJlbWFpbC0yMUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDMyMzEzNjA0fQ.1Kc5eyejLbsCPVIqCWrx1WUcpXf-QKWFiE6Ti5L2n9c" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 4, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "1240771a-1406-4da8-9eae-a0547a82d0fd", "url": "/v2/domains/1240771a-1406-4da8-9eae-a0547a82d0fd", "created_at": "2015-05-15T16:53:22Z", "updated_at": null }, "entity": { "name": "customer-app-domain1.com" } }, { "metadata": { "guid": "743b1a7d-c955-4bbe-87ff-d34f0dd18b04", "url": "/v2/domains/743b1a7d-c955-4bbe-87ff-d34f0dd18b04", "created_at": "2015-05-15T16:53:22Z", "updated_at": null }, "entity": { "name": "customer-app-domain2.com" } }, { "metadata": { "guid": "4f969d95-26a3-416c-a86b-b1720d764595", "url": "/v2/domains/4f969d95-26a3-416c-a86b-b1720d764595", "created_at": "2015-05-15T16:53:22Z", "updated_at": null }, "entity": { "name": "vcap.me", "owning_organization_guid": "4055bd51-e5c5-4935-87d4-a28cba12f221", "owning_organization_url": "/v2/organizations/4055bd51-e5c5-4935-87d4-a28cba12f221", "spaces_url": "/v2/domains/4f969d95-26a3-416c-a86b-b1720d764595/spaces" } }, { "metadata": { "guid": "162155e1-bfd7-456a-8ad9-3c7705015f4c", "url": "/v2/domains/162155e1-bfd7-456a-8ad9-3c7705015f4c", "created_at": "2015-05-15T16:53:24Z", "updated_at": null }, "entity": { "name": "domain-13.example.com" } } ] }
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: 4c706f3e-82cd-4dfb-92ca-03ff89a48022 X-Cf-Warnings: Endpoint+deprecated Content-Length: 1563 X-Content-Type-Options: nosniff