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.eyJ1c2VyX2lkIjoidWFhLWlkLTI3OSIsImVtYWlsIjoiZW1haWwtMjA3QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzE2NDY2Mzl9.milF0vaZWb7C1uEDUeAvwRHDFAdGvKysCWGCedUtnv0
Host: example.org
Cookie:

cURL

curl "https://api.[your-domain.com]/v2/private_domains" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI3OSIsImVtYWlsIjoiZW1haWwtMjA3QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzE2NDY2Mzl9.milF0vaZWb7C1uEDUeAvwRHDFAdGvKysCWGCedUtnv0" \
	-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": "9d5e6e48-adfb-48e7-bb28-3ec55805d656",
        "url": "/v2/private_domains/9d5e6e48-adfb-48e7-bb28-3ec55805d656",
        "created_at": "2015-05-07T23:37:19Z",
        "updated_at": null
      },
      "entity": {
        "name": "my-domain.com",
        "owning_organization_guid": "90a9ee5f-8d0d-47e7-a6c7-d534332e3a4d",
        "owning_organization_url": "/v2/organizations/90a9ee5f-8d0d-47e7-a6c7-d534332e3a4d",
        "shared_organizations_url": "/v2/private_domains/9d5e6e48-adfb-48e7-bb28-3ec55805d656/shared_organizations"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: c44091d8-8e78-43ac-a257-ef38526117fe
Content-Length: 695
X-Content-Type-Options: nosniff