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.eyJ1c2VyX2lkIjoidWFhLWlkLTMzNCIsImVtYWlsIjoiZW1haWwtMjM2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQ0NzE3MDd9.QGc95AIPecNPS7_vtRnmj-q3BvPwOGwp5fvN_muEXIc Host: example.org Cookie:
GET /v2/shared_domains
curl "https://api.[your-domain.com]/v2/shared_domains" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMzNCIsImVtYWlsIjoiZW1haWwtMjM2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQ0NzE3MDd9.QGc95AIPecNPS7_vtRnmj-q3BvPwOGwp5fvN_muEXIc" \ -H "Host: example.org" \ -H "Cookie: "
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: c542509b-15d4-4a92-a9e2-0e69bfab9141 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": "22c877fe-017b-4379-b32e-425c5a7ceece", "url": "/v2/shared_domains/22c877fe-017b-4379-b32e-425c5a7ceece", "created_at": "2015-02-13T22:34:58Z", "updated_at": null }, "entity": { "name": "customer-app-domain1.com" } }, { "metadata": { "guid": "53fc975f-5bac-405a-bed6-d7c60d1a2be5", "url": "/v2/shared_domains/53fc975f-5bac-405a-bed6-d7c60d1a2be5", "created_at": "2015-02-13T22:34:58Z", "updated_at": null }, "entity": { "name": "customer-app-domain2.com" } }, { "metadata": { "guid": "abc58bf9-f25d-43db-90d7-2108ed579193", "url": "/v2/shared_domains/abc58bf9-f25d-43db-90d7-2108ed579193", "created_at": "2015-02-13T22:35:07Z", "updated_at": null }, "entity": { "name": "domain-35.example.com" } }, { "metadata": { "guid": "da65cb0c-228c-455f-a9f3-9fd9ec3d7687", "url": "/v2/shared_domains/da65cb0c-228c-455f-a9f3-9fd9ec3d7687", "created_at": "2015-02-13T22:35:07Z", "updated_at": null }, "entity": { "name": "domain-36.example.com" } }, { "metadata": { "guid": "bd26f3f8-2bc6-4e44-b8fa-ae275ddf7fb6", "url": "/v2/shared_domains/bd26f3f8-2bc6-4e44-b8fa-ae275ddf7fb6", "created_at": "2015-02-13T22:35:07Z", "updated_at": null }, "entity": { "name": "domain-37.example.com" } } ] }