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.eyJ1c2VyX2lkIjoidWFhLWlkLTE2NCIsImVtYWlsIjoiZW1haWwtMTI2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjczMjM5NjZ9.RyGf4h_567X0mjsAWAM-DsyBSdhFPRvZ8bedOEtLi_k Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/domains" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE2NCIsImVtYWlsIjoiZW1haWwtMTI2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjczMjM5NjZ9.RyGf4h_567X0mjsAWAM-DsyBSdhFPRvZ8bedOEtLi_k" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 4, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "e63b955d-66c6-4d6e-8a66-b68260c4f670", "url": "/v2/domains/e63b955d-66c6-4d6e-8a66-b68260c4f670", "created_at": "2015-03-18T22:52:45Z", "updated_at": null }, "entity": { "name": "customer-app-domain1.com" } }, { "metadata": { "guid": "906bad5e-b7da-4fd1-a15c-46527364d155", "url": "/v2/domains/906bad5e-b7da-4fd1-a15c-46527364d155", "created_at": "2015-03-18T22:52:45Z", "updated_at": null }, "entity": { "name": "customer-app-domain2.com" } }, { "metadata": { "guid": "b93c551b-c4e6-4bca-9a5f-a10b870eac2e", "url": "/v2/domains/b93c551b-c4e6-4bca-9a5f-a10b870eac2e", "created_at": "2015-03-18T22:52:45Z", "updated_at": null }, "entity": { "name": "vcap.me", "owning_organization_guid": "fd775cd9-0e65-4a59-953f-fa5c7bba7f9e", "owning_organization_url": "/v2/organizations/fd775cd9-0e65-4a59-953f-fa5c7bba7f9e", "spaces_url": "/v2/domains/b93c551b-c4e6-4bca-9a5f-a10b870eac2e/spaces" } }, { "metadata": { "guid": "56220834-e84e-4d00-94a3-1150b83f56be", "url": "/v2/domains/56220834-e84e-4d00-94a3-1150b83f56be", "created_at": "2015-03-18T22:52:46Z", "updated_at": null }, "entity": { "name": "domain-27.example.com" } } ] }
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: a2a2ba81-7538-4a5b-893e-8e73e151976a X-Cf-Warnings: Endpoint+deprecated Content-Length: 1563 X-Content-Type-Options: nosniff