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.eyJ1c2VyX2lkIjoidWFhLWlkLTI2OCIsImVtYWlsIjoiZW1haWwtMTk5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTY0NTIyMzl9.EyAG-H0FW7nVMw5aFRoFJQjzu8KEmrfytoqRa0dO2ac Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/domains" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI2OCIsImVtYWlsIjoiZW1haWwtMTk5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTY0NTIyMzl9.EyAG-H0FW7nVMw5aFRoFJQjzu8KEmrfytoqRa0dO2ac" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 4, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "e39933ad-2265-4d24-bf94-c962b2d60438", "url": "/v2/domains/e39933ad-2265-4d24-bf94-c962b2d60438", "created_at": "2016-02-19T02:03:49Z", "updated_at": null }, "entity": { "name": "customer-app-domain1.com", "router_group_guid": null } }, { "metadata": { "guid": "d664430b-1406-4d22-bc74-293581d36f0b", "url": "/v2/domains/d664430b-1406-4d22-bc74-293581d36f0b", "created_at": "2016-02-19T02:03:49Z", "updated_at": null }, "entity": { "name": "customer-app-domain2.com", "router_group_guid": null } }, { "metadata": { "guid": "cab24f65-5531-43a5-b50d-9c178e69e6b8", "url": "/v2/domains/cab24f65-5531-43a5-b50d-9c178e69e6b8", "created_at": "2016-02-19T02:03:49Z", "updated_at": null }, "entity": { "name": "vcap.me", "owning_organization_guid": "dbc9862e-6e71-4bb8-a768-8d6597b5bd89", "owning_organization_url": "/v2/organizations/dbc9862e-6e71-4bb8-a768-8d6597b5bd89", "spaces_url": "/v2/domains/cab24f65-5531-43a5-b50d-9c178e69e6b8/spaces" } }, { "metadata": { "guid": "98cda72b-ba3a-4968-8526-e64ae6296d7a", "url": "/v2/domains/98cda72b-ba3a-4968-8526-e64ae6296d7a", "created_at": "2016-02-19T02:03:59Z", "updated_at": null }, "entity": { "name": "domain-21.example.com", "router_group_guid": null } } ] }
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: X-Cf-Warnings: Endpoint+deprecated Content-Length: 1668 X-Content-Type-Options: nosniff