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.eyJ1c2VyX2lkIjoidWFhLWlkLTQ0MCIsImVtYWlsIjoiZW1haWwtMzA4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTg4NTU2OTB9.ekgkusyF4ieoNLiAEMIMhHOtbWqlxISV7s2qku7D1R4 Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/domains" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQ0MCIsImVtYWlsIjoiZW1haWwtMzA4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTg4NTU2OTB9.ekgkusyF4ieoNLiAEMIMhHOtbWqlxISV7s2qku7D1R4" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 4, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "c8de2128-e518-4f67-87df-b105586982e6", "url": "/v2/domains/c8de2128-e518-4f67-87df-b105586982e6", "created_at": "2016-03-17T21:41:20Z", "updated_at": null }, "entity": { "name": "customer-app-domain1.com", "router_group_guid": null } }, { "metadata": { "guid": "c10a5870-8571-40ec-97e7-717877914977", "url": "/v2/domains/c10a5870-8571-40ec-97e7-717877914977", "created_at": "2016-03-17T21:41:20Z", "updated_at": null }, "entity": { "name": "customer-app-domain2.com", "router_group_guid": null } }, { "metadata": { "guid": "6eed6a7d-4f69-41cc-9f4c-77d1d858ccb3", "url": "/v2/domains/6eed6a7d-4f69-41cc-9f4c-77d1d858ccb3", "created_at": "2016-03-17T21:41:20Z", "updated_at": null }, "entity": { "name": "vcap.me", "owning_organization_guid": "3544d836-c189-480d-a483-a7f2c128b644", "owning_organization_url": "/v2/organizations/3544d836-c189-480d-a483-a7f2c128b644", "spaces_url": "/v2/domains/6eed6a7d-4f69-41cc-9f4c-77d1d858ccb3/spaces" } }, { "metadata": { "guid": "8765171e-b399-4df2-a4cf-6c05de008d88", "url": "/v2/domains/8765171e-b399-4df2-a4cf-6c05de008d88", "created_at": "2016-03-17T21:41:30Z", "updated_at": null }, "entity": { "name": "domain-63.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