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.eyJ1c2VyX2lkIjoidWFhLWlkLTM3NiIsImVtYWlsIjoiZW1haWwtMjc4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjIzMjM1NTR9.S6XErCiicVjVG7d-hWvzC-_LSGpo-gBGcOG9I8lBwgY Host: example.org Cookie:
GET /v2/organizations/2e650b7c-875c-4e48-ad53-18c0ed24d684/private_domains
curl "https://api.[your-domain.com]/v2/organizations/2e650b7c-875c-4e48-ad53-18c0ed24d684/private_domains" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM3NiIsImVtYWlsIjoiZW1haWwtMjc4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjIzMjM1NTR9.S6XErCiicVjVG7d-hWvzC-_LSGpo-gBGcOG9I8lBwgY" \ -H "Host: example.org" \ -H "Cookie: "
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: 9e9089a0-d3ed-46e0-97e0-a279e3c1b2ad Content-Length: 591 X-Content-Type-Options: nosniff
200 OK
{ "total_results": 1, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "98dc0d1d-dff5-484b-941d-7f0cd29dc934", "url": "/v2/private_domains/98dc0d1d-dff5-484b-941d-7f0cd29dc934", "created_at": "2015-01-20T01:52:34+00:00", "updated_at": null }, "entity": { "name": "domain-57.example.com", "owning_organization_guid": "2e650b7c-875c-4e48-ad53-18c0ed24d684", "owning_organization_url": "/v2/organizations/2e650b7c-875c-4e48-ad53-18c0ed24d684" } } ] }