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.eyJ1c2VyX2lkIjoidWFhLWlkLTMzNSIsImVtYWlsIjoiZW1haWwtMjMwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjYwMDg4OTl9.MIITrhzS9LDq-sEAGzqgohvp7nQqybYjCe87L78vHaM Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/private_domains" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMzNSIsImVtYWlsIjoiZW1haWwtMjMwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjYwMDg4OTl9.MIITrhzS9LDq-sEAGzqgohvp7nQqybYjCe87L78vHaM" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{
"total_results": 4,
"total_pages": 1,
"prev_url": null,
"next_url": null,
"resources": [
{
"metadata": {
"guid": "b2a35f0c-d5ad-4a59-bea7-461711d96b0d",
"url": "/v2/private_domains/b2a35f0c-d5ad-4a59-bea7-461711d96b0d",
"created_at": "2016-06-08T16:41:39Z",
"updated_at": "2016-06-08T16:41:26Z"
},
"entity": {
"name": "vcap.me",
"owning_organization_guid": "4cf3bc47-eccd-4662-9322-7833c3bdcded",
"owning_organization_url": "/v2/organizations/4cf3bc47-eccd-4662-9322-7833c3bdcded",
"shared_organizations_url": "/v2/private_domains/b2a35f0c-d5ad-4a59-bea7-461711d96b0d/shared_organizations"
}
},
{
"metadata": {
"guid": "28db6393-cc6f-4318-a63c-f4009e8842bc",
"url": "/v2/private_domains/28db6393-cc6f-4318-a63c-f4009e8842bc",
"created_at": "2016-06-08T16:41:39Z",
"updated_at": "2016-06-08T16:41:26Z"
},
"entity": {
"name": "domain-61.example.com",
"owning_organization_guid": "c262280e-0ccc-4e13-918a-6852f2d1e3a0",
"owning_organization_url": "/v2/organizations/c262280e-0ccc-4e13-918a-6852f2d1e3a0",
"shared_organizations_url": "/v2/private_domains/28db6393-cc6f-4318-a63c-f4009e8842bc/shared_organizations"
}
},
{
"metadata": {
"guid": "a16ffec7-5fab-4447-861e-c38da6548c6d",
"url": "/v2/private_domains/a16ffec7-5fab-4447-861e-c38da6548c6d",
"created_at": "2016-06-08T16:41:39Z",
"updated_at": "2016-06-08T16:41:26Z"
},
"entity": {
"name": "domain-62.example.com",
"owning_organization_guid": "68f69961-f751-4b52-907c-4469009fdf74",
"owning_organization_url": "/v2/organizations/68f69961-f751-4b52-907c-4469009fdf74",
"shared_organizations_url": "/v2/private_domains/a16ffec7-5fab-4447-861e-c38da6548c6d/shared_organizations"
}
},
{
"metadata": {
"guid": "4168cdaf-1586-41a6-9e5f-d8c715c332f5",
"url": "/v2/private_domains/4168cdaf-1586-41a6-9e5f-d8c715c332f5",
"created_at": "2016-06-08T16:41:39Z",
"updated_at": "2016-06-08T16:41:26Z"
},
"entity": {
"name": "domain-63.example.com",
"owning_organization_guid": "8d8ed1ba-f7f3-48f1-8d9a-2dfaad91335b",
"owning_organization_url": "/v2/organizations/8d8ed1ba-f7f3-48f1-8d9a-2dfaad91335b",
"shared_organizations_url": "/v2/private_domains/4168cdaf-1586-41a6-9e5f-d8c715c332f5/shared_organizations"
}
}
]
}
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: e7466682-8519-4095-92f0-876fb75cb553 Content-Length: 2483 X-Content-Type-Options: nosniff