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 |
|
|
| Name | Description | Default | Valid Values | Example Values |
|---|
Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE5MCIsImVtYWlsIjoiZW1haWwtMTQxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjU5NDg2Njd9.VF8RYqbedDmfG6pxd4PWElgwBaqsKJKw_0JbpVMyGRM Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/private_domains" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE5MCIsImVtYWlsIjoiZW1haWwtMTQxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjU5NDg2Njd9.VF8RYqbedDmfG6pxd4PWElgwBaqsKJKw_0JbpVMyGRM" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{
"total_results": 4,
"total_pages": 1,
"prev_url": null,
"next_url": null,
"resources": [
{
"metadata": {
"guid": "80bd274b-0f34-4124-8022-f87a1900d6f9",
"url": "/v2/private_domains/80bd274b-0f34-4124-8022-f87a1900d6f9",
"created_at": "2015-03-03T00:51:04Z",
"updated_at": null
},
"entity": {
"name": "vcap.me",
"owning_organization_guid": "0b02a01b-f3fd-4fd4-ba4a-c3978ddb99d8",
"owning_organization_url": "/v2/organizations/0b02a01b-f3fd-4fd4-ba4a-c3978ddb99d8",
"shared_organizations_url": "/v2/private_domains/80bd274b-0f34-4124-8022-f87a1900d6f9/shared_organizations"
}
},
{
"metadata": {
"guid": "8b37e977-2da5-44d4-8ebb-9e7ad2a3c917",
"url": "/v2/private_domains/8b37e977-2da5-44d4-8ebb-9e7ad2a3c917",
"created_at": "2015-03-03T00:51:07Z",
"updated_at": null
},
"entity": {
"name": "domain-30.example.com",
"owning_organization_guid": "68f46465-fbda-49e7-9201-6812c5e64323",
"owning_organization_url": "/v2/organizations/68f46465-fbda-49e7-9201-6812c5e64323",
"shared_organizations_url": "/v2/private_domains/8b37e977-2da5-44d4-8ebb-9e7ad2a3c917/shared_organizations"
}
},
{
"metadata": {
"guid": "f822ccb2-9861-4ade-9d18-edfd13f15c91",
"url": "/v2/private_domains/f822ccb2-9861-4ade-9d18-edfd13f15c91",
"created_at": "2015-03-03T00:51:07Z",
"updated_at": null
},
"entity": {
"name": "domain-31.example.com",
"owning_organization_guid": "72735de7-a89d-4376-8ed3-e414400fa830",
"owning_organization_url": "/v2/organizations/72735de7-a89d-4376-8ed3-e414400fa830",
"shared_organizations_url": "/v2/private_domains/f822ccb2-9861-4ade-9d18-edfd13f15c91/shared_organizations"
}
},
{
"metadata": {
"guid": "e6a827ab-b482-4932-b578-7537a0763343",
"url": "/v2/private_domains/e6a827ab-b482-4932-b578-7537a0763343",
"created_at": "2015-03-03T00:51:07Z",
"updated_at": null
},
"entity": {
"name": "domain-32.example.com",
"owning_organization_guid": "1fa28e3b-8618-4d6e-aa28-00db572ebab8",
"owning_organization_url": "/v2/organizations/1fa28e3b-8618-4d6e-aa28-00db572ebab8",
"shared_organizations_url": "/v2/private_domains/e6a827ab-b482-4932-b578-7537a0763343/shared_organizations"
}
}
]
}
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: 5dbff872-1b10-4235-a08f-41647c63e3f5 Content-Length: 2483 X-Content-Type-Options: nosniff