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.eyJ1c2VyX2lkIjoidWFhLWlkLTM5NiIsImVtYWlsIjoiZW1haWwtMjg2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mzk0MjYyMTV9.s-vhZhF4zMbry6rYwWqLnY0ha98UxnRf7Sm9i4eyAQw Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/private_domains" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM5NiIsImVtYWlsIjoiZW1haWwtMjg2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mzk0MjYyMTV9.s-vhZhF4zMbry6rYwWqLnY0ha98UxnRf7Sm9i4eyAQw" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{
"total_results": 4,
"total_pages": 1,
"prev_url": null,
"next_url": null,
"resources": [
{
"metadata": {
"guid": "b011733f-f903-45c9-bf7e-c7e520326281",
"url": "/v2/private_domains/b011733f-f903-45c9-bf7e-c7e520326281",
"created_at": "2015-08-06T00:36:47Z",
"updated_at": null
},
"entity": {
"name": "vcap.me",
"owning_organization_guid": "93abd258-7e8a-41f7-a559-347b48cf1f4c",
"owning_organization_url": "/v2/organizations/93abd258-7e8a-41f7-a559-347b48cf1f4c",
"shared_organizations_url": "/v2/private_domains/b011733f-f903-45c9-bf7e-c7e520326281/shared_organizations"
}
},
{
"metadata": {
"guid": "8a16acc1-cea8-4c5c-ab2c-0cf91098521b",
"url": "/v2/private_domains/8a16acc1-cea8-4c5c-ab2c-0cf91098521b",
"created_at": "2015-08-06T00:36:55Z",
"updated_at": null
},
"entity": {
"name": "domain-37.example.com",
"owning_organization_guid": "292ce400-f5ad-4dc6-bb19-264984ccedc9",
"owning_organization_url": "/v2/organizations/292ce400-f5ad-4dc6-bb19-264984ccedc9",
"shared_organizations_url": "/v2/private_domains/8a16acc1-cea8-4c5c-ab2c-0cf91098521b/shared_organizations"
}
},
{
"metadata": {
"guid": "e0992213-8618-4731-813e-b8282e2d6611",
"url": "/v2/private_domains/e0992213-8618-4731-813e-b8282e2d6611",
"created_at": "2015-08-06T00:36:55Z",
"updated_at": null
},
"entity": {
"name": "domain-38.example.com",
"owning_organization_guid": "ad4947d5-93b6-4c6e-ae80-268cd95c99fb",
"owning_organization_url": "/v2/organizations/ad4947d5-93b6-4c6e-ae80-268cd95c99fb",
"shared_organizations_url": "/v2/private_domains/e0992213-8618-4731-813e-b8282e2d6611/shared_organizations"
}
},
{
"metadata": {
"guid": "bffd4c34-aa3c-41b3-84f4-d00321739cba",
"url": "/v2/private_domains/bffd4c34-aa3c-41b3-84f4-d00321739cba",
"created_at": "2015-08-06T00:36:55Z",
"updated_at": null
},
"entity": {
"name": "domain-39.example.com",
"owning_organization_guid": "ad9795d7-3389-468b-bacb-e34af604aad4",
"owning_organization_url": "/v2/organizations/ad9795d7-3389-468b-bacb-e34af604aad4",
"shared_organizations_url": "/v2/private_domains/bffd4c34-aa3c-41b3-84f4-d00321739cba/shared_organizations"
}
}
]
}
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: 72d8fdfb-869e-4abd-9e5c-2def69f74d8a Content-Length: 2483 X-Content-Type-Options: nosniff