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 |
|
|
| Name | Description | Default | Valid Values | Example Values |
|---|
Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEyIiwiZW1haWwiOiJlbWFpbC0xMkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI2MTg3NzM0fQ.YYZT1azJAUUKf2uosXdn2xN52q5SzJoyNuKVxtVzuO8 Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/private_domains" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEyIiwiZW1haWwiOiJlbWFpbC0xMkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI2MTg3NzM0fQ.YYZT1azJAUUKf2uosXdn2xN52q5SzJoyNuKVxtVzuO8" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{
"total_results": 4,
"total_pages": 1,
"prev_url": null,
"next_url": null,
"resources": [
{
"metadata": {
"guid": "35e73dbe-411d-4ca1-8174-3d04bf4f74a2",
"url": "/v2/private_domains/35e73dbe-411d-4ca1-8174-3d04bf4f74a2",
"created_at": "2015-03-05T19:15:29Z",
"updated_at": null
},
"entity": {
"name": "vcap.me",
"owning_organization_guid": "204b56c1-66ab-45da-9aa6-2bacfa5e6584",
"owning_organization_url": "/v2/organizations/204b56c1-66ab-45da-9aa6-2bacfa5e6584",
"shared_organizations_url": "/v2/private_domains/35e73dbe-411d-4ca1-8174-3d04bf4f74a2/shared_organizations"
}
},
{
"metadata": {
"guid": "ecdd9db2-70b2-4642-8bef-e662382d4750",
"url": "/v2/private_domains/ecdd9db2-70b2-4642-8bef-e662382d4750",
"created_at": "2015-03-05T19:15:34Z",
"updated_at": null
},
"entity": {
"name": "domain-8.example.com",
"owning_organization_guid": "60ce6e26-ac3d-47c2-a12e-7abfb7ce09eb",
"owning_organization_url": "/v2/organizations/60ce6e26-ac3d-47c2-a12e-7abfb7ce09eb",
"shared_organizations_url": "/v2/private_domains/ecdd9db2-70b2-4642-8bef-e662382d4750/shared_organizations"
}
},
{
"metadata": {
"guid": "da42e7e8-b4e5-4b80-952c-f4eac18478cf",
"url": "/v2/private_domains/da42e7e8-b4e5-4b80-952c-f4eac18478cf",
"created_at": "2015-03-05T19:15:34Z",
"updated_at": null
},
"entity": {
"name": "domain-9.example.com",
"owning_organization_guid": "42b53607-e6ee-4935-96a5-0af27d97f4df",
"owning_organization_url": "/v2/organizations/42b53607-e6ee-4935-96a5-0af27d97f4df",
"shared_organizations_url": "/v2/private_domains/da42e7e8-b4e5-4b80-952c-f4eac18478cf/shared_organizations"
}
},
{
"metadata": {
"guid": "4b298cc5-e405-4ba7-a1e6-89d7df5c62c3",
"url": "/v2/private_domains/4b298cc5-e405-4ba7-a1e6-89d7df5c62c3",
"created_at": "2015-03-05T19:15:34Z",
"updated_at": null
},
"entity": {
"name": "domain-10.example.com",
"owning_organization_guid": "20aca543-a3ac-4bb8-b4a2-4fd4ce988b58",
"owning_organization_url": "/v2/organizations/20aca543-a3ac-4bb8-b4a2-4fd4ce988b58",
"shared_organizations_url": "/v2/private_domains/4b298cc5-e405-4ba7-a1e6-89d7df5c62c3/shared_organizations"
}
}
]
}
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: c5d08049-c1b1-4edc-a1a0-2ccf0f316b71 Content-Length: 2481 X-Content-Type-Options: nosniff