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 |
|
|
| Name | Description | Default | Valid Values | Example Values |
|---|
Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTExNCIsImVtYWlsIjoiZW1haWwtNzZAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyNzQ4MDg0NX0.A_c94xOxxHCB7WD6ms_RSWBkSeeOiGLZfN87eKJKrZ8 Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/private_domains" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTExNCIsImVtYWlsIjoiZW1haWwtNzZAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyNzQ4MDg0NX0.A_c94xOxxHCB7WD6ms_RSWBkSeeOiGLZfN87eKJKrZ8" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{
"total_results": 4,
"total_pages": 1,
"prev_url": null,
"next_url": null,
"resources": [
{
"metadata": {
"guid": "11052be1-4bf1-4413-9936-b7da482ed780",
"url": "/v2/private_domains/11052be1-4bf1-4413-9936-b7da482ed780",
"created_at": "2015-03-20T18:27:18Z",
"updated_at": null
},
"entity": {
"name": "vcap.me",
"owning_organization_guid": "ef9fd3f7-9ada-45e0-b85a-f351d1864235",
"owning_organization_url": "/v2/organizations/ef9fd3f7-9ada-45e0-b85a-f351d1864235",
"shared_organizations_url": "/v2/private_domains/11052be1-4bf1-4413-9936-b7da482ed780/shared_organizations"
}
},
{
"metadata": {
"guid": "bbaeda02-9708-4afa-adcb-d3246aff6f18",
"url": "/v2/private_domains/bbaeda02-9708-4afa-adcb-d3246aff6f18",
"created_at": "2015-03-20T18:27:25Z",
"updated_at": null
},
"entity": {
"name": "domain-14.example.com",
"owning_organization_guid": "972bdc4b-8ced-4d2a-aa17-4d06e5502299",
"owning_organization_url": "/v2/organizations/972bdc4b-8ced-4d2a-aa17-4d06e5502299",
"shared_organizations_url": "/v2/private_domains/bbaeda02-9708-4afa-adcb-d3246aff6f18/shared_organizations"
}
},
{
"metadata": {
"guid": "dd7da2b8-84df-491e-8968-2c090aa0c492",
"url": "/v2/private_domains/dd7da2b8-84df-491e-8968-2c090aa0c492",
"created_at": "2015-03-20T18:27:25Z",
"updated_at": null
},
"entity": {
"name": "domain-15.example.com",
"owning_organization_guid": "a054940a-a206-4703-8816-f520c71491fc",
"owning_organization_url": "/v2/organizations/a054940a-a206-4703-8816-f520c71491fc",
"shared_organizations_url": "/v2/private_domains/dd7da2b8-84df-491e-8968-2c090aa0c492/shared_organizations"
}
},
{
"metadata": {
"guid": "e5c603bb-42c0-4a58-a056-b91f2f997253",
"url": "/v2/private_domains/e5c603bb-42c0-4a58-a056-b91f2f997253",
"created_at": "2015-03-20T18:27:25Z",
"updated_at": null
},
"entity": {
"name": "domain-16.example.com",
"owning_organization_guid": "b1887a27-f2bc-440e-8510-06ea4c76983a",
"owning_organization_url": "/v2/organizations/b1887a27-f2bc-440e-8510-06ea4c76983a",
"shared_organizations_url": "/v2/private_domains/e5c603bb-42c0-4a58-a056-b91f2f997253/shared_organizations"
}
}
]
}
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: 26d0d6b1-aeb5-4eab-8b1a-72a73f6dea1f Content-Length: 2483 X-Content-Type-Options: nosniff