Name | Description | Default | Valid Values | Example Values |
---|---|---|---|---|
guid | The guid of the domain. |
|
|
|
name | The name of the domain. |
|
|
|
wildcard | Allow routes with non-empty hosts |
|
|
|
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, owning_organization_guid, space_guid |
|
|
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.eyJ1c2VyX2lkIjoidWFhLWlkLTEzNCIsImVtYWlsIjoiZW1haWwtOTZAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyNDQ3MTY5MX0.2HCWF0Qe8BCYOAxX9Zxtabum2sxlfTqp9yq_UHURxBE Host: example.org Cookie:
GET /v2/domains
curl "https://api.[your-domain.com]/v2/domains" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEzNCIsImVtYWlsIjoiZW1haWwtOTZAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyNDQ3MTY5MX0.2HCWF0Qe8BCYOAxX9Zxtabum2sxlfTqp9yq_UHURxBE" \ -H "Host: example.org" \ -H "Cookie: "
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: ab1a9d40-d193-4c24-b8d4-bceeb2b29d7e X-Cf-Warnings: Endpoint+deprecated Content-Length: 1563 X-Content-Type-Options: nosniff
200 OK
{ "total_results": 4, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "46d3ec1c-f5f0-4adb-a44a-61ac55d49951", "url": "/v2/domains/46d3ec1c-f5f0-4adb-a44a-61ac55d49951", "created_at": "2015-02-13T22:34:45Z", "updated_at": null }, "entity": { "name": "customer-app-domain1.com" } }, { "metadata": { "guid": "11a9666a-b2cb-4936-b637-1e78ccfa63f3", "url": "/v2/domains/11a9666a-b2cb-4936-b637-1e78ccfa63f3", "created_at": "2015-02-13T22:34:45Z", "updated_at": null }, "entity": { "name": "customer-app-domain2.com" } }, { "metadata": { "guid": "e560de99-be61-4c73-8251-04012ae7db92", "url": "/v2/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", "spaces_url": "/v2/domains/e560de99-be61-4c73-8251-04012ae7db92/spaces" } }, { "metadata": { "guid": "3fc606b4-1e38-4f9e-b5de-c376c19f5c11", "url": "/v2/domains/3fc606b4-1e38-4f9e-b5de-c376c19f5c11", "created_at": "2015-02-13T22:34:51Z", "updated_at": null }, "entity": { "name": "domain-19.example.com" } } ] }