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.eyJ1c2VyX2lkIjoidWFhLWlkLTk2IiwiZW1haWwiOiJlbWFpbC02NUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDYzNjE4NzA2fQ.SpMRchzn5l7TIs-_053DLQayTFS0slJkbPQhx8Wy6_s Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/private_domains" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTk2IiwiZW1haWwiOiJlbWFpbC02NUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDYzNjE4NzA2fQ.SpMRchzn5l7TIs-_053DLQayTFS0slJkbPQhx8Wy6_s" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{
"total_results": 4,
"total_pages": 1,
"prev_url": null,
"next_url": null,
"resources": [
{
"metadata": {
"guid": "746c5830-be88-4079-90a1-a1bf90393441",
"url": "/v2/private_domains/746c5830-be88-4079-90a1-a1bf90393441",
"created_at": "2016-05-12T00:45:03Z",
"updated_at": null
},
"entity": {
"name": "vcap.me",
"owning_organization_guid": "328b4999-3835-478e-b9d0-0d643dc88ec4",
"owning_organization_url": "/v2/organizations/328b4999-3835-478e-b9d0-0d643dc88ec4",
"shared_organizations_url": "/v2/private_domains/746c5830-be88-4079-90a1-a1bf90393441/shared_organizations"
}
},
{
"metadata": {
"guid": "9c67edac-7c0a-4f8d-9a97-df30fe5d20ce",
"url": "/v2/private_domains/9c67edac-7c0a-4f8d-9a97-df30fe5d20ce",
"created_at": "2016-05-12T00:45:06Z",
"updated_at": null
},
"entity": {
"name": "domain-16.example.com",
"owning_organization_guid": "2ebec56a-ef91-4973-9cc7-490c5bd280ee",
"owning_organization_url": "/v2/organizations/2ebec56a-ef91-4973-9cc7-490c5bd280ee",
"shared_organizations_url": "/v2/private_domains/9c67edac-7c0a-4f8d-9a97-df30fe5d20ce/shared_organizations"
}
},
{
"metadata": {
"guid": "0db06f5e-dbaa-4f61-954d-f87709b0439b",
"url": "/v2/private_domains/0db06f5e-dbaa-4f61-954d-f87709b0439b",
"created_at": "2016-05-12T00:45:06Z",
"updated_at": null
},
"entity": {
"name": "domain-17.example.com",
"owning_organization_guid": "e339f6c2-038d-45c5-a73e-f38b4ebce708",
"owning_organization_url": "/v2/organizations/e339f6c2-038d-45c5-a73e-f38b4ebce708",
"shared_organizations_url": "/v2/private_domains/0db06f5e-dbaa-4f61-954d-f87709b0439b/shared_organizations"
}
},
{
"metadata": {
"guid": "7d300868-adf7-4678-bcc9-de39fb252514",
"url": "/v2/private_domains/7d300868-adf7-4678-bcc9-de39fb252514",
"created_at": "2016-05-12T00:45:06Z",
"updated_at": null
},
"entity": {
"name": "domain-18.example.com",
"owning_organization_guid": "87bb2e23-5020-4333-a519-98832689df23",
"owning_organization_url": "/v2/organizations/87bb2e23-5020-4333-a519-98832689df23",
"shared_organizations_url": "/v2/private_domains/7d300868-adf7-4678-bcc9-de39fb252514/shared_organizations"
}
}
]
}
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: 652616de-2992-4b48-b6d1-4e9d9e045a3f Content-Length: 2483 X-Content-Type-Options: nosniff