GET /v2/private_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 |
|
|
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 |
---|
Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM2MyIsImVtYWlsIjoiZW1haWwtMjY0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjkwMzg3MjB9.THFIriUwOQmw_h11fEChVEAPoSTnGp7fXqkbO5KBh2U Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/private_domains" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM2MyIsImVtYWlsIjoiZW1haWwtMjY0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjkwMzg3MjB9.THFIriUwOQmw_h11fEChVEAPoSTnGp7fXqkbO5KBh2U" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 4, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "90f4796d-334d-4db8-aa31-ecf9ee99f484", "url": "/v2/private_domains/90f4796d-334d-4db8-aa31-ecf9ee99f484", "created_at": "2015-04-07T19:11:49Z", "updated_at": null }, "entity": { "name": "vcap.me", "owning_organization_guid": "dee9fea3-3b2e-4436-9a1d-88fae1cf9c36", "owning_organization_url": "/v2/organizations/dee9fea3-3b2e-4436-9a1d-88fae1cf9c36", "shared_organizations_url": "/v2/private_domains/90f4796d-334d-4db8-aa31-ecf9ee99f484/shared_organizations" } }, { "metadata": { "guid": "c8cc4714-28c0-4921-b95f-08a65396959a", "url": "/v2/private_domains/c8cc4714-28c0-4921-b95f-08a65396959a", "created_at": "2015-04-07T19:12:00Z", "updated_at": null }, "entity": { "name": "domain-58.example.com", "owning_organization_guid": "2f5dfc8f-832e-4a8e-9f72-db1991990275", "owning_organization_url": "/v2/organizations/2f5dfc8f-832e-4a8e-9f72-db1991990275", "shared_organizations_url": "/v2/private_domains/c8cc4714-28c0-4921-b95f-08a65396959a/shared_organizations" } }, { "metadata": { "guid": "e602e200-2175-4005-9294-e96bc406ba65", "url": "/v2/private_domains/e602e200-2175-4005-9294-e96bc406ba65", "created_at": "2015-04-07T19:12:00Z", "updated_at": null }, "entity": { "name": "domain-59.example.com", "owning_organization_guid": "98f607eb-4e04-4270-ae5c-48d983298d9e", "owning_organization_url": "/v2/organizations/98f607eb-4e04-4270-ae5c-48d983298d9e", "shared_organizations_url": "/v2/private_domains/e602e200-2175-4005-9294-e96bc406ba65/shared_organizations" } }, { "metadata": { "guid": "de353859-6338-4232-9795-db5846a8aac2", "url": "/v2/private_domains/de353859-6338-4232-9795-db5846a8aac2", "created_at": "2015-04-07T19:12:00Z", "updated_at": null }, "entity": { "name": "domain-60.example.com", "owning_organization_guid": "62d88022-786f-496c-ba80-0b928e7e894a", "owning_organization_url": "/v2/organizations/62d88022-786f-496c-ba80-0b928e7e894a", "shared_organizations_url": "/v2/private_domains/de353859-6338-4232-9795-db5846a8aac2/shared_organizations" } } ] }
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: 27f79ea2-1441-47c6-a52e-1107fd78c453 Content-Length: 2483 X-Content-Type-Options: nosniff