GET /v2/private_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 |
|
|
Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIyNSIsImVtYWlsIjoiZW1haWwtMTYxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTM4MzcyNzJ9.XU4pj2HQIk_Um9j7Uj1ULaF4lPt4vQqaMmumMkfkoqE Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/private_domains" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIyNSIsImVtYWlsIjoiZW1haWwtMTYxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTM4MzcyNzJ9.XU4pj2HQIk_Um9j7Uj1ULaF4lPt4vQqaMmumMkfkoqE" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{
"total_results": 4,
"total_pages": 1,
"prev_url": null,
"next_url": null,
"resources": [
{
"metadata": {
"guid": "9083cf20-d8a0-4d41-ae96-e2e568338a9a",
"url": "/v2/private_domains/9083cf20-d8a0-4d41-ae96-e2e568338a9a",
"created_at": "2016-01-19T19:41:01Z",
"updated_at": null
},
"entity": {
"name": "vcap.me",
"owning_organization_guid": "a1c935f8-7bc0-4ad8-b8de-840bc89f5171",
"owning_organization_url": "/v2/organizations/a1c935f8-7bc0-4ad8-b8de-840bc89f5171",
"shared_organizations_url": "/v2/private_domains/9083cf20-d8a0-4d41-ae96-e2e568338a9a/shared_organizations"
}
},
{
"metadata": {
"guid": "056254e5-85f1-4a28-a756-a7421abdddd6",
"url": "/v2/private_domains/056254e5-85f1-4a28-a756-a7421abdddd6",
"created_at": "2016-01-19T19:41:11Z",
"updated_at": null
},
"entity": {
"name": "domain-19.example.com",
"owning_organization_guid": "3252d65a-c387-4121-b470-2dbf899fa2d3",
"owning_organization_url": "/v2/organizations/3252d65a-c387-4121-b470-2dbf899fa2d3",
"shared_organizations_url": "/v2/private_domains/056254e5-85f1-4a28-a756-a7421abdddd6/shared_organizations"
}
},
{
"metadata": {
"guid": "bbbeed66-6cc0-44b7-87e5-a80ac16c62cc",
"url": "/v2/private_domains/bbbeed66-6cc0-44b7-87e5-a80ac16c62cc",
"created_at": "2016-01-19T19:41:11Z",
"updated_at": null
},
"entity": {
"name": "domain-20.example.com",
"owning_organization_guid": "d0329327-4593-48b6-9a87-dcd390222234",
"owning_organization_url": "/v2/organizations/d0329327-4593-48b6-9a87-dcd390222234",
"shared_organizations_url": "/v2/private_domains/bbbeed66-6cc0-44b7-87e5-a80ac16c62cc/shared_organizations"
}
},
{
"metadata": {
"guid": "2e737a50-12a1-463f-bdc4-aa36e9a5e1ff",
"url": "/v2/private_domains/2e737a50-12a1-463f-bdc4-aa36e9a5e1ff",
"created_at": "2016-01-19T19:41:11Z",
"updated_at": null
},
"entity": {
"name": "domain-21.example.com",
"owning_organization_guid": "e688a1d8-6520-48cd-8dc8-338fdc75a12a",
"owning_organization_url": "/v2/organizations/e688a1d8-6520-48cd-8dc8-338fdc75a12a",
"shared_organizations_url": "/v2/private_domains/2e737a50-12a1-463f-bdc4-aa36e9a5e1ff/shared_organizations"
}
}
]
}
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: Content-Length: 2483 X-Content-Type-Options: nosniff