Home
Version 3
Private Domains API

Private Domains API

Filtering Private Domains by name

GET /v2/private_domains

Request

Route

GET /v2/private_domains

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 
q: name:my-domain.com

Body

Name Description Default Valid Values Example Values

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI2IiwiZW1haWwiOiJlbWFpbC0yNkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDMyNzc0OTc5fQ.XHqtMWWxuVqBZ5g5umd19YEi_WGmqqvM2AmVQuFoUwM
Host: example.org
Cookie:

cURL

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

Response

Status

200 OK

Body

{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "b74cae21-564c-4ecf-b795-a1644cf3f1ef",
        "url": "/v2/private_domains/b74cae21-564c-4ecf-b795-a1644cf3f1ef",
        "created_at": "2015-05-21T01:02:59Z",
        "updated_at": null
      },
      "entity": {
        "name": "my-domain.com",
        "owning_organization_guid": "a8c1596e-218b-46d7-b5ac-7a4ddd0d5060",
        "owning_organization_url": "/v2/organizations/a8c1596e-218b-46d7-b5ac-7a4ddd0d5060",
        "shared_organizations_url": "/v2/private_domains/b74cae21-564c-4ecf-b795-a1644cf3f1ef/shared_organizations"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 73526789-1125-44e7-96b7-9fceb972beae
Content-Length: 695
X-Content-Type-Options: nosniff