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.eyJ1c2VyX2lkIjoidWFhLWlkLTQxOSIsImVtYWlsIjoiZW1haWwtMjkwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTMzMTA5OTN9.QzjsiVTlPJgTbxFHCdh2tBQm9aeYFYj-xcwMfZ0wQQs Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/shared_domains" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQxOSIsImVtYWlsIjoiZW1haWwtMjkwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTMzMTA5OTN9.QzjsiVTlPJgTbxFHCdh2tBQm9aeYFYj-xcwMfZ0wQQs" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 5, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "51932d3a-c165-471c-a809-a972993d8e6a", "url": "/v2/shared_domains/51932d3a-c165-471c-a809-a972993d8e6a", "created_at": "2016-01-13T17:29:37Z", "updated_at": null }, "entity": { "name": "customer-app-domain1.com", "router_group_guid": null } }, { "metadata": { "guid": "8ba99bca-85aa-42db-8feb-d67219cccd7a", "url": "/v2/shared_domains/8ba99bca-85aa-42db-8feb-d67219cccd7a", "created_at": "2016-01-13T17:29:37Z", "updated_at": null }, "entity": { "name": "customer-app-domain2.com", "router_group_guid": null } }, { "metadata": { "guid": "045d0d46-7875-4cf3-b8a4-996e02bed6a2", "url": "/v2/shared_domains/045d0d46-7875-4cf3-b8a4-996e02bed6a2", "created_at": "2016-01-13T17:29:53Z", "updated_at": null }, "entity": { "name": "domain-61.example.com", "router_group_guid": null } }, { "metadata": { "guid": "0b9bb21b-ff5d-4d90-a3b4-695daa7cfbff", "url": "/v2/shared_domains/0b9bb21b-ff5d-4d90-a3b4-695daa7cfbff", "created_at": "2016-01-13T17:29:53Z", "updated_at": null }, "entity": { "name": "domain-62.example.com", "router_group_guid": null } }, { "metadata": { "guid": "2fee7430-c5fe-4aa7-b73a-ea9493f2d843", "url": "/v2/shared_domains/2fee7430-c5fe-4aa7-b73a-ea9493f2d843", "created_at": "2016-01-13T17:29:53Z", "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