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.eyJ1c2VyX2lkIjoidWFhLWlkLTMyMyIsImVtYWlsIjoiZW1haWwtMjQwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzY4Mjk3OTd9.TZ2VRxewJb_wchirCJd88W7INdankV12FoFfoJWPa28 Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/private_domains" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMyMyIsImVtYWlsIjoiZW1haWwtMjQwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzY4Mjk3OTd9.TZ2VRxewJb_wchirCJd88W7INdankV12FoFfoJWPa28" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{
"total_results": 4,
"total_pages": 1,
"prev_url": null,
"next_url": null,
"resources": [
{
"metadata": {
"guid": "f6975d7b-c1f8-4a77-91fd-02b79b563afe",
"url": "/v2/private_domains/f6975d7b-c1f8-4a77-91fd-02b79b563afe",
"created_at": "2015-07-06T23:23:06Z",
"updated_at": null
},
"entity": {
"name": "vcap.me",
"owning_organization_guid": "2bc6ed88-ddad-421b-b3e9-ca772e1f0e14",
"owning_organization_url": "/v2/organizations/2bc6ed88-ddad-421b-b3e9-ca772e1f0e14",
"shared_organizations_url": "/v2/private_domains/f6975d7b-c1f8-4a77-91fd-02b79b563afe/shared_organizations"
}
},
{
"metadata": {
"guid": "f6d964d6-6aa9-452a-9da0-801251cef40b",
"url": "/v2/private_domains/f6d964d6-6aa9-452a-9da0-801251cef40b",
"created_at": "2015-07-06T23:23:17Z",
"updated_at": null
},
"entity": {
"name": "domain-46.example.com",
"owning_organization_guid": "707bb94d-7c98-4e06-850c-92049662eb2e",
"owning_organization_url": "/v2/organizations/707bb94d-7c98-4e06-850c-92049662eb2e",
"shared_organizations_url": "/v2/private_domains/f6d964d6-6aa9-452a-9da0-801251cef40b/shared_organizations"
}
},
{
"metadata": {
"guid": "e15346bd-0da3-4be5-ae94-7498b77b1197",
"url": "/v2/private_domains/e15346bd-0da3-4be5-ae94-7498b77b1197",
"created_at": "2015-07-06T23:23:17Z",
"updated_at": null
},
"entity": {
"name": "domain-47.example.com",
"owning_organization_guid": "3ff9b397-dd32-40f6-8f5d-cedb4390ed5b",
"owning_organization_url": "/v2/organizations/3ff9b397-dd32-40f6-8f5d-cedb4390ed5b",
"shared_organizations_url": "/v2/private_domains/e15346bd-0da3-4be5-ae94-7498b77b1197/shared_organizations"
}
},
{
"metadata": {
"guid": "ec9b5fb1-856b-4aa9-9a47-4815e8c0eff9",
"url": "/v2/private_domains/ec9b5fb1-856b-4aa9-9a47-4815e8c0eff9",
"created_at": "2015-07-06T23:23:17Z",
"updated_at": null
},
"entity": {
"name": "domain-48.example.com",
"owning_organization_guid": "68795669-cf5c-4438-99cb-10cc17d4a378",
"owning_organization_url": "/v2/organizations/68795669-cf5c-4438-99cb-10cc17d4a378",
"shared_organizations_url": "/v2/private_domains/ec9b5fb1-856b-4aa9-9a47-4815e8c0eff9/shared_organizations"
}
}
]
}
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: b9066414-cf7c-499c-b2cb-8e2cb202a84c Content-Length: 2483 X-Content-Type-Options: nosniff