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.eyJ1c2VyX2lkIjoidWFhLWlkLTMwOSIsImVtYWlsIjoiZW1haWwtMjEyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDU1NTc5NTl9.N6qt06UXW3Hhp8uX359bIGpA2mjjzrbho6-M1jnczgU Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/domains" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMwOSIsImVtYWlsIjoiZW1haWwtMjEyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDU1NTc5NTl9.N6qt06UXW3Hhp8uX359bIGpA2mjjzrbho6-M1jnczgU" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 4, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "d8b6740f-21d3-4e62-aa83-8b66217e2f60", "url": "/v2/domains/d8b6740f-21d3-4e62-aa83-8b66217e2f60", "created_at": "2015-10-15T23:52:05Z", "updated_at": null }, "entity": { "name": "customer-app-domain1.com", "router_group_guid": null } }, { "metadata": { "guid": "e8611723-2936-473f-911f-d8b03598e2f0", "url": "/v2/domains/e8611723-2936-473f-911f-d8b03598e2f0", "created_at": "2015-10-15T23:52:05Z", "updated_at": null }, "entity": { "name": "customer-app-domain2.com", "router_group_guid": null } }, { "metadata": { "guid": "10a26b62-51cf-43ff-bd18-0a74c021d04b", "url": "/v2/domains/10a26b62-51cf-43ff-bd18-0a74c021d04b", "created_at": "2015-10-15T23:52:05Z", "updated_at": null }, "entity": { "name": "vcap.me", "owning_organization_guid": "5e8d96fc-25f6-42a0-9adf-5f56808619ff", "owning_organization_url": "/v2/organizations/5e8d96fc-25f6-42a0-9adf-5f56808619ff", "spaces_url": "/v2/domains/10a26b62-51cf-43ff-bd18-0a74c021d04b/spaces" } }, { "metadata": { "guid": "2e8757a4-af48-418d-b205-aad248066dfd", "url": "/v2/domains/2e8757a4-af48-418d-b205-aad248066dfd", "created_at": "2015-10-15T23:52:39Z", "updated_at": null }, "entity": { "name": "domain-28.example.com", "router_group_guid": null } } ] }
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: 4b36ba1a-8060-4c74-8246-f3cdbf445986 X-Cf-Warnings: Endpoint+deprecated Content-Length: 1668 X-Content-Type-Options: nosniff