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 |
|
|
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.eyJ1c2VyX2lkIjoidWFhLWlkLTEwIiwiZW1haWwiOiJlbWFpbC0xMEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDYzNjE4NzA0fQ.bGN3XQJlI6tI0Wzj9bTk4rrsxq1CZOQwXBrQPLxHKPE Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/domains" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEwIiwiZW1haWwiOiJlbWFpbC0xMEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDYzNjE4NzA0fQ.bGN3XQJlI6tI0Wzj9bTk4rrsxq1CZOQwXBrQPLxHKPE" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 4, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "0b84cdf8-3e5e-40e7-b720-a79660db05ea", "url": "/v2/domains/0b84cdf8-3e5e-40e7-b720-a79660db05ea", "created_at": "2016-05-12T00:45:03Z", "updated_at": null }, "entity": { "name": "customer-app-domain1.com", "router_group_guid": null, "router_group_type": null } }, { "metadata": { "guid": "8fdf9817-66cf-474a-96c8-a70a86c7eb08", "url": "/v2/domains/8fdf9817-66cf-474a-96c8-a70a86c7eb08", "created_at": "2016-05-12T00:45:03Z", "updated_at": null }, "entity": { "name": "customer-app-domain2.com", "router_group_guid": null, "router_group_type": null } }, { "metadata": { "guid": "746c5830-be88-4079-90a1-a1bf90393441", "url": "/v2/domains/746c5830-be88-4079-90a1-a1bf90393441", "created_at": "2016-05-12T00:45:03Z", "updated_at": null }, "entity": { "name": "vcap.me", "owning_organization_guid": "328b4999-3835-478e-b9d0-0d643dc88ec4", "owning_organization_url": "/v2/organizations/328b4999-3835-478e-b9d0-0d643dc88ec4", "spaces_url": "/v2/domains/746c5830-be88-4079-90a1-a1bf90393441/spaces" } }, { "metadata": { "guid": "462bc27d-bddd-4b4a-a67e-8936b40b11da", "url": "/v2/domains/462bc27d-bddd-4b4a-a67e-8936b40b11da", "created_at": "2016-05-12T00:45:04Z", "updated_at": null }, "entity": { "name": "domain-10.example.com", "router_group_guid": null, "router_group_type": null } } ] }
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: e2cba8c9-b2f6-45a5-9a58-297f0a3d72dd X-Cf-Warnings: Endpoint+deprecated Content-Length: 1773 X-Content-Type-Options: nosniff