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.eyJ1c2VyX2lkIjoidWFhLWlkLTIzMSIsImVtYWlsIjoiZW1haWwtMTYyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDk1MzE1MjZ9.w7xSLp38rp31Y7ykljQ4PAuaxnqoeMA-3uZB12fIl-s Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/private_domains" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIzMSIsImVtYWlsIjoiZW1haWwtMTYyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDk1MzE1MjZ9.w7xSLp38rp31Y7ykljQ4PAuaxnqoeMA-3uZB12fIl-s" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{
"total_results": 4,
"total_pages": 1,
"prev_url": null,
"next_url": null,
"resources": [
{
"metadata": {
"guid": "f84ed6dc-4df2-49ad-bcd8-e7e6245e9073",
"url": "/v2/private_domains/f84ed6dc-4df2-49ad-bcd8-e7e6245e9073",
"created_at": "2015-11-30T23:38:35Z",
"updated_at": null
},
"entity": {
"name": "vcap.me",
"owning_organization_guid": "ff2e03e9-4f23-44ec-bf57-11dbec3b6a8e",
"owning_organization_url": "/v2/organizations/ff2e03e9-4f23-44ec-bf57-11dbec3b6a8e",
"shared_organizations_url": "/v2/private_domains/f84ed6dc-4df2-49ad-bcd8-e7e6245e9073/shared_organizations"
}
},
{
"metadata": {
"guid": "d132f43d-eca4-41aa-b24f-f319c60aacc6",
"url": "/v2/private_domains/d132f43d-eca4-41aa-b24f-f319c60aacc6",
"created_at": "2015-11-30T23:38:46Z",
"updated_at": null
},
"entity": {
"name": "domain-38.example.com",
"owning_organization_guid": "157ace1c-196c-4e52-9afc-441fc3bf9822",
"owning_organization_url": "/v2/organizations/157ace1c-196c-4e52-9afc-441fc3bf9822",
"shared_organizations_url": "/v2/private_domains/d132f43d-eca4-41aa-b24f-f319c60aacc6/shared_organizations"
}
},
{
"metadata": {
"guid": "eadf697f-5876-4604-ab59-bb3ba6f7df49",
"url": "/v2/private_domains/eadf697f-5876-4604-ab59-bb3ba6f7df49",
"created_at": "2015-11-30T23:38:46Z",
"updated_at": null
},
"entity": {
"name": "domain-39.example.com",
"owning_organization_guid": "77f21bf0-d7e3-48a2-a8f4-a0fc551e8906",
"owning_organization_url": "/v2/organizations/77f21bf0-d7e3-48a2-a8f4-a0fc551e8906",
"shared_organizations_url": "/v2/private_domains/eadf697f-5876-4604-ab59-bb3ba6f7df49/shared_organizations"
}
},
{
"metadata": {
"guid": "7da4d228-3d42-418e-8776-1b2af192478c",
"url": "/v2/private_domains/7da4d228-3d42-418e-8776-1b2af192478c",
"created_at": "2015-11-30T23:38:46Z",
"updated_at": null
},
"entity": {
"name": "domain-40.example.com",
"owning_organization_guid": "88c72c8d-0bea-48e7-b808-7990ad8ef91f",
"owning_organization_url": "/v2/organizations/88c72c8d-0bea-48e7-b808-7990ad8ef91f",
"shared_organizations_url": "/v2/private_domains/7da4d228-3d42-418e-8776-1b2af192478c/shared_organizations"
}
}
]
}
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: Content-Length: 2483 X-Content-Type-Options: nosniff