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.eyJ1c2VyX2lkIjoidWFhLWlkLTQzNyIsImVtYWlsIjoiZW1haWwtMzA1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDgwMzg5NzR9.XtGxSdcRNR1TPv2qEYluTV2KqUaOmenrHtXqeYUTa-M Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/shared_domains" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQzNyIsImVtYWlsIjoiZW1haWwtMzA1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDgwMzg5NzR9.XtGxSdcRNR1TPv2qEYluTV2KqUaOmenrHtXqeYUTa-M" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 5, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "44c9555f-3e7a-4849-a708-a1ab5aacf6c4", "url": "/v2/shared_domains/44c9555f-3e7a-4849-a708-a1ab5aacf6c4", "created_at": "2015-11-13T17:02:45Z", "updated_at": null }, "entity": { "name": "customer-app-domain1.com", "router_group_guid": null } }, { "metadata": { "guid": "c1ec7d6d-ec97-4afb-a191-2038eb611015", "url": "/v2/shared_domains/c1ec7d6d-ec97-4afb-a191-2038eb611015", "created_at": "2015-11-13T17:02:45Z", "updated_at": null }, "entity": { "name": "customer-app-domain2.com", "router_group_guid": null } }, { "metadata": { "guid": "a609dc58-9421-493f-9102-8ee157629c50", "url": "/v2/shared_domains/a609dc58-9421-493f-9102-8ee157629c50", "created_at": "2015-11-13T17:02:54Z", "updated_at": null }, "entity": { "name": "domain-49.example.com", "router_group_guid": null } }, { "metadata": { "guid": "59a3f0e6-21ee-47f0-b782-72175e3d19e3", "url": "/v2/shared_domains/59a3f0e6-21ee-47f0-b782-72175e3d19e3", "created_at": "2015-11-13T17:02:54Z", "updated_at": null }, "entity": { "name": "domain-50.example.com", "router_group_guid": null } }, { "metadata": { "guid": "c2d103c5-2790-4e55-b597-4533d4666c66", "url": "/v2/shared_domains/c2d103c5-2790-4e55-b597-4533d4666c66", "created_at": "2015-11-13T17:02:54Z", "updated_at": null }, "entity": { "name": "domain-51.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