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.eyJ1c2VyX2lkIjoidWFhLWlkLTQ2NSIsImVtYWlsIjoiZW1haWwtMzM2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTQ0NTE2NDB9.nIlkczhTTipwV_BlaAZlc1HeMNW5wlCBOw0q9Ptvcvg Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/shared_domains" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQ2NSIsImVtYWlsIjoiZW1haWwtMzM2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTQ0NTE2NDB9.nIlkczhTTipwV_BlaAZlc1HeMNW5wlCBOw0q9Ptvcvg" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 5, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "4c48991b-98dc-42ac-a2f2-1dbcf2fdb1d4", "url": "/v2/shared_domains/4c48991b-98dc-42ac-a2f2-1dbcf2fdb1d4", "created_at": "2016-01-26T22:20:39Z", "updated_at": null }, "entity": { "name": "customer-app-domain1.com", "router_group_guid": null } }, { "metadata": { "guid": "ee8f9aac-b5e7-4aaa-9151-1fd38053e575", "url": "/v2/shared_domains/ee8f9aac-b5e7-4aaa-9151-1fd38053e575", "created_at": "2016-01-26T22:20:39Z", "updated_at": null }, "entity": { "name": "customer-app-domain2.com", "router_group_guid": null } }, { "metadata": { "guid": "1801df07-a10f-4c85-bab1-506726095086", "url": "/v2/shared_domains/1801df07-a10f-4c85-bab1-506726095086", "created_at": "2016-01-26T22:20:40Z", "updated_at": null }, "entity": { "name": "domain-68.example.com", "router_group_guid": null } }, { "metadata": { "guid": "3594ec2c-4efa-432d-a2db-1c3b111d3a5a", "url": "/v2/shared_domains/3594ec2c-4efa-432d-a2db-1c3b111d3a5a", "created_at": "2016-01-26T22:20:40Z", "updated_at": null }, "entity": { "name": "domain-69.example.com", "router_group_guid": null } }, { "metadata": { "guid": "b7d24ea0-7fff-40aa-bd95-e5510675b4a8", "url": "/v2/shared_domains/b7d24ea0-7fff-40aa-bd95-e5510675b4a8", "created_at": "2016-01-26T22:20:40Z", "updated_at": null }, "entity": { "name": "domain-70.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