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.eyJ1c2VyX2lkIjoidWFhLWlkLTM5MCIsImVtYWlsIjoiZW1haWwtMjgwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mzg2NDE4MTN9.FVdGuySX0ptoqaPTYYrpIH10oFCFrQeT0914TeVVKI8 Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/domains" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM5MCIsImVtYWlsIjoiZW1haWwtMjgwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mzg2NDE4MTN9.FVdGuySX0ptoqaPTYYrpIH10oFCFrQeT0914TeVVKI8" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 4, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "c8e670ff-2473-4e21-8047-afc6e0c62ce7", "url": "/v2/domains/c8e670ff-2473-4e21-8047-afc6e0c62ce7", "created_at": "2015-07-27T22:43:31Z", "updated_at": null }, "entity": { "name": "customer-app-domain1.com" } }, { "metadata": { "guid": "2b63d3fa-52e9-4f12-87d1-a96af5bd3cd4", "url": "/v2/domains/2b63d3fa-52e9-4f12-87d1-a96af5bd3cd4", "created_at": "2015-07-27T22:43:31Z", "updated_at": null }, "entity": { "name": "customer-app-domain2.com" } }, { "metadata": { "guid": "2c60a78c-0f6e-4ef8-81db-f3a6cb5e31da", "url": "/v2/domains/2c60a78c-0f6e-4ef8-81db-f3a6cb5e31da", "created_at": "2015-07-27T22:43:31Z", "updated_at": null }, "entity": { "name": "vcap.me", "owning_organization_guid": "f93d5a41-5d35-4e21-ac32-421dfd545d3c", "owning_organization_url": "/v2/organizations/f93d5a41-5d35-4e21-ac32-421dfd545d3c", "spaces_url": "/v2/domains/2c60a78c-0f6e-4ef8-81db-f3a6cb5e31da/spaces" } }, { "metadata": { "guid": "b37aab98-5882-420a-a91f-65539e36e860", "url": "/v2/domains/b37aab98-5882-420a-a91f-65539e36e860", "created_at": "2015-07-27T22:43:33Z", "updated_at": null }, "entity": { "name": "domain-62.example.com" } } ] }
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: 31bbd012-a782-4f0e-882f-18d0276c6086 X-Cf-Warnings: Endpoint+deprecated Content-Length: 1563 X-Content-Type-Options: nosniff