Private Domains API

Filtering Private Domains by name

GET /v2/private_domains

Fields

Name	Description	Example Values
guid	The guid of the domain.
name	The name of the domain.	example.com foo.example.com
owning_organization_guid	The organization that owns the domain. If not specified, the domain is shared.

Parameters

Name	Description	Example Values
q	Parameters used to filter the result set. Format queries as <filter><op><value> Valid ops: : >= <= < > IN Valid filters: name	q=filter:value q=filter>value q=filter IN a,b,c
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

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMyMiIsImVtYWlsIjoiZW1haWwtMjQ3QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTc0NjIzNzN9.i4XCsPZefTqB0gEM-zL54D1_1H5_vFZmOOpliJY937U
Host: example.org
Cookie:

Route

GET /v2/private_domains

Query Parameters

q: name:my-domain.com

cURL

curl "https://api.[your-domain.com]/v2/private_domains" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMyMiIsImVtYWlsIjoiZW1haWwtMjQ3QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTc0NjIzNzN9.i4XCsPZefTqB0gEM-zL54D1_1H5_vFZmOOpliJY937U" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 43769516-8d0b-4dce-bd2d-968987258cb3
Content-Length: 583
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "ac2c2267-467c-48e5-8ce3-fdfaad999818",
        "url": "/v2/private_domains/ac2c2267-467c-48e5-8ce3-fdfaad999818",
        "created_at": "2014-11-24T19:32:52+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "my-domain.com",
        "owning_organization_guid": "73ba9c44-4f32-4eda-8366-6f7233d0fc2d",
        "owning_organization_url": "/v2/organizations/73ba9c44-4f32-4eda-8366-6f7233d0fc2d"
      }
    }
  ]
}