Name | Description | Default | Valid Values | Example Values |
---|---|---|---|---|
guid | The guid of the domain. |
|
|
|
name | The name of the domain. |
|
|
|
owning_organization_guid | The organization that owns the domain. If not specified, the domain is shared. |
|
|
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. |
|
|
Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTg3IiwiZW1haWwiOiJlbWFpbC01OEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDE1NzU0MTM0fQ.mvX45qPxs4vo3fG7RqQPTv0NVuiN9jxJI4Jky60zNEo Host: example.org Cookie:
GET /v2/private_domains
curl "https://api.[your-domain.com]/v2/private_domains" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTg3IiwiZW1haWwiOiJlbWFpbC01OEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDE1NzU0MTM0fQ.mvX45qPxs4vo3fG7RqQPTv0NVuiN9jxJI4Jky60zNEo" \ -H "Host: example.org" \ -H "Cookie: "
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: e60a4a8b-4f05-4f29-8f85-d93a64986d7e Content-Length: 2032 X-Content-Type-Options: nosniff
200 OK
{ "total_results": 4, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "6745245d-4b3b-4907-b01f-7a7a56092652", "url": "/v2/private_domains/6745245d-4b3b-4907-b01f-7a7a56092652", "created_at": "2014-11-05T01:02:07+00:00", "updated_at": null }, "entity": { "name": "vcap.me", "owning_organization_guid": "45d39e6a-3d94-47c7-93c5-fac8bf5131b1", "owning_organization_url": "/v2/organizations/45d39e6a-3d94-47c7-93c5-fac8bf5131b1" } }, { "metadata": { "guid": "97247a7a-211f-4456-817e-58322a75cae6", "url": "/v2/private_domains/97247a7a-211f-4456-817e-58322a75cae6", "created_at": "2014-11-05T01:02:13+00:00", "updated_at": null }, "entity": { "name": "domain-1.example.com", "owning_organization_guid": "ca4add14-0916-4179-ae5a-fef4ca24a89d", "owning_organization_url": "/v2/organizations/ca4add14-0916-4179-ae5a-fef4ca24a89d" } }, { "metadata": { "guid": "f6e57e48-7a94-4c45-b7f6-7edd4e6a92c7", "url": "/v2/private_domains/f6e57e48-7a94-4c45-b7f6-7edd4e6a92c7", "created_at": "2014-11-05T01:02:13+00:00", "updated_at": null }, "entity": { "name": "domain-2.example.com", "owning_organization_guid": "a7ad3bea-8ff4-41a2-afae-011f4848a1ab", "owning_organization_url": "/v2/organizations/a7ad3bea-8ff4-41a2-afae-011f4848a1ab" } }, { "metadata": { "guid": "f06a565c-3669-4447-91e3-23c7717fad4b", "url": "/v2/private_domains/f06a565c-3669-4447-91e3-23c7717fad4b", "created_at": "2014-11-05T01:02:13+00:00", "updated_at": null }, "entity": { "name": "domain-3.example.com", "owning_organization_guid": "554c7897-05a4-491e-9aa6-15188796ae9e", "owning_organization_url": "/v2/organizations/554c7897-05a4-491e-9aa6-15188796ae9e" } } ] }