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.eyJ1c2VyX2lkIjoidWFhLWlkLTI5NCIsImVtYWlsIjoiZW1haWwtMjE1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mjk2NjQxNDh9.5zQ63-qqORaEUZyX7o4VR-KcLCGD_zqOxQvu7RyhakY Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/shared_domains" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI5NCIsImVtYWlsIjoiZW1haWwtMjE1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mjk2NjQxNDh9.5zQ63-qqORaEUZyX7o4VR-KcLCGD_zqOxQvu7RyhakY" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 5, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "aa0a6dd6-f855-4a0c-9268-fb6d13b01cce", "url": "/v2/shared_domains/aa0a6dd6-f855-4a0c-9268-fb6d13b01cce", "created_at": "2015-04-15T00:55:46Z", "updated_at": null }, "entity": { "name": "customer-app-domain1.com" } }, { "metadata": { "guid": "00853c3c-8e24-4345-a7e0-4c3a809cd2dd", "url": "/v2/shared_domains/00853c3c-8e24-4345-a7e0-4c3a809cd2dd", "created_at": "2015-04-15T00:55:46Z", "updated_at": null }, "entity": { "name": "customer-app-domain2.com" } }, { "metadata": { "guid": "87818d59-982b-4b07-b9c5-0cc9b0d576e6", "url": "/v2/shared_domains/87818d59-982b-4b07-b9c5-0cc9b0d576e6", "created_at": "2015-04-15T00:55:48Z", "updated_at": null }, "entity": { "name": "domain-45.example.com" } }, { "metadata": { "guid": "eab31e7c-9f6f-43fc-83fe-6f693ea2db95", "url": "/v2/shared_domains/eab31e7c-9f6f-43fc-83fe-6f693ea2db95", "created_at": "2015-04-15T00:55:48Z", "updated_at": null }, "entity": { "name": "domain-46.example.com" } }, { "metadata": { "guid": "9548fae1-fb71-4308-84e6-645ba1a04820", "url": "/v2/shared_domains/9548fae1-fb71-4308-84e6-645ba1a04820", "created_at": "2015-04-15T00:55:48Z", "updated_at": null }, "entity": { "name": "domain-47.example.com" } } ] }
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: fb7087ce-88e4-4df4-9e68-595f29ad8ea1 Content-Length: 1666 X-Content-Type-Options: nosniff