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.eyJ1c2VyX2lkIjoidWFhLWlkLTI1MiIsImVtYWlsIjoiZW1haWwtMTgzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDk1MzE1Mjh9.V19UKv8M1rHrc4QM5AqwrLWx7gbZxJ4CLSGv-Ybt3as Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/domains" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI1MiIsImVtYWlsIjoiZW1haWwtMTgzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDk1MzE1Mjh9.V19UKv8M1rHrc4QM5AqwrLWx7gbZxJ4CLSGv-Ybt3as" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 4, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "f01b174d-c750-46b0-9ddf-3aeb2064d796", "url": "/v2/domains/f01b174d-c750-46b0-9ddf-3aeb2064d796", "created_at": "2015-11-30T23:38:35Z", "updated_at": null }, "entity": { "name": "customer-app-domain1.com", "router_group_guid": null } }, { "metadata": { "guid": "3595f6cb-81cf-424e-a546-533877ccccfd", "url": "/v2/domains/3595f6cb-81cf-424e-a546-533877ccccfd", "created_at": "2015-11-30T23:38:35Z", "updated_at": null }, "entity": { "name": "customer-app-domain2.com", "router_group_guid": null } }, { "metadata": { "guid": "f84ed6dc-4df2-49ad-bcd8-e7e6245e9073", "url": "/v2/domains/f84ed6dc-4df2-49ad-bcd8-e7e6245e9073", "created_at": "2015-11-30T23:38:35Z", "updated_at": null }, "entity": { "name": "vcap.me", "owning_organization_guid": "ff2e03e9-4f23-44ec-bf57-11dbec3b6a8e", "owning_organization_url": "/v2/organizations/ff2e03e9-4f23-44ec-bf57-11dbec3b6a8e", "spaces_url": "/v2/domains/f84ed6dc-4df2-49ad-bcd8-e7e6245e9073/spaces" } }, { "metadata": { "guid": "cb82bf86-45a2-4f6a-9819-bd1e579281b5", "url": "/v2/domains/cb82bf86-45a2-4f6a-9819-bd1e579281b5", "created_at": "2015-11-30T23:38:48Z", "updated_at": null }, "entity": { "name": "domain-47.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