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.eyJ1c2VyX2lkIjoidWFhLWlkLTI2NCIsImVtYWlsIjoiZW1haWwtMTk2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDUzNjIzMTJ9.4Z4ANYOK0aycJFU-nKhjC_1zsDfWmZSk4hiyJnTs0Fg Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/private_domains" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI2NCIsImVtYWlsIjoiZW1haWwtMTk2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDUzNjIzMTJ9.4Z4ANYOK0aycJFU-nKhjC_1zsDfWmZSk4hiyJnTs0Fg" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{
"total_results": 4,
"total_pages": 1,
"prev_url": null,
"next_url": null,
"resources": [
{
"metadata": {
"guid": "46fb94be-e622-41d7-96cc-4f9d13f45c22",
"url": "/v2/private_domains/46fb94be-e622-41d7-96cc-4f9d13f45c22",
"created_at": "2015-10-13T17:31:45Z",
"updated_at": null
},
"entity": {
"name": "vcap.me",
"owning_organization_guid": "8d7bb68f-7131-4bde-9f2c-329c414b8969",
"owning_organization_url": "/v2/organizations/8d7bb68f-7131-4bde-9f2c-329c414b8969",
"shared_organizations_url": "/v2/private_domains/46fb94be-e622-41d7-96cc-4f9d13f45c22/shared_organizations"
}
},
{
"metadata": {
"guid": "9625f623-1a30-4b4d-b8d7-ace6984cd169",
"url": "/v2/private_domains/9625f623-1a30-4b4d-b8d7-ace6984cd169",
"created_at": "2015-10-13T17:31:52Z",
"updated_at": null
},
"entity": {
"name": "domain-22.example.com",
"owning_organization_guid": "8229a601-21f5-45f3-bbab-778f28496670",
"owning_organization_url": "/v2/organizations/8229a601-21f5-45f3-bbab-778f28496670",
"shared_organizations_url": "/v2/private_domains/9625f623-1a30-4b4d-b8d7-ace6984cd169/shared_organizations"
}
},
{
"metadata": {
"guid": "a6021f18-76a7-49e8-a1f9-033363e78e1d",
"url": "/v2/private_domains/a6021f18-76a7-49e8-a1f9-033363e78e1d",
"created_at": "2015-10-13T17:31:52Z",
"updated_at": null
},
"entity": {
"name": "domain-23.example.com",
"owning_organization_guid": "c7f73543-ffd8-4caa-ba8e-ad68a286f6ab",
"owning_organization_url": "/v2/organizations/c7f73543-ffd8-4caa-ba8e-ad68a286f6ab",
"shared_organizations_url": "/v2/private_domains/a6021f18-76a7-49e8-a1f9-033363e78e1d/shared_organizations"
}
},
{
"metadata": {
"guid": "a2a96107-e125-4710-ba60-927ea1cfea51",
"url": "/v2/private_domains/a2a96107-e125-4710-ba60-927ea1cfea51",
"created_at": "2015-10-13T17:31:52Z",
"updated_at": null
},
"entity": {
"name": "domain-24.example.com",
"owning_organization_guid": "82e396d3-d9bf-42de-96f1-c2f5b10a04d5",
"owning_organization_url": "/v2/organizations/82e396d3-d9bf-42de-96f1-c2f5b10a04d5",
"shared_organizations_url": "/v2/private_domains/a2a96107-e125-4710-ba60-927ea1cfea51/shared_organizations"
}
}
]
}
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: 439b6ae3-d323-49a1-8699-54e41849ee88 Content-Length: 2483 X-Content-Type-Options: nosniff