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.eyJ1c2VyX2lkIjoidWFhLWlkLTY2IiwiZW1haWwiOiJlbWFpbC00N0Bzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI0NDcxNjg4fQ.7q1DQv6UAXxekxPEBvGrqTZua2Z5-avLOBKQDa8H1so Host: example.org Cookie:
GET /v2/private_domains
curl "https://api.[your-domain.com]/v2/private_domains" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTY2IiwiZW1haWwiOiJlbWFpbC00N0Bzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI0NDcxNjg4fQ.7q1DQv6UAXxekxPEBvGrqTZua2Z5-avLOBKQDa8H1so" \ -H "Host: example.org" \ -H "Cookie: "
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: dce8ce4c-25a8-4e1a-bd80-46145ac5dd04 Content-Length: 2012 X-Content-Type-Options: nosniff
200 OK
{ "total_results": 4, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "e560de99-be61-4c73-8251-04012ae7db92", "url": "/v2/private_domains/e560de99-be61-4c73-8251-04012ae7db92", "created_at": "2015-02-13T22:34:45Z", "updated_at": null }, "entity": { "name": "vcap.me", "owning_organization_guid": "cd4f4314-4ddb-40ce-968d-9bc294719246", "owning_organization_url": "/v2/organizations/cd4f4314-4ddb-40ce-968d-9bc294719246" } }, { "metadata": { "guid": "5773a499-ac2f-4e16-b7a7-a9eb7356bacb", "url": "/v2/private_domains/5773a499-ac2f-4e16-b7a7-a9eb7356bacb", "created_at": "2015-02-13T22:34:48Z", "updated_at": null }, "entity": { "name": "domain-5.example.com", "owning_organization_guid": "e925c2f0-efd3-4aa6-88ea-1d26adf34d5c", "owning_organization_url": "/v2/organizations/e925c2f0-efd3-4aa6-88ea-1d26adf34d5c" } }, { "metadata": { "guid": "1fb15650-9e0b-431f-a414-9038bba397ce", "url": "/v2/private_domains/1fb15650-9e0b-431f-a414-9038bba397ce", "created_at": "2015-02-13T22:34:48Z", "updated_at": null }, "entity": { "name": "domain-6.example.com", "owning_organization_guid": "02c18789-19ec-4627-a549-8efd520fe6ab", "owning_organization_url": "/v2/organizations/02c18789-19ec-4627-a549-8efd520fe6ab" } }, { "metadata": { "guid": "f4e2ee0a-02d7-4359-9371-5134847e3b3c", "url": "/v2/private_domains/f4e2ee0a-02d7-4359-9371-5134847e3b3c", "created_at": "2015-02-13T22:34:48Z", "updated_at": null }, "entity": { "name": "domain-7.example.com", "owning_organization_guid": "3ccf60ef-dad8-44f0-a806-200a2871d54a", "owning_organization_url": "/v2/organizations/3ccf60ef-dad8-44f0-a806-200a2871d54a" } } ] }