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.eyJ1c2VyX2lkIjoidWFhLWlkLTQxOCIsImVtYWlsIjoiZW1haWwtMzE0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDcxMTY4NTh9.0FkqCjxcpKPYd5gghrHkTTvRkvBO34nYADRJCqJ9anc Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/shared_domains" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQxOCIsImVtYWlsIjoiZW1haWwtMzE0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDcxMTY4NTh9.0FkqCjxcpKPYd5gghrHkTTvRkvBO34nYADRJCqJ9anc" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 5, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "2bd654ef-9343-4dcf-ae9d-940da1b1009e", "url": "/v2/shared_domains/2bd654ef-9343-4dcf-ae9d-940da1b1009e", "created_at": "2015-11-03T00:54:10Z", "updated_at": null }, "entity": { "name": "customer-app-domain1.com", "router_group_guid": null } }, { "metadata": { "guid": "08cfdbb8-cb5f-470c-b687-5f7f0135f8ed", "url": "/v2/shared_domains/08cfdbb8-cb5f-470c-b687-5f7f0135f8ed", "created_at": "2015-11-03T00:54:10Z", "updated_at": null }, "entity": { "name": "customer-app-domain2.com", "router_group_guid": null } }, { "metadata": { "guid": "86ee72cc-6e3e-4f40-8a31-cd6ad5f1271a", "url": "/v2/shared_domains/86ee72cc-6e3e-4f40-8a31-cd6ad5f1271a", "created_at": "2015-11-03T00:54:18Z", "updated_at": null }, "entity": { "name": "domain-72.example.com", "router_group_guid": null } }, { "metadata": { "guid": "c9e92988-683e-4b61-a375-18d744117b1b", "url": "/v2/shared_domains/c9e92988-683e-4b61-a375-18d744117b1b", "created_at": "2015-11-03T00:54:18Z", "updated_at": null }, "entity": { "name": "domain-73.example.com", "router_group_guid": null } }, { "metadata": { "guid": "c5ecee4d-12ba-45fc-9c57-7934ab743830", "url": "/v2/shared_domains/c5ecee4d-12ba-45fc-9c57-7934ab743830", "created_at": "2015-11-03T00:54:18Z", "updated_at": null }, "entity": { "name": "domain-74.example.com", "router_group_guid": null } } ] }
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: 04626d94-dec8-423d-a981-70ab4f0e3ab5 Content-Length: 1841 X-Content-Type-Options: nosniff