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.eyJ1c2VyX2lkIjoidWFhLWlkLTE1MCIsImVtYWlsIjoiZW1haWwtODhAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQzMzk4MTEwNX0.sxchjhQT5bv5hDPOquZzHf-BdMBIcUCqRvhgYsRFNvc Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/domains" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE1MCIsImVtYWlsIjoiZW1haWwtODhAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQzMzk4MTEwNX0.sxchjhQT5bv5hDPOquZzHf-BdMBIcUCqRvhgYsRFNvc" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 4, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "4d30b491-9432-45a7-9120-d94b651ef821", "url": "/v2/domains/4d30b491-9432-45a7-9120-d94b651ef821", "created_at": "2015-06-04T00:05:05Z", "updated_at": null }, "entity": { "name": "customer-app-domain1.com" } }, { "metadata": { "guid": "7391020f-4c4c-4e7c-b507-3302d446dbc8", "url": "/v2/domains/7391020f-4c4c-4e7c-b507-3302d446dbc8", "created_at": "2015-06-04T00:05:05Z", "updated_at": null }, "entity": { "name": "customer-app-domain2.com" } }, { "metadata": { "guid": "d54ff25c-daea-481b-81e3-94d555bcfc04", "url": "/v2/domains/d54ff25c-daea-481b-81e3-94d555bcfc04", "created_at": "2015-06-04T00:05:05Z", "updated_at": null }, "entity": { "name": "vcap.me", "owning_organization_guid": "9a19deba-b54f-4278-87c7-f0aa54b1086b", "owning_organization_url": "/v2/organizations/9a19deba-b54f-4278-87c7-f0aa54b1086b", "spaces_url": "/v2/domains/d54ff25c-daea-481b-81e3-94d555bcfc04/spaces" } }, { "metadata": { "guid": "7845d8bd-7beb-407d-8c5e-7b4be129db77", "url": "/v2/domains/7845d8bd-7beb-407d-8c5e-7b4be129db77", "created_at": "2015-06-04T00:05:05Z", "updated_at": null }, "entity": { "name": "domain-4.example.com" } } ] }
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: 69eb6b05-c26d-4a57-9096-b04110369811 X-Cf-Warnings: Endpoint+deprecated Content-Length: 1562 X-Content-Type-Options: nosniff