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.eyJ1c2VyX2lkIjoidWFhLWlkLTE2MyIsImVtYWlsIjoiZW1haWwtMTE1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTk5ODk5NzB9.fCuJzMWMupdozmrfLnhP3qoUpZ1pOUpm_eYI0rbufZA Host: example.org Cookie:
GET /v2/private_domains
q: name:my-domain.com
curl "https://api.[your-domain.com]/v2/private_domains" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE2MyIsImVtYWlsIjoiZW1haWwtMTE1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTk5ODk5NzB9.fCuJzMWMupdozmrfLnhP3qoUpZ1pOUpm_eYI0rbufZA" \ -H "Host: example.org" \ -H "Cookie: "
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: 7ea9672d-e765-46f8-b25e-70c28eaef4b3 Content-Length: 583 X-Content-Type-Options: nosniff
200 OK
{ "total_results": 1, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "dd1b1a63-8c3d-4211-a4fe-34f7b8c9c636", "url": "/v2/private_domains/dd1b1a63-8c3d-4211-a4fe-34f7b8c9c636", "created_at": "2014-12-24T01:39:30+00:00", "updated_at": null }, "entity": { "name": "my-domain.com", "owning_organization_guid": "9da0ee2c-aff4-4b3c-a058-614e3c200c20", "owning_organization_url": "/v2/organizations/9da0ee2c-aff4-4b3c-a058-614e3c200c20" } } ] }