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.eyJ1c2VyX2lkIjoidWFhLWlkLTMzMCIsImVtYWlsIjoiZW1haWwtMjMzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDU1NTc5NjJ9.-cHkXOJ5ECbh_4tTDBk3aywYtQ7DsfsBV01Exq-kgGo Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/private_domains" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMzMCIsImVtYWlsIjoiZW1haWwtMjMzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDU1NTc5NjJ9.-cHkXOJ5ECbh_4tTDBk3aywYtQ7DsfsBV01Exq-kgGo" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{
"total_results": 4,
"total_pages": 1,
"prev_url": null,
"next_url": null,
"resources": [
{
"metadata": {
"guid": "10a26b62-51cf-43ff-bd18-0a74c021d04b",
"url": "/v2/private_domains/10a26b62-51cf-43ff-bd18-0a74c021d04b",
"created_at": "2015-10-15T23:52:05Z",
"updated_at": null
},
"entity": {
"name": "vcap.me",
"owning_organization_guid": "5e8d96fc-25f6-42a0-9adf-5f56808619ff",
"owning_organization_url": "/v2/organizations/5e8d96fc-25f6-42a0-9adf-5f56808619ff",
"shared_organizations_url": "/v2/private_domains/10a26b62-51cf-43ff-bd18-0a74c021d04b/shared_organizations"
}
},
{
"metadata": {
"guid": "c6ec23a6-ae06-4303-8cec-82af53c99891",
"url": "/v2/private_domains/c6ec23a6-ae06-4303-8cec-82af53c99891",
"created_at": "2015-10-15T23:52:42Z",
"updated_at": null
},
"entity": {
"name": "domain-44.example.com",
"owning_organization_guid": "caceea5f-105a-49d8-b16d-9d63068ed8f3",
"owning_organization_url": "/v2/organizations/caceea5f-105a-49d8-b16d-9d63068ed8f3",
"shared_organizations_url": "/v2/private_domains/c6ec23a6-ae06-4303-8cec-82af53c99891/shared_organizations"
}
},
{
"metadata": {
"guid": "1e460651-3712-4981-8ed9-0a35b6024992",
"url": "/v2/private_domains/1e460651-3712-4981-8ed9-0a35b6024992",
"created_at": "2015-10-15T23:52:42Z",
"updated_at": null
},
"entity": {
"name": "domain-45.example.com",
"owning_organization_guid": "b9408785-24ce-40d3-bbde-98d2c697be68",
"owning_organization_url": "/v2/organizations/b9408785-24ce-40d3-bbde-98d2c697be68",
"shared_organizations_url": "/v2/private_domains/1e460651-3712-4981-8ed9-0a35b6024992/shared_organizations"
}
},
{
"metadata": {
"guid": "54ff6a7f-afff-48bb-8974-538edee8e0af",
"url": "/v2/private_domains/54ff6a7f-afff-48bb-8974-538edee8e0af",
"created_at": "2015-10-15T23:52:42Z",
"updated_at": null
},
"entity": {
"name": "domain-46.example.com",
"owning_organization_guid": "b44b4df5-1ad5-4106-b9cf-9de6a37090b2",
"owning_organization_url": "/v2/organizations/b44b4df5-1ad5-4106-b9cf-9de6a37090b2",
"shared_organizations_url": "/v2/private_domains/54ff6a7f-afff-48bb-8974-538edee8e0af/shared_organizations"
}
}
]
}
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: 8b1f30ba-eeae-4d86-b7a2-acbb4c7477ef Content-Length: 2483 X-Content-Type-Options: nosniff