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.eyJ1c2VyX2lkIjoidWFhLWlkLTI1OCIsImVtYWlsIjoiZW1haWwtMTkxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjczMjM5NzB9.LutwFmVscQpkWYinTzaUbUmIhf1FpAaMgYY2B59Egu8 Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/private_domains" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI1OCIsImVtYWlsIjoiZW1haWwtMTkxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjczMjM5NzB9.LutwFmVscQpkWYinTzaUbUmIhf1FpAaMgYY2B59Egu8" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 4, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "b93c551b-c4e6-4bca-9a5f-a10b870eac2e", "url": "/v2/private_domains/b93c551b-c4e6-4bca-9a5f-a10b870eac2e", "created_at": "2015-03-18T22:52:45Z", "updated_at": null }, "entity": { "name": "vcap.me", "owning_organization_guid": "fd775cd9-0e65-4a59-953f-fa5c7bba7f9e", "owning_organization_url": "/v2/organizations/fd775cd9-0e65-4a59-953f-fa5c7bba7f9e", "shared_organizations_url": "/v2/private_domains/b93c551b-c4e6-4bca-9a5f-a10b870eac2e/shared_organizations" } }, { "metadata": { "guid": "69889d4f-f12c-41ad-bb51-612d18081969", "url": "/v2/private_domains/69889d4f-f12c-41ad-bb51-612d18081969", "created_at": "2015-03-18T22:52:50Z", "updated_at": null }, "entity": { "name": "domain-55.example.com", "owning_organization_guid": "ea3d0f29-fe17-446d-811c-9be23e9bee9e", "owning_organization_url": "/v2/organizations/ea3d0f29-fe17-446d-811c-9be23e9bee9e", "shared_organizations_url": "/v2/private_domains/69889d4f-f12c-41ad-bb51-612d18081969/shared_organizations" } }, { "metadata": { "guid": "fa4f159e-fb19-485f-84f7-51e3cb324ef6", "url": "/v2/private_domains/fa4f159e-fb19-485f-84f7-51e3cb324ef6", "created_at": "2015-03-18T22:52:50Z", "updated_at": null }, "entity": { "name": "domain-56.example.com", "owning_organization_guid": "7f00d621-80d3-4f46-946d-488c1cfe046e", "owning_organization_url": "/v2/organizations/7f00d621-80d3-4f46-946d-488c1cfe046e", "shared_organizations_url": "/v2/private_domains/fa4f159e-fb19-485f-84f7-51e3cb324ef6/shared_organizations" } }, { "metadata": { "guid": "97dc3531-6566-48f8-8835-6ce67ce3ed18", "url": "/v2/private_domains/97dc3531-6566-48f8-8835-6ce67ce3ed18", "created_at": "2015-03-18T22:52:50Z", "updated_at": null }, "entity": { "name": "domain-57.example.com", "owning_organization_guid": "a5e72d4c-86a2-43b8-bcd8-d37882c426c7", "owning_organization_url": "/v2/organizations/a5e72d4c-86a2-43b8-bcd8-d37882c426c7", "shared_organizations_url": "/v2/private_domains/97dc3531-6566-48f8-8835-6ce67ce3ed18/shared_organizations" } } ] }
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: 5a20eaf6-d9fc-406d-b683-0b4a938a871e Content-Length: 2483 X-Content-Type-Options: nosniff