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 |
|
|
Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTExNSIsImVtYWlsIjoiZW1haWwtODRAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ2MzYxODcwOH0.6kAja8qW03-tEzu0EMVfmjIJ7G7zOgi6Ht2MoGZAqB0 Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/shared_domains" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTExNSIsImVtYWlsIjoiZW1haWwtODRAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ2MzYxODcwOH0.6kAja8qW03-tEzu0EMVfmjIJ7G7zOgi6Ht2MoGZAqB0" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 6, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "0b84cdf8-3e5e-40e7-b720-a79660db05ea", "url": "/v2/shared_domains/0b84cdf8-3e5e-40e7-b720-a79660db05ea", "created_at": "2016-05-12T00:45:03Z", "updated_at": null }, "entity": { "name": "customer-app-domain1.com", "router_group_guid": null, "router_group_type": null } }, { "metadata": { "guid": "8fdf9817-66cf-474a-96c8-a70a86c7eb08", "url": "/v2/shared_domains/8fdf9817-66cf-474a-96c8-a70a86c7eb08", "created_at": "2016-05-12T00:45:03Z", "updated_at": null }, "entity": { "name": "customer-app-domain2.com", "router_group_guid": null, "router_group_type": null } }, { "metadata": { "guid": "e1681d78-1424-47b7-8ab0-5f93445d64a9", "url": "/v2/shared_domains/e1681d78-1424-47b7-8ab0-5f93445d64a9", "created_at": "2016-05-12T00:45:08Z", "updated_at": null }, "entity": { "name": "domain-43.example.com", "router_group_guid": null, "router_group_type": null } }, { "metadata": { "guid": "9e95e105-ca7a-4fb5-93a8-5d810ea74b43", "url": "/v2/shared_domains/9e95e105-ca7a-4fb5-93a8-5d810ea74b43", "created_at": "2016-05-12T00:45:08Z", "updated_at": null }, "entity": { "name": "domain-44.example.com", "router_group_guid": null, "router_group_type": null } }, { "metadata": { "guid": "43e646b3-dd31-4726-a5d6-f2e4141acfb1", "url": "/v2/shared_domains/43e646b3-dd31-4726-a5d6-f2e4141acfb1", "created_at": "2016-05-12T00:45:08Z", "updated_at": null }, "entity": { "name": "domain-45.example.com", "router_group_guid": null, "router_group_type": null } }, { "metadata": { "guid": "95f27b33-379d-43e5-b983-8af039a40469", "url": "/v2/shared_domains/95f27b33-379d-43e5-b983-8af039a40469", "created_at": "2016-05-12T00:45:08Z", "updated_at": null }, "entity": { "name": "domain-46.example.com", "router_group_guid": "my-random-guid", "router_group_type": "tcp" } } ] }
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: 1848bf99-59af-4ac6-a0d6-85c3911190aa Content-Length: 2410 X-Content-Type-Options: nosniff