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.eyJ1c2VyX2lkIjoidWFhLWlkLTc5IiwiZW1haWwiOiJlbWFpbC00N0Bzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDQyNjAxNTI4fQ.9V_lDruRffVTIr3x9RFKGc6exCMKp3-Ryf6PDeMEkSM Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/private_domains" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTc5IiwiZW1haWwiOiJlbWFpbC00N0Bzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDQyNjAxNTI4fQ.9V_lDruRffVTIr3x9RFKGc6exCMKp3-Ryf6PDeMEkSM" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{
"total_results": 4,
"total_pages": 1,
"prev_url": null,
"next_url": null,
"resources": [
{
"metadata": {
"guid": "bf29c3d5-96e4-44b5-983b-3f443f8d7214",
"url": "/v2/private_domains/bf29c3d5-96e4-44b5-983b-3f443f8d7214",
"created_at": "2015-09-11T18:38:44Z",
"updated_at": null
},
"entity": {
"name": "vcap.me",
"owning_organization_guid": "4beb750c-27ca-430d-a479-5a3bedd3d239",
"owning_organization_url": "/v2/organizations/4beb750c-27ca-430d-a479-5a3bedd3d239",
"shared_organizations_url": "/v2/private_domains/bf29c3d5-96e4-44b5-983b-3f443f8d7214/shared_organizations"
}
},
{
"metadata": {
"guid": "5e2e04f3-2754-4a75-8c7b-14448cb7c0e4",
"url": "/v2/private_domains/5e2e04f3-2754-4a75-8c7b-14448cb7c0e4",
"created_at": "2015-09-11T18:38:48Z",
"updated_at": null
},
"entity": {
"name": "domain-9.example.com",
"owning_organization_guid": "b960290a-4ba9-4835-a40c-2ee827c373c6",
"owning_organization_url": "/v2/organizations/b960290a-4ba9-4835-a40c-2ee827c373c6",
"shared_organizations_url": "/v2/private_domains/5e2e04f3-2754-4a75-8c7b-14448cb7c0e4/shared_organizations"
}
},
{
"metadata": {
"guid": "70c99bec-81b2-4dce-be84-015e8d68ead2",
"url": "/v2/private_domains/70c99bec-81b2-4dce-be84-015e8d68ead2",
"created_at": "2015-09-11T18:38:48Z",
"updated_at": null
},
"entity": {
"name": "domain-10.example.com",
"owning_organization_guid": "a9fe7ce6-3212-42a1-9123-d4ea1029c120",
"owning_organization_url": "/v2/organizations/a9fe7ce6-3212-42a1-9123-d4ea1029c120",
"shared_organizations_url": "/v2/private_domains/70c99bec-81b2-4dce-be84-015e8d68ead2/shared_organizations"
}
},
{
"metadata": {
"guid": "56faf496-164b-4647-8118-b80a3de1198e",
"url": "/v2/private_domains/56faf496-164b-4647-8118-b80a3de1198e",
"created_at": "2015-09-11T18:38:48Z",
"updated_at": null
},
"entity": {
"name": "domain-11.example.com",
"owning_organization_guid": "44e50a2a-478b-4b1b-8c88-3730960db0e3",
"owning_organization_url": "/v2/organizations/44e50a2a-478b-4b1b-8c88-3730960db0e3",
"shared_organizations_url": "/v2/private_domains/56faf496-164b-4647-8118-b80a3de1198e/shared_organizations"
}
}
]
}
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: 3766fab4-efdf-463e-ade7-2ad73101aa84 Content-Length: 2482 X-Content-Type-Options: nosniff