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.eyJ1c2VyX2lkIjoidWFhLWlkLTQ3MiIsImVtYWlsIjoiZW1haWwtMzM5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDgwMzg5Nzd9.xzdUl9V9aNNqlkHJZZJWGOmEIIVtBTwSpybDC2YsrtU Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/private_domains" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQ3MiIsImVtYWlsIjoiZW1haWwtMzM5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDgwMzg5Nzd9.xzdUl9V9aNNqlkHJZZJWGOmEIIVtBTwSpybDC2YsrtU" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{
"total_results": 4,
"total_pages": 1,
"prev_url": null,
"next_url": null,
"resources": [
{
"metadata": {
"guid": "86e4d048-f430-4dcf-823a-ba340be59ac1",
"url": "/v2/private_domains/86e4d048-f430-4dcf-823a-ba340be59ac1",
"created_at": "2015-11-13T17:02:45Z",
"updated_at": null
},
"entity": {
"name": "vcap.me",
"owning_organization_guid": "101cd362-9686-407b-a550-7369d19501d1",
"owning_organization_url": "/v2/organizations/101cd362-9686-407b-a550-7369d19501d1",
"shared_organizations_url": "/v2/private_domains/86e4d048-f430-4dcf-823a-ba340be59ac1/shared_organizations"
}
},
{
"metadata": {
"guid": "86bbd62c-1474-49f2-954d-027f2dbc74d2",
"url": "/v2/private_domains/86bbd62c-1474-49f2-954d-027f2dbc74d2",
"created_at": "2015-11-13T17:02:57Z",
"updated_at": null
},
"entity": {
"name": "domain-67.example.com",
"owning_organization_guid": "987c63c9-e7b1-4208-a1ba-5e9379a3c9a4",
"owning_organization_url": "/v2/organizations/987c63c9-e7b1-4208-a1ba-5e9379a3c9a4",
"shared_organizations_url": "/v2/private_domains/86bbd62c-1474-49f2-954d-027f2dbc74d2/shared_organizations"
}
},
{
"metadata": {
"guid": "e2d2d13f-ffdf-4c5e-9988-476dffffe172",
"url": "/v2/private_domains/e2d2d13f-ffdf-4c5e-9988-476dffffe172",
"created_at": "2015-11-13T17:02:57Z",
"updated_at": null
},
"entity": {
"name": "domain-68.example.com",
"owning_organization_guid": "608539e1-8226-4764-8bec-ec43aa13fbf2",
"owning_organization_url": "/v2/organizations/608539e1-8226-4764-8bec-ec43aa13fbf2",
"shared_organizations_url": "/v2/private_domains/e2d2d13f-ffdf-4c5e-9988-476dffffe172/shared_organizations"
}
},
{
"metadata": {
"guid": "7234cfb8-f7a1-4cc2-9206-84595692244d",
"url": "/v2/private_domains/7234cfb8-f7a1-4cc2-9206-84595692244d",
"created_at": "2015-11-13T17:02:57Z",
"updated_at": null
},
"entity": {
"name": "domain-69.example.com",
"owning_organization_guid": "1e30a62f-f2df-4f6c-8f35-b1612d098fc4",
"owning_organization_url": "/v2/organizations/1e30a62f-f2df-4f6c-8f35-b1612d098fc4",
"shared_organizations_url": "/v2/private_domains/7234cfb8-f7a1-4cc2-9206-84595692244d/shared_organizations"
}
}
]
}
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: Content-Length: 2483 X-Content-Type-Options: nosniff