Home
Version 3
Private Domains API

Private Domains API

Filtering Private Domains by name

GET /v2/private_domains

Fields

Name Description Default Valid Values 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 Valid Values 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.eyJ1c2VyX2lkIjoidWFhLWlkLTEwNiIsImVtYWlsIjoiZW1haWwtNzZAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyMjMyMzUzNn0.16KbFDRCc8HjKVv4ZIJF9wkDOFeXx5nLF6D4XbAq6W8
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.eyJ1c2VyX2lkIjoidWFhLWlkLTEwNiIsImVtYWlsIjoiZW1haWwtNzZAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyMjMyMzUzNn0.16KbFDRCc8HjKVv4ZIJF9wkDOFeXx5nLF6D4XbAq6W8" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: ac61d960-cd7d-4fc5-8482-a733a7b61f76
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": "c54bc45a-82ab-49ca-b673-95582f2ba3fd",
        "url": "/v2/private_domains/c54bc45a-82ab-49ca-b673-95582f2ba3fd",
        "created_at": "2015-01-20T01:52:16+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "my-domain.com",
        "owning_organization_guid": "dfff9073-8db1-43ae-8b60-9030e85d1938",
        "owning_organization_url": "/v2/organizations/dfff9073-8db1-43ae-8b60-9030e85d1938"
      }
    }
  ]
}