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.eyJ1c2VyX2lkIjoidWFhLWlkLTE5MCIsImVtYWlsIjoiZW1haWwtMTUyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjczMjM5Njh9.9Gkxb5eVg86UGcQm2-l8KHxm_mUz9BWCtx3pbY6Fqlw Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/shared_domains" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE5MCIsImVtYWlsIjoiZW1haWwtMTUyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjczMjM5Njh9.9Gkxb5eVg86UGcQm2-l8KHxm_mUz9BWCtx3pbY6Fqlw" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 5, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "e63b955d-66c6-4d6e-8a66-b68260c4f670", "url": "/v2/shared_domains/e63b955d-66c6-4d6e-8a66-b68260c4f670", "created_at": "2015-03-18T22:52:45Z", "updated_at": null }, "entity": { "name": "customer-app-domain1.com" } }, { "metadata": { "guid": "906bad5e-b7da-4fd1-a15c-46527364d155", "url": "/v2/shared_domains/906bad5e-b7da-4fd1-a15c-46527364d155", "created_at": "2015-03-18T22:52:45Z", "updated_at": null }, "entity": { "name": "customer-app-domain2.com" } }, { "metadata": { "guid": "af20a163-cd7f-4351-92c4-da62e2b945d9", "url": "/v2/shared_domains/af20a163-cd7f-4351-92c4-da62e2b945d9", "created_at": "2015-03-18T22:52:48Z", "updated_at": null }, "entity": { "name": "domain-37.example.com" } }, { "metadata": { "guid": "82f107ce-fb3d-4027-b180-2a370aaa6f46", "url": "/v2/shared_domains/82f107ce-fb3d-4027-b180-2a370aaa6f46", "created_at": "2015-03-18T22:52:48Z", "updated_at": null }, "entity": { "name": "domain-38.example.com" } }, { "metadata": { "guid": "72b02a2a-d1bd-4147-a74f-9636b5dec1f0", "url": "/v2/shared_domains/72b02a2a-d1bd-4147-a74f-9636b5dec1f0", "created_at": "2015-03-18T22:52:48Z", "updated_at": null }, "entity": { "name": "domain-39.example.com" } } ] }
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: 95a30687-6642-4270-8306-d3ba13eb9e1b Content-Length: 1666 X-Content-Type-Options: nosniff