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.eyJ1c2VyX2lkIjoidWFhLWlkLTIxMCIsImVtYWlsIjoiZW1haWwtMTQzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDQ3ODI5MzV9.7Pn0KAr6SrLC2Dq7jcNqcY8txl625ceQlSyjwPX82Ec Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/private_domains" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIxMCIsImVtYWlsIjoiZW1haWwtMTQzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDQ3ODI5MzV9.7Pn0KAr6SrLC2Dq7jcNqcY8txl625ceQlSyjwPX82Ec" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{
"total_results": 4,
"total_pages": 1,
"prev_url": null,
"next_url": null,
"resources": [
{
"metadata": {
"guid": "f7fd789d-4550-4191-9ba6-3dc1a6f57bbb",
"url": "/v2/private_domains/f7fd789d-4550-4191-9ba6-3dc1a6f57bbb",
"created_at": "2015-10-07T00:35:26Z",
"updated_at": null
},
"entity": {
"name": "vcap.me",
"owning_organization_guid": "5ea42db0-9b13-4c8c-8ea9-c11453321a44",
"owning_organization_url": "/v2/organizations/5ea42db0-9b13-4c8c-8ea9-c11453321a44",
"shared_organizations_url": "/v2/private_domains/f7fd789d-4550-4191-9ba6-3dc1a6f57bbb/shared_organizations"
}
},
{
"metadata": {
"guid": "7f0d462c-437f-4945-a68f-ffb80ab522ac",
"url": "/v2/private_domains/7f0d462c-437f-4945-a68f-ffb80ab522ac",
"created_at": "2015-10-07T00:35:35Z",
"updated_at": null
},
"entity": {
"name": "domain-34.example.com",
"owning_organization_guid": "2b081cef-a4e2-440f-9ecd-fc9aa71237f2",
"owning_organization_url": "/v2/organizations/2b081cef-a4e2-440f-9ecd-fc9aa71237f2",
"shared_organizations_url": "/v2/private_domains/7f0d462c-437f-4945-a68f-ffb80ab522ac/shared_organizations"
}
},
{
"metadata": {
"guid": "f484746a-6d3f-480e-a52f-a4e89879a59b",
"url": "/v2/private_domains/f484746a-6d3f-480e-a52f-a4e89879a59b",
"created_at": "2015-10-07T00:35:35Z",
"updated_at": null
},
"entity": {
"name": "domain-35.example.com",
"owning_organization_guid": "7b58aa7f-4165-471a-86ca-053933de80ad",
"owning_organization_url": "/v2/organizations/7b58aa7f-4165-471a-86ca-053933de80ad",
"shared_organizations_url": "/v2/private_domains/f484746a-6d3f-480e-a52f-a4e89879a59b/shared_organizations"
}
},
{
"metadata": {
"guid": "57afafc0-f234-4614-8e95-b2890daa1a13",
"url": "/v2/private_domains/57afafc0-f234-4614-8e95-b2890daa1a13",
"created_at": "2015-10-07T00:35:35Z",
"updated_at": null
},
"entity": {
"name": "domain-36.example.com",
"owning_organization_guid": "f446c365-33b8-43b4-9bc8-1664d59bc026",
"owning_organization_url": "/v2/organizations/f446c365-33b8-43b4-9bc8-1664d59bc026",
"shared_organizations_url": "/v2/private_domains/57afafc0-f234-4614-8e95-b2890daa1a13/shared_organizations"
}
}
]
}
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: d1030937-e910-41db-813b-a1cd6db00674 Content-Length: 2483 X-Content-Type-Options: nosniff