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.eyJ1c2VyX2lkIjoidWFhLWlkLTE0IiwiZW1haWwiOiJlbWFpbC0xNEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDYwNTA2NjM1fQ.Dd27VQLHZMnuWoBKKZeDpokzff0pJ5sthOQFHHcUb_U Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/domains" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE0IiwiZW1haWwiOiJlbWFpbC0xNEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDYwNTA2NjM1fQ.Dd27VQLHZMnuWoBKKZeDpokzff0pJ5sthOQFHHcUb_U" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 4, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "e225bcaa-fd4f-4efc-b1e5-ff8edc88acfe", "url": "/v2/domains/e225bcaa-fd4f-4efc-b1e5-ff8edc88acfe", "created_at": "2016-04-06T00:17:14Z", "updated_at": null }, "entity": { "name": "customer-app-domain1.com", "router_group_guid": null, "router_group_type": null } }, { "metadata": { "guid": "dc82efca-aa61-482b-921f-ea98bc5289a9", "url": "/v2/domains/dc82efca-aa61-482b-921f-ea98bc5289a9", "created_at": "2016-04-06T00:17:14Z", "updated_at": null }, "entity": { "name": "customer-app-domain2.com", "router_group_guid": null, "router_group_type": null } }, { "metadata": { "guid": "8324251f-d0bb-4ae3-bdb7-8145a02761ae", "url": "/v2/domains/8324251f-d0bb-4ae3-bdb7-8145a02761ae", "created_at": "2016-04-06T00:17:14Z", "updated_at": null }, "entity": { "name": "vcap.me", "owning_organization_guid": "6ed77153-9148-4182-9620-179c1fa939ac", "owning_organization_url": "/v2/organizations/6ed77153-9148-4182-9620-179c1fa939ac", "spaces_url": "/v2/domains/8324251f-d0bb-4ae3-bdb7-8145a02761ae/spaces" } }, { "metadata": { "guid": "40b51178-2e1f-4380-8723-935a0e962798", "url": "/v2/domains/40b51178-2e1f-4380-8723-935a0e962798", "created_at": "2016-04-06T00:17:15Z", "updated_at": null }, "entity": { "name": "domain-2.example.com", "router_group_guid": null, "router_group_type": null } } ] }
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: X-Cf-Warnings: Endpoint+deprecated Content-Length: 1772 X-Content-Type-Options: nosniff