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.eyJ1c2VyX2lkIjoidWFhLWlkLTI1MiIsImVtYWlsIjoiZW1haWwtMTgwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzE2NDY2Mzh9.AOeYIrpQmAPAidnsqi2FBJ00lY6HJnEhIeKSFqWVsV0 Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/shared_domains" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI1MiIsImVtYWlsIjoiZW1haWwtMTgwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzE2NDY2Mzh9.AOeYIrpQmAPAidnsqi2FBJ00lY6HJnEhIeKSFqWVsV0" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 5, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "a5a8dd53-df40-45a0-b04b-1cdc71bdc545", "url": "/v2/shared_domains/a5a8dd53-df40-45a0-b04b-1cdc71bdc545", "created_at": "2015-05-07T23:37:05Z", "updated_at": null }, "entity": { "name": "customer-app-domain1.com" } }, { "metadata": { "guid": "a136be4a-60a6-47db-969d-bb14009d3e86", "url": "/v2/shared_domains/a136be4a-60a6-47db-969d-bb14009d3e86", "created_at": "2015-05-07T23:37:05Z", "updated_at": null }, "entity": { "name": "customer-app-domain2.com" } }, { "metadata": { "guid": "06bb2b59-1779-4b71-8f13-07cfd28adcb6", "url": "/v2/shared_domains/06bb2b59-1779-4b71-8f13-07cfd28adcb6", "created_at": "2015-05-07T23:37:18Z", "updated_at": null }, "entity": { "name": "domain-26.example.com" } }, { "metadata": { "guid": "a91c4654-a34d-4497-95d0-66cba583fccd", "url": "/v2/shared_domains/a91c4654-a34d-4497-95d0-66cba583fccd", "created_at": "2015-05-07T23:37:18Z", "updated_at": null }, "entity": { "name": "domain-27.example.com" } }, { "metadata": { "guid": "2bf4e925-a7eb-4ba0-a16c-21bcd9f18ce4", "url": "/v2/shared_domains/2bf4e925-a7eb-4ba0-a16c-21bcd9f18ce4", "created_at": "2015-05-07T23:37:18Z", "updated_at": null }, "entity": { "name": "domain-28.example.com" } } ] }
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: 963c15e8-c64d-4e9b-9376-d6381efe5e2e Content-Length: 1666 X-Content-Type-Options: nosniff