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. |
|
|
|
name | The name of the domain. |
|
|
Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIzNiIsImVtYWlsIjoiZW1haWwtMTU0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzM5ODExMTB9.vPGcIc_hShGUcTy1kovkJAfAN3-ddl4FI5y92dmh-eU Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/shared_domains" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIzNiIsImVtYWlsIjoiZW1haWwtMTU0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzM5ODExMTB9.vPGcIc_hShGUcTy1kovkJAfAN3-ddl4FI5y92dmh-eU" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 5, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "4d30b491-9432-45a7-9120-d94b651ef821", "url": "/v2/shared_domains/4d30b491-9432-45a7-9120-d94b651ef821", "created_at": "2015-06-04T00:05:05Z", "updated_at": null }, "entity": { "name": "customer-app-domain1.com" } }, { "metadata": { "guid": "7391020f-4c4c-4e7c-b507-3302d446dbc8", "url": "/v2/shared_domains/7391020f-4c4c-4e7c-b507-3302d446dbc8", "created_at": "2015-06-04T00:05:05Z", "updated_at": null }, "entity": { "name": "customer-app-domain2.com" } }, { "metadata": { "guid": "ece566ee-2db3-4e67-be76-8b513c2df038", "url": "/v2/shared_domains/ece566ee-2db3-4e67-be76-8b513c2df038", "created_at": "2015-06-04T00:05:10Z", "updated_at": null }, "entity": { "name": "domain-19.example.com" } }, { "metadata": { "guid": "00c00ce1-b936-44eb-98e0-063ab53da768", "url": "/v2/shared_domains/00c00ce1-b936-44eb-98e0-063ab53da768", "created_at": "2015-06-04T00:05:10Z", "updated_at": null }, "entity": { "name": "domain-20.example.com" } }, { "metadata": { "guid": "982c7bd5-0faa-4925-bb0e-ce0173dc90e3", "url": "/v2/shared_domains/982c7bd5-0faa-4925-bb0e-ce0173dc90e3", "created_at": "2015-06-04T00:05:10Z", "updated_at": null }, "entity": { "name": "domain-21.example.com" } } ] }
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: ee9ee3a3-0b78-4952-aa97-bd5da87742f5 Content-Length: 1666 X-Content-Type-Options: nosniff