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. |
|
|
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.eyJ1c2VyX2lkIjoidWFhLWlkLTEwIiwiZW1haWwiOiJlbWFpbC0xMEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDIyOTkwODYyfQ.jI0rYZLKXlouQ33QjkgfFAwYupJOJaX7Kndj6OcFxy0 Host: example.org Cookie:
GET /v2/private_domains
curl "https://api.[your-domain.com]/v2/private_domains" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEwIiwiZW1haWwiOiJlbWFpbC0xMEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDIyOTkwODYyfQ.jI0rYZLKXlouQ33QjkgfFAwYupJOJaX7Kndj6OcFxy0" \ -H "Host: example.org" \ -H "Cookie: "
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: 014aac9d-44af-4dcb-af4d-efec1872d8c6 Content-Length: 2015 X-Content-Type-Options: nosniff
200 OK
{ "total_results": 4, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "e43b24f9-3b6e-4315-9f05-4b5460d566e8", "url": "/v2/private_domains/e43b24f9-3b6e-4315-9f05-4b5460d566e8", "created_at": "2015-01-27T19:14:21Z", "updated_at": null }, "entity": { "name": "vcap.me", "owning_organization_guid": "2667189d-e832-4947-b63e-2e45b0352cac", "owning_organization_url": "/v2/organizations/2667189d-e832-4947-b63e-2e45b0352cac" } }, { "metadata": { "guid": "eff96180-cf33-42e9-9b7a-e437a7e1fa97", "url": "/v2/private_domains/eff96180-cf33-42e9-9b7a-e437a7e1fa97", "created_at": "2015-01-27T19:14:22Z", "updated_at": null }, "entity": { "name": "domain-13.example.com", "owning_organization_guid": "446f00d8-7c14-4171-8892-d5f11a97eb25", "owning_organization_url": "/v2/organizations/446f00d8-7c14-4171-8892-d5f11a97eb25" } }, { "metadata": { "guid": "be0d500c-f824-48aa-9a2b-5c2afb5eff55", "url": "/v2/private_domains/be0d500c-f824-48aa-9a2b-5c2afb5eff55", "created_at": "2015-01-27T19:14:22Z", "updated_at": null }, "entity": { "name": "domain-14.example.com", "owning_organization_guid": "7690e7ee-53e5-452e-b108-965abef1c18d", "owning_organization_url": "/v2/organizations/7690e7ee-53e5-452e-b108-965abef1c18d" } }, { "metadata": { "guid": "f9d6db15-1e34-4dc1-a18f-41effbf1aa78", "url": "/v2/private_domains/f9d6db15-1e34-4dc1-a18f-41effbf1aa78", "created_at": "2015-01-27T19:14:22Z", "updated_at": null }, "entity": { "name": "domain-15.example.com", "owning_organization_guid": "db731035-25ec-4119-ba83-b90206d3bc69", "owning_organization_url": "/v2/organizations/db731035-25ec-4119-ba83-b90206d3bc69" } } ] }