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 |
|
|
q: name:my-domain.com
Name | Description | Default | Valid Values | Example Values |
---|
Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM2MSIsImVtYWlsIjoiZW1haWwtMjYyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjkwMzg3MjB9.jqN7A53o3-RgNu2pqcni3479MwoJmqR-deeNyPH1nSg Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/private_domains" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM2MSIsImVtYWlsIjoiZW1haWwtMjYyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjkwMzg3MjB9.jqN7A53o3-RgNu2pqcni3479MwoJmqR-deeNyPH1nSg" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 1, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "b4ae5b1d-8c2b-45fb-abef-55e25718280f", "url": "/v2/private_domains/b4ae5b1d-8c2b-45fb-abef-55e25718280f", "created_at": "2015-04-07T19:12:00Z", "updated_at": null }, "entity": { "name": "my-domain.com", "owning_organization_guid": "a4a4bc44-b4b0-4dbb-92eb-a2c0821c2430", "owning_organization_url": "/v2/organizations/a4a4bc44-b4b0-4dbb-92eb-a2c0821c2430", "shared_organizations_url": "/v2/private_domains/b4ae5b1d-8c2b-45fb-abef-55e25718280f/shared_organizations" } } ] }
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: f0221da1-736e-4b00-a85f-15015043dfed Content-Length: 695 X-Content-Type-Options: nosniff