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.eyJ1c2VyX2lkIjoidWFhLWlkLTE4NCIsImVtYWlsIjoiZW1haWwtMTIxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTE0MTM2ODV9.ikQztgGkWFN8RTDm37f7JU9b3yPCdrQzknKOySrq1Lo Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/private_domains" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE4NCIsImVtYWlsIjoiZW1haWwtMTIxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTE0MTM2ODV9.ikQztgGkWFN8RTDm37f7JU9b3yPCdrQzknKOySrq1Lo" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{
"total_results": 4,
"total_pages": 1,
"prev_url": null,
"next_url": null,
"resources": [
{
"metadata": {
"guid": "0683bb79-fd4e-44d2-9047-0d194782a784",
"url": "/v2/private_domains/0683bb79-fd4e-44d2-9047-0d194782a784",
"created_at": "2015-12-22T18:27:59Z",
"updated_at": null
},
"entity": {
"name": "vcap.me",
"owning_organization_guid": "78fd416f-d322-4611-9e34-1276cb4fd70b",
"owning_organization_url": "/v2/organizations/78fd416f-d322-4611-9e34-1276cb4fd70b",
"shared_organizations_url": "/v2/private_domains/0683bb79-fd4e-44d2-9047-0d194782a784/shared_organizations"
}
},
{
"metadata": {
"guid": "39e35b1d-6d08-4d69-9dfa-9eef9ca741a8",
"url": "/v2/private_domains/39e35b1d-6d08-4d69-9dfa-9eef9ca741a8",
"created_at": "2015-12-22T18:28:05Z",
"updated_at": null
},
"entity": {
"name": "domain-20.example.com",
"owning_organization_guid": "2ec1f16e-0741-4bd4-9c11-35404094c534",
"owning_organization_url": "/v2/organizations/2ec1f16e-0741-4bd4-9c11-35404094c534",
"shared_organizations_url": "/v2/private_domains/39e35b1d-6d08-4d69-9dfa-9eef9ca741a8/shared_organizations"
}
},
{
"metadata": {
"guid": "e1958f2a-80a3-4a8c-853c-73cf940b1150",
"url": "/v2/private_domains/e1958f2a-80a3-4a8c-853c-73cf940b1150",
"created_at": "2015-12-22T18:28:05Z",
"updated_at": null
},
"entity": {
"name": "domain-21.example.com",
"owning_organization_guid": "c1c4b63f-02b9-47e1-a6be-f1d1d1e68fb7",
"owning_organization_url": "/v2/organizations/c1c4b63f-02b9-47e1-a6be-f1d1d1e68fb7",
"shared_organizations_url": "/v2/private_domains/e1958f2a-80a3-4a8c-853c-73cf940b1150/shared_organizations"
}
},
{
"metadata": {
"guid": "5c3d9b43-4551-48c8-bfe0-868bd94cbe64",
"url": "/v2/private_domains/5c3d9b43-4551-48c8-bfe0-868bd94cbe64",
"created_at": "2015-12-22T18:28:05Z",
"updated_at": null
},
"entity": {
"name": "domain-22.example.com",
"owning_organization_guid": "f74e0d63-0698-4509-9250-4a346b541105",
"owning_organization_url": "/v2/organizations/f74e0d63-0698-4509-9250-4a346b541105",
"shared_organizations_url": "/v2/private_domains/5c3d9b43-4551-48c8-bfe0-868bd94cbe64/shared_organizations"
}
}
]
}
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: Content-Length: 2483 X-Content-Type-Options: nosniff