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.eyJ1c2VyX2lkIjoidWFhLWlkLTM2MCIsImVtYWlsIjoiZW1haWwtMjYyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDUzNjIzMTd9.N2aJlKp0OKptyIHQpb9_WakE3maOawri4f5dTtjwZT4 Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/shared_domains" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM2MCIsImVtYWlsIjoiZW1haWwtMjYyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDUzNjIzMTd9.N2aJlKp0OKptyIHQpb9_WakE3maOawri4f5dTtjwZT4" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 5, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "159aa6b5-89d1-4021-a883-5c265c7d1a0a", "url": "/v2/shared_domains/159aa6b5-89d1-4021-a883-5c265c7d1a0a", "created_at": "2015-10-13T17:31:45Z", "updated_at": null }, "entity": { "name": "customer-app-domain1.com", "router_group_guid": null } }, { "metadata": { "guid": "12b8addd-be70-4a3c-956f-28d05edbb193", "url": "/v2/shared_domains/12b8addd-be70-4a3c-956f-28d05edbb193", "created_at": "2015-10-13T17:31:45Z", "updated_at": null }, "entity": { "name": "customer-app-domain2.com", "router_group_guid": null } }, { "metadata": { "guid": "3a35fec8-a104-48f0-859a-cbba48863e27", "url": "/v2/shared_domains/3a35fec8-a104-48f0-859a-cbba48863e27", "created_at": "2015-10-13T17:31:57Z", "updated_at": null }, "entity": { "name": "domain-46.example.com", "router_group_guid": null } }, { "metadata": { "guid": "6ca9a124-0ebd-4969-bf86-d0b9c48c3468", "url": "/v2/shared_domains/6ca9a124-0ebd-4969-bf86-d0b9c48c3468", "created_at": "2015-10-13T17:31:57Z", "updated_at": null }, "entity": { "name": "domain-47.example.com", "router_group_guid": null } }, { "metadata": { "guid": "610106a0-c583-4942-a1ec-4ccf2849cb62", "url": "/v2/shared_domains/610106a0-c583-4942-a1ec-4ccf2849cb62", "created_at": "2015-10-13T17:31:57Z", "updated_at": null }, "entity": { "name": "domain-48.example.com", "router_group_guid": null } } ] }
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: 68971d14-ab44-4688-84c6-7d998ca906c8 Content-Length: 1841 X-Content-Type-Options: nosniff