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.eyJ1c2VyX2lkIjoidWFhLWlkLTI1NSIsImVtYWlsIjoiZW1haWwtMTYyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTg4NTU2Nzd9.D2PufQ-kNv-vLPrG_vl3UbVs9-1Pd84eGo6y2zID_Is Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/private_domains" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI1NSIsImVtYWlsIjoiZW1haWwtMTYyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTg4NTU2Nzd9.D2PufQ-kNv-vLPrG_vl3UbVs9-1Pd84eGo6y2zID_Is" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{
"total_results": 4,
"total_pages": 1,
"prev_url": null,
"next_url": null,
"resources": [
{
"metadata": {
"guid": "ad70b77f-38bf-4f3d-8992-dadb5e59ef32",
"url": "/v2/private_domains/ad70b77f-38bf-4f3d-8992-dadb5e59ef32",
"created_at": "2016-03-17T21:41:02Z",
"updated_at": null
},
"entity": {
"name": "vcap.me",
"owning_organization_guid": "65e1f9b9-b601-4887-9da1-bd940441c694",
"owning_organization_url": "/v2/organizations/65e1f9b9-b601-4887-9da1-bd940441c694",
"shared_organizations_url": "/v2/private_domains/ad70b77f-38bf-4f3d-8992-dadb5e59ef32/shared_organizations"
}
},
{
"metadata": {
"guid": "f418ba37-d8b6-42cc-843f-a9cfed5eaee2",
"url": "/v2/private_domains/f418ba37-d8b6-42cc-843f-a9cfed5eaee2",
"created_at": "2016-03-17T21:41:17Z",
"updated_at": null
},
"entity": {
"name": "domain-23.example.com",
"owning_organization_guid": "f0d2bb74-fcdb-464d-aa18-1b4682676cec",
"owning_organization_url": "/v2/organizations/f0d2bb74-fcdb-464d-aa18-1b4682676cec",
"shared_organizations_url": "/v2/private_domains/f418ba37-d8b6-42cc-843f-a9cfed5eaee2/shared_organizations"
}
},
{
"metadata": {
"guid": "3cf3d9b9-b8b3-4aad-ae73-863d90043ab2",
"url": "/v2/private_domains/3cf3d9b9-b8b3-4aad-ae73-863d90043ab2",
"created_at": "2016-03-17T21:41:17Z",
"updated_at": null
},
"entity": {
"name": "domain-24.example.com",
"owning_organization_guid": "c2345c3d-d361-4f4f-b64d-9021e2466ffe",
"owning_organization_url": "/v2/organizations/c2345c3d-d361-4f4f-b64d-9021e2466ffe",
"shared_organizations_url": "/v2/private_domains/3cf3d9b9-b8b3-4aad-ae73-863d90043ab2/shared_organizations"
}
},
{
"metadata": {
"guid": "3727618a-fbbd-4ab9-b622-da56e182b725",
"url": "/v2/private_domains/3727618a-fbbd-4ab9-b622-da56e182b725",
"created_at": "2016-03-17T21:41:17Z",
"updated_at": null
},
"entity": {
"name": "domain-25.example.com",
"owning_organization_guid": "6c2ed9d0-827b-4c46-b527-bbbc60bb5909",
"owning_organization_url": "/v2/organizations/6c2ed9d0-827b-4c46-b527-bbbc60bb5909",
"shared_organizations_url": "/v2/private_domains/3727618a-fbbd-4ab9-b622-da56e182b725/shared_organizations"
}
}
]
}
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: Content-Length: 2483 X-Content-Type-Options: nosniff