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 |
|
|
Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQyMyIsImVtYWlsIjoiZW1haWwtMzEzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDE2NjI2MjB9.oMdfeb6z5ETyzzCJB2nOnzZmH0tpsNFmZDw_ni5Fb1w Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/private_domains" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQyMyIsImVtYWlsIjoiZW1haWwtMzEzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDE2NjI2MjB9.oMdfeb6z5ETyzzCJB2nOnzZmH0tpsNFmZDw_ni5Fb1w" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 4, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "f7a02006-3050-4f0e-ba40-95420da00bc9", "url": "/v2/private_domains/f7a02006-3050-4f0e-ba40-95420da00bc9", "created_at": "2015-08-31T21:50:18Z", "updated_at": null }, "entity": { "name": "vcap.me", "owning_organization_guid": "43e4c130-7b35-4489-988b-3df68199adbc", "owning_organization_url": "/v2/organizations/43e4c130-7b35-4489-988b-3df68199adbc", "shared_organizations_url": "/v2/private_domains/f7a02006-3050-4f0e-ba40-95420da00bc9/shared_organizations" } }, { "metadata": { "guid": "5721f01c-814c-4918-9e35-82cdaed9466e", "url": "/v2/private_domains/5721f01c-814c-4918-9e35-82cdaed9466e", "created_at": "2015-08-31T21:50:20Z", "updated_at": null }, "entity": { "name": "domain-67.example.com", "owning_organization_guid": "282144e1-19ad-4b3a-8e76-a5e51e830f5f", "owning_organization_url": "/v2/organizations/282144e1-19ad-4b3a-8e76-a5e51e830f5f", "shared_organizations_url": "/v2/private_domains/5721f01c-814c-4918-9e35-82cdaed9466e/shared_organizations" } }, { "metadata": { "guid": "caa59e20-cff3-413d-a4d9-e939648d7877", "url": "/v2/private_domains/caa59e20-cff3-413d-a4d9-e939648d7877", "created_at": "2015-08-31T21:50:20Z", "updated_at": null }, "entity": { "name": "domain-68.example.com", "owning_organization_guid": "e5705383-13c8-49c6-a7d4-b27686f36db0", "owning_organization_url": "/v2/organizations/e5705383-13c8-49c6-a7d4-b27686f36db0", "shared_organizations_url": "/v2/private_domains/caa59e20-cff3-413d-a4d9-e939648d7877/shared_organizations" } }, { "metadata": { "guid": "6257d7df-0c90-4756-8d48-00cbe61589c3", "url": "/v2/private_domains/6257d7df-0c90-4756-8d48-00cbe61589c3", "created_at": "2015-08-31T21:50:20Z", "updated_at": null }, "entity": { "name": "domain-69.example.com", "owning_organization_guid": "e33c7290-963d-44b6-bc8e-6f4a2b3b90a0", "owning_organization_url": "/v2/organizations/e33c7290-963d-44b6-bc8e-6f4a2b3b90a0", "shared_organizations_url": "/v2/private_domains/6257d7df-0c90-4756-8d48-00cbe61589c3/shared_organizations" } } ] }
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: 438e0bd9-f20b-4f5a-80ac-886ba880043c Content-Length: 2483 X-Content-Type-Options: nosniff