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.eyJ1c2VyX2lkIjoidWFhLWlkLTEwNyIsImVtYWlsIjoiZW1haWwtNzRAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ1MzMxMDk3NX0.MmogK_YTtBtU8-YODrrkZYgdOeTuWvOkN4I313SXsDU Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/private_domains" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEwNyIsImVtYWlsIjoiZW1haWwtNzRAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ1MzMxMDk3NX0.MmogK_YTtBtU8-YODrrkZYgdOeTuWvOkN4I313SXsDU" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{
"total_results": 4,
"total_pages": 1,
"prev_url": null,
"next_url": null,
"resources": [
{
"metadata": {
"guid": "baeb2436-6800-451b-88ee-30bb4530ca44",
"url": "/v2/private_domains/baeb2436-6800-451b-88ee-30bb4530ca44",
"created_at": "2016-01-13T17:29:29Z",
"updated_at": null
},
"entity": {
"name": "vcap.me",
"owning_organization_guid": "b4284bff-2641-40cc-8141-541b359b2074",
"owning_organization_url": "/v2/organizations/b4284bff-2641-40cc-8141-541b359b2074",
"shared_organizations_url": "/v2/private_domains/baeb2436-6800-451b-88ee-30bb4530ca44/shared_organizations"
}
},
{
"metadata": {
"guid": "f82c0228-0217-43e7-bcf1-35c28406a39f",
"url": "/v2/private_domains/f82c0228-0217-43e7-bcf1-35c28406a39f",
"created_at": "2016-01-13T17:29:35Z",
"updated_at": null
},
"entity": {
"name": "domain-19.example.com",
"owning_organization_guid": "2d76327e-aa56-4093-a43b-141bfe44cf07",
"owning_organization_url": "/v2/organizations/2d76327e-aa56-4093-a43b-141bfe44cf07",
"shared_organizations_url": "/v2/private_domains/f82c0228-0217-43e7-bcf1-35c28406a39f/shared_organizations"
}
},
{
"metadata": {
"guid": "2703a2fc-2932-4b5c-aa24-9b8764edcf27",
"url": "/v2/private_domains/2703a2fc-2932-4b5c-aa24-9b8764edcf27",
"created_at": "2016-01-13T17:29:35Z",
"updated_at": null
},
"entity": {
"name": "domain-20.example.com",
"owning_organization_guid": "8c8f4a09-2bb0-4cb9-a616-df3c51abc286",
"owning_organization_url": "/v2/organizations/8c8f4a09-2bb0-4cb9-a616-df3c51abc286",
"shared_organizations_url": "/v2/private_domains/2703a2fc-2932-4b5c-aa24-9b8764edcf27/shared_organizations"
}
},
{
"metadata": {
"guid": "ffdad5ba-abe7-4c45-b105-c2b72fcb90f1",
"url": "/v2/private_domains/ffdad5ba-abe7-4c45-b105-c2b72fcb90f1",
"created_at": "2016-01-13T17:29:35Z",
"updated_at": null
},
"entity": {
"name": "domain-21.example.com",
"owning_organization_guid": "7d0d6fde-d86f-48fd-8348-1644795a958a",
"owning_organization_url": "/v2/organizations/7d0d6fde-d86f-48fd-8348-1644795a958a",
"shared_organizations_url": "/v2/private_domains/ffdad5ba-abe7-4c45-b105-c2b72fcb90f1/shared_organizations"
}
}
]
}
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: Content-Length: 2483 X-Content-Type-Options: nosniff