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.eyJ1c2VyX2lkIjoidWFhLWlkLTIyOSIsImVtYWlsIjoiZW1haWwtMTYwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjkwMzg3MDd9.dY0lfEhi6sJkTCD8DlBKZGCC96tfEciPAzcGrrBybIU Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/domains" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIyOSIsImVtYWlsIjoiZW1haWwtMTYwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjkwMzg3MDd9.dY0lfEhi6sJkTCD8DlBKZGCC96tfEciPAzcGrrBybIU" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 4, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "79489e1f-f804-42ba-8596-5980fa779f10", "url": "/v2/domains/79489e1f-f804-42ba-8596-5980fa779f10", "created_at": "2015-04-07T19:11:38Z", "updated_at": null }, "entity": { "name": "customer-app-domain1.com" } }, { "metadata": { "guid": "1be99d40-5f66-4b0e-9eb5-c3023585de76", "url": "/v2/domains/1be99d40-5f66-4b0e-9eb5-c3023585de76", "created_at": "2015-04-07T19:11:38Z", "updated_at": null }, "entity": { "name": "customer-app-domain2.com" } }, { "metadata": { "guid": "2aa1f37e-8982-484d-8951-fb896f057fc1", "url": "/v2/domains/2aa1f37e-8982-484d-8951-fb896f057fc1", "created_at": "2015-04-07T19:11:38Z", "updated_at": null }, "entity": { "name": "vcap.me", "owning_organization_guid": "3cc33d6c-f682-46f7-8f69-a461d8ccde45", "owning_organization_url": "/v2/organizations/3cc33d6c-f682-46f7-8f69-a461d8ccde45", "spaces_url": "/v2/domains/2aa1f37e-8982-484d-8951-fb896f057fc1/spaces" } }, { "metadata": { "guid": "77e14dd4-559a-4d8e-894f-7e24a18c4ed3", "url": "/v2/domains/77e14dd4-559a-4d8e-894f-7e24a18c4ed3", "created_at": "2015-04-07T19:11:47Z", "updated_at": null }, "entity": { "name": "domain-35.example.com" } } ] }
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: 57ea7a82-ce30-4f07-b518-8fab4751c9d7 X-Cf-Warnings: Endpoint+deprecated Content-Length: 1563 X-Content-Type-Options: nosniff