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 |
|
|
q: name:my-domain.com
Name | Description | Default | Valid Values | Example Values |
---|
Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIxOSIsImVtYWlsIjoiZW1haWwtMTQwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mjk2NjQxNDF9.MdSMDox6oiMTdipg9hYg4-aCIlwnV72VwShDXeSA8cs Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/private_domains" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIxOSIsImVtYWlsIjoiZW1haWwtMTQwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mjk2NjQxNDF9.MdSMDox6oiMTdipg9hYg4-aCIlwnV72VwShDXeSA8cs" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 1, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "50bf7f37-90f1-4346-a84f-e9698338b08e", "url": "/v2/private_domains/50bf7f37-90f1-4346-a84f-e9698338b08e", "created_at": "2015-04-15T00:55:41Z", "updated_at": null }, "entity": { "name": "my-domain.com", "owning_organization_guid": "dfa58a39-c563-46dd-a099-9b9ebe16f252", "owning_organization_url": "/v2/organizations/dfa58a39-c563-46dd-a099-9b9ebe16f252", "shared_organizations_url": "/v2/private_domains/50bf7f37-90f1-4346-a84f-e9698338b08e/shared_organizations" } } ] }
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: 24e0097c-16bc-4691-a585-ae8c60939f11 Content-Length: 695 X-Content-Type-Options: nosniff