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.eyJ1c2VyX2lkIjoidWFhLWlkLTE0NyIsImVtYWlsIjoiZW1haWwtMTIwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTc0NjIzNTl9.OtZPDWGEeTyWHJ98FYwWYE-Vo6lMz1yhh39VhbKIpNw Host: example.org Cookie:
GET /v2/shared_domains
curl "https://api.[your-domain.com]/v2/shared_domains" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE0NyIsImVtYWlsIjoiZW1haWwtMTIwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTc0NjIzNTl9.OtZPDWGEeTyWHJ98FYwWYE-Vo6lMz1yhh39VhbKIpNw" \ -H "Host: example.org" \ -H "Cookie: "
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: 66c3f149-d57a-4886-95ad-b5a1115c6984 Content-Length: 1690 X-Content-Type-Options: nosniff
200 OK
{ "total_results": 5, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "34923485-39f0-4173-a71f-8d7bdcc4efd8", "url": "/v2/shared_domains/34923485-39f0-4173-a71f-8d7bdcc4efd8", "created_at": "2014-11-24T19:32:34+00:00", "updated_at": null }, "entity": { "name": "customer-app-domain1.com" } }, { "metadata": { "guid": "143cefa0-5b31-4cdc-9379-d95dd4fdcb06", "url": "/v2/shared_domains/143cefa0-5b31-4cdc-9379-d95dd4fdcb06", "created_at": "2014-11-24T19:32:34+00:00", "updated_at": null }, "entity": { "name": "customer-app-domain2.com" } }, { "metadata": { "guid": "fb3b4ad3-aed8-4e6e-87ad-7e71a782dab5", "url": "/v2/shared_domains/fb3b4ad3-aed8-4e6e-87ad-7e71a782dab5", "created_at": "2014-11-24T19:32:39+00:00", "updated_at": null }, "entity": { "name": "domain-9.example.com" } }, { "metadata": { "guid": "faa63b6b-fb2e-43b3-9b49-75f2d439cad2", "url": "/v2/shared_domains/faa63b6b-fb2e-43b3-9b49-75f2d439cad2", "created_at": "2014-11-24T19:32:39+00:00", "updated_at": null }, "entity": { "name": "domain-10.example.com" } }, { "metadata": { "guid": "0492d92c-2ad8-4062-af74-94fe6c334def", "url": "/v2/shared_domains/0492d92c-2ad8-4062-af74-94fe6c334def", "created_at": "2014-11-24T19:32:39+00:00", "updated_at": null }, "entity": { "name": "domain-11.example.com" } } ] }