Name | Description | Default | Valid Values | Example Values |
---|
Name | Description | Valid Values | Example Values |
---|---|---|---|
guid | The guid of the Organization |
|
|
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.eyJ1c2VyX2lkIjoidWFhLWlkLTc1IiwiZW1haWwiOiJlbWFpbC01NkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI0MTM3MzY0fQ.F26-diD38BCpaz41mJw3JdpFhEDWSfeOmthB5TGjHw8 Host: example.org Cookie:
GET /v2/organizations/b8254d9d-fae5-41cb-b203-930837cc4616/private_domains
curl "https://api.[your-domain.com]/v2/organizations/b8254d9d-fae5-41cb-b203-930837cc4616/private_domains" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTc1IiwiZW1haWwiOiJlbWFpbC01NkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI0MTM3MzY0fQ.F26-diD38BCpaz41mJw3JdpFhEDWSfeOmthB5TGjHw8" \ -H "Host: example.org" \ -H "Cookie: "
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: 625d0f61-59aa-4b86-960a-5b738fb9142e Content-Length: 586 X-Content-Type-Options: nosniff
200 OK
{ "total_results": 1, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "a212aa17-4015-472b-9707-f5e6eb4a8e4c", "url": "/v2/private_domains/a212aa17-4015-472b-9707-f5e6eb4a8e4c", "created_at": "2015-02-10T01:42:44Z", "updated_at": null }, "entity": { "name": "domain-16.example.com", "owning_organization_guid": "b8254d9d-fae5-41cb-b203-930837cc4616", "owning_organization_url": "/v2/organizations/b8254d9d-fae5-41cb-b203-930837cc4616" } } ] }