GET /v2/domains
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 |
|
|
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. |
|
|
Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE3MiIsImVtYWlsIjoiZW1haWwtMTA1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDI2MDE1MzR9.brrV33-be2yp7vnPduNc78MsnoRf9DhaNMjPkoKKlnw Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/domains" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE3MiIsImVtYWlsIjoiZW1haWwtMTA1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDI2MDE1MzR9.brrV33-be2yp7vnPduNc78MsnoRf9DhaNMjPkoKKlnw" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 4, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "2829c684-dcc2-4f9a-ae9b-318ad3a5b52e", "url": "/v2/domains/2829c684-dcc2-4f9a-ae9b-318ad3a5b52e", "created_at": "2015-09-11T18:38:44Z", "updated_at": null }, "entity": { "name": "customer-app-domain1.com" } }, { "metadata": { "guid": "e9d521e2-5b91-4250-8cba-5c517b58006c", "url": "/v2/domains/e9d521e2-5b91-4250-8cba-5c517b58006c", "created_at": "2015-09-11T18:38:44Z", "updated_at": null }, "entity": { "name": "customer-app-domain2.com" } }, { "metadata": { "guid": "bf29c3d5-96e4-44b5-983b-3f443f8d7214", "url": "/v2/domains/bf29c3d5-96e4-44b5-983b-3f443f8d7214", "created_at": "2015-09-11T18:38:44Z", "updated_at": null }, "entity": { "name": "vcap.me", "owning_organization_guid": "4beb750c-27ca-430d-a479-5a3bedd3d239", "owning_organization_url": "/v2/organizations/4beb750c-27ca-430d-a479-5a3bedd3d239", "spaces_url": "/v2/domains/bf29c3d5-96e4-44b5-983b-3f443f8d7214/spaces" } }, { "metadata": { "guid": "9518083b-0bca-4840-8840-e4ada84260be", "url": "/v2/domains/9518083b-0bca-4840-8840-e4ada84260be", "created_at": "2015-09-11T18:38:54Z", "updated_at": null }, "entity": { "name": "domain-33.example.com" } } ] }
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: 4e442d88-59d2-44b0-94b9-874464cdb3e2 X-Cf-Warnings: Endpoint+deprecated Content-Length: 1563 X-Content-Type-Options: nosniff