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. |
|
|
|
name | The name of the domain. |
|
|
Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM3NiIsImVtYWlsIjoiZW1haWwtMjc4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjYxODc3NjV9.xwy05M8d_6Z1s-_KVeVOFzIvY_pkFzCx72f0pkTQQfM Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/shared_domains" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM3NiIsImVtYWlsIjoiZW1haWwtMjc4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjYxODc3NjV9.xwy05M8d_6Z1s-_KVeVOFzIvY_pkFzCx72f0pkTQQfM" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 5, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "022b327d-a0e2-405c-9b6f-495278af60e7", "url": "/v2/shared_domains/022b327d-a0e2-405c-9b6f-495278af60e7", "created_at": "2015-03-05T19:15:53Z", "updated_at": null }, "entity": { "name": "customer-app-domain1.com" } }, { "metadata": { "guid": "d2bb6620-476c-458e-aba8-e9401a5cdbc0", "url": "/v2/shared_domains/d2bb6620-476c-458e-aba8-e9401a5cdbc0", "created_at": "2015-03-05T19:15:53Z", "updated_at": null }, "entity": { "name": "customer-app-domain2.com" } }, { "metadata": { "guid": "c33b7cec-d9a6-426a-b3d3-c8ad99dbd0ab", "url": "/v2/shared_domains/c33b7cec-d9a6-426a-b3d3-c8ad99dbd0ab", "created_at": "2015-03-05T19:16:05Z", "updated_at": null }, "entity": { "name": "domain-53.example.com" } }, { "metadata": { "guid": "aec6e990-2ad3-4ef7-a434-207780e73ba3", "url": "/v2/shared_domains/aec6e990-2ad3-4ef7-a434-207780e73ba3", "created_at": "2015-03-05T19:16:05Z", "updated_at": null }, "entity": { "name": "domain-54.example.com" } }, { "metadata": { "guid": "c6d51cf2-966b-4f3f-aa98-13546e15eee7", "url": "/v2/shared_domains/c6d51cf2-966b-4f3f-aa98-13546e15eee7", "created_at": "2015-03-05T19:16:05Z", "updated_at": null }, "entity": { "name": "domain-55.example.com" } } ] }
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: bced0254-d175-491b-8c59-c3bfe9c1dabe Content-Length: 1666 X-Content-Type-Options: nosniff