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.eyJ1c2VyX2lkIjoidWFhLWlkLTM2IiwiZW1haWwiOiJlbWFpbC0zNEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI2NjMzODk2fQ.jKY8vKGWLgiVfxuLXJ3286aCwuZp1czRbGmu3jlnMVg Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/domains" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM2IiwiZW1haWwiOiJlbWFpbC0zNEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI2NjMzODk2fQ.jKY8vKGWLgiVfxuLXJ3286aCwuZp1czRbGmu3jlnMVg" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 4, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "a424a340-cff7-4246-9770-a223ff97314e", "url": "/v2/domains/a424a340-cff7-4246-9770-a223ff97314e", "created_at": "2015-03-10T23:11:30Z", "updated_at": null }, "entity": { "name": "customer-app-domain1.com" } }, { "metadata": { "guid": "a087af48-7883-4210-8228-4ebf8d8d9089", "url": "/v2/domains/a087af48-7883-4210-8228-4ebf8d8d9089", "created_at": "2015-03-10T23:11:30Z", "updated_at": null }, "entity": { "name": "customer-app-domain2.com" } }, { "metadata": { "guid": "65e7ed3e-1225-486f-89c2-b0e9374d6816", "url": "/v2/domains/65e7ed3e-1225-486f-89c2-b0e9374d6816", "created_at": "2015-03-10T23:11:30Z", "updated_at": null }, "entity": { "name": "vcap.me", "owning_organization_guid": "a9c5388d-bbea-4e11-9583-5ab141ff02d5", "owning_organization_url": "/v2/organizations/a9c5388d-bbea-4e11-9583-5ab141ff02d5", "spaces_url": "/v2/domains/65e7ed3e-1225-486f-89c2-b0e9374d6816/spaces" } }, { "metadata": { "guid": "1d4e8a24-e304-47f8-8404-9fa46ca9dc81", "url": "/v2/domains/1d4e8a24-e304-47f8-8404-9fa46ca9dc81", "created_at": "2015-03-10T23:11:36Z", "updated_at": null }, "entity": { "name": "domain-7.example.com" } } ] }
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: ab37122e-6135-428d-8334-ba4fae97a39b X-Cf-Warnings: Endpoint+deprecated Content-Length: 1562 X-Content-Type-Options: nosniff