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.eyJ1c2VyX2lkIjoidWFhLWlkLTIyOCIsImVtYWlsIjoiZW1haWwtMTYwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mjc0ODA4NTZ9.B8UL6A8RjsyRxEGcM6BkuSH0UROittlih65jt9eUMcM Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/shared_domains" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIyOCIsImVtYWlsIjoiZW1haWwtMTYwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mjc0ODA4NTZ9.B8UL6A8RjsyRxEGcM6BkuSH0UROittlih65jt9eUMcM" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 5, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "daad3207-a49a-4918-b5c0-fbe625fb9e57", "url": "/v2/shared_domains/daad3207-a49a-4918-b5c0-fbe625fb9e57", "created_at": "2015-03-20T18:27:18Z", "updated_at": null }, "entity": { "name": "customer-app-domain1.com" } }, { "metadata": { "guid": "eb2dcad2-f64e-4ba7-bb6d-eebb49e5675a", "url": "/v2/shared_domains/eb2dcad2-f64e-4ba7-bb6d-eebb49e5675a", "created_at": "2015-03-20T18:27:18Z", "updated_at": null }, "entity": { "name": "customer-app-domain2.com" } }, { "metadata": { "guid": "4e2f84c3-86a8-4586-84cf-93e5a513ec2a", "url": "/v2/shared_domains/4e2f84c3-86a8-4586-84cf-93e5a513ec2a", "created_at": "2015-03-20T18:27:36Z", "updated_at": null }, "entity": { "name": "domain-32.example.com" } }, { "metadata": { "guid": "10fa7005-84b2-45f9-baf6-e31ce5e1ded8", "url": "/v2/shared_domains/10fa7005-84b2-45f9-baf6-e31ce5e1ded8", "created_at": "2015-03-20T18:27:36Z", "updated_at": null }, "entity": { "name": "domain-33.example.com" } }, { "metadata": { "guid": "22ad4d48-82bf-476c-ba19-8c0a5eda377c", "url": "/v2/shared_domains/22ad4d48-82bf-476c-ba19-8c0a5eda377c", "created_at": "2015-03-20T18:27:36Z", "updated_at": null }, "entity": { "name": "domain-34.example.com" } } ] }
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: f45f7d68-b1f7-4a35-973c-c0e02cad0896 Content-Length: 1666 X-Content-Type-Options: nosniff