Name | Description | Default | Valid Values | Example Values |
---|---|---|---|---|
guid | The guid of the domain. |
|
|
|
name | The name of the domain. |
|
|
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 |
|
|
Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI5IiwiZW1haWwiOiJlbWFpbC0yOUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI0MTM3MzYzfQ.M7TcSmVxs22--mhFIlhPAl7sOGPSrfkTfXqw6KcpFn8 Host: example.org Cookie:
GET /v2/shared_domains
curl "https://api.[your-domain.com]/v2/shared_domains" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI5IiwiZW1haWwiOiJlbWFpbC0yOUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI0MTM3MzYzfQ.M7TcSmVxs22--mhFIlhPAl7sOGPSrfkTfXqw6KcpFn8" \ -H "Host: example.org" \ -H "Cookie: "
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: 4ba8f7f6-2f8e-47d8-9ef9-f982ba870517 Content-Length: 1666 X-Content-Type-Options: nosniff
200 OK
{ "total_results": 5, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "e99d6753-3eb1-4e8b-b16a-d4f1acad4850", "url": "/v2/shared_domains/e99d6753-3eb1-4e8b-b16a-d4f1acad4850", "created_at": "2015-02-10T01:42:41Z", "updated_at": null }, "entity": { "name": "customer-app-domain1.com" } }, { "metadata": { "guid": "a0b42f7c-dfb0-4464-86d4-4b33c5d56a68", "url": "/v2/shared_domains/a0b42f7c-dfb0-4464-86d4-4b33c5d56a68", "created_at": "2015-02-10T01:42:41Z", "updated_at": null }, "entity": { "name": "customer-app-domain2.com" } }, { "metadata": { "guid": "437bcb46-fc1f-4e27-896b-a0f3cd3816ac", "url": "/v2/shared_domains/437bcb46-fc1f-4e27-896b-a0f3cd3816ac", "created_at": "2015-02-10T01:42:43Z", "updated_at": null }, "entity": { "name": "domain-10.example.com" } }, { "metadata": { "guid": "461da95c-0bf0-469e-986a-099d90cd67e7", "url": "/v2/shared_domains/461da95c-0bf0-469e-986a-099d90cd67e7", "created_at": "2015-02-10T01:42:43Z", "updated_at": null }, "entity": { "name": "domain-11.example.com" } }, { "metadata": { "guid": "e5da0fc8-b8de-4989-9e95-e30ad1761716", "url": "/v2/shared_domains/e5da0fc8-b8de-4989-9e95-e30ad1761716", "created_at": "2015-02-10T01:42:43Z", "updated_at": null }, "entity": { "name": "domain-12.example.com" } } ] }