GET /v2/shared_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 |
|
|
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. |
|
|
|
router_group_guid | The guid of the router group. |
|
|
|
name | The name of the domain. |
|
|
Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQyMyIsImVtYWlsIjoiZW1haWwtMjk0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTE0MTM2OTl9.lbS2VN2-7eFgt6UcTrPvRCpry-FWGjxkehsWMXMS1mk Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/shared_domains" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQyMyIsImVtYWlsIjoiZW1haWwtMjk0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTE0MTM2OTl9.lbS2VN2-7eFgt6UcTrPvRCpry-FWGjxkehsWMXMS1mk" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 5, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "1b74d4d9-11fe-45e1-8a07-a81dc8fa95a2", "url": "/v2/shared_domains/1b74d4d9-11fe-45e1-8a07-a81dc8fa95a2", "created_at": "2015-12-22T18:28:12Z", "updated_at": null }, "entity": { "name": "customer-app-domain1.com", "router_group_guid": null } }, { "metadata": { "guid": "d3f761e7-0ab4-4748-aa2f-05143fa52b22", "url": "/v2/shared_domains/d3f761e7-0ab4-4748-aa2f-05143fa52b22", "created_at": "2015-12-22T18:28:12Z", "updated_at": null }, "entity": { "name": "customer-app-domain2.com", "router_group_guid": null } }, { "metadata": { "guid": "b0533898-24cc-4dee-8ecf-4fde5c067638", "url": "/v2/shared_domains/b0533898-24cc-4dee-8ecf-4fde5c067638", "created_at": "2015-12-22T18:28:19Z", "updated_at": null }, "entity": { "name": "domain-61.example.com", "router_group_guid": null } }, { "metadata": { "guid": "7bf35e19-7a3c-4a5e-88c9-b9874fea3127", "url": "/v2/shared_domains/7bf35e19-7a3c-4a5e-88c9-b9874fea3127", "created_at": "2015-12-22T18:28:19Z", "updated_at": null }, "entity": { "name": "domain-62.example.com", "router_group_guid": null } }, { "metadata": { "guid": "092d24f6-4278-48e9-b0c4-d924fc9bae5e", "url": "/v2/shared_domains/092d24f6-4278-48e9-b0c4-d924fc9bae5e", "created_at": "2015-12-22T18:28:19Z", "updated_at": null }, "entity": { "name": "domain-63.example.com", "router_group_guid": null } } ] }
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: Content-Length: 1841 X-Content-Type-Options: nosniff