Home
Version 3
Private Domains API

Private Domains API

List all Private Domains

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.eyJ1c2VyX2lkIjoidWFhLWlkLTI5MSIsImVtYWlsIjoiZW1haWwtMjMxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQzMTAxNDB9.mHlVgyb82gmH5Yvo_9PJvn9jpLNNmo3_SUvQSSr07BM
Host: example.org
Cookie: 

Route

GET /v2/private_domains

cURL

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

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 8c98b881-b19f-48cf-b38c-4bdc73542477
Content-Length: 2015
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 4,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "78ba0d29-c944-4708-b511-271f121f26d1",
        "url": "/v2/private_domains/78ba0d29-c944-4708-b511-271f121f26d1",
        "created_at": "2015-02-12T01:42:07Z",
        "updated_at": null
      },
      "entity": {
        "name": "vcap.me",
        "owning_organization_guid": "038d0095-d2f6-4a72-a9e2-bf75e790df1c",
        "owning_organization_url": "/v2/organizations/038d0095-d2f6-4a72-a9e2-bf75e790df1c"
      }
    },
    {
      "metadata": {
        "guid": "e5857883-d916-4cda-b8e3-f62093d73ffc",
        "url": "/v2/private_domains/e5857883-d916-4cda-b8e3-f62093d73ffc",
        "created_at": "2015-02-12T01:42:20Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-41.example.com",
        "owning_organization_guid": "fc7fed33-efa8-40d4-b500-793736d80ece",
        "owning_organization_url": "/v2/organizations/fc7fed33-efa8-40d4-b500-793736d80ece"
      }
    },
    {
      "metadata": {
        "guid": "9e4c34df-b842-47db-9827-e3e2d46f5d26",
        "url": "/v2/private_domains/9e4c34df-b842-47db-9827-e3e2d46f5d26",
        "created_at": "2015-02-12T01:42:20Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-42.example.com",
        "owning_organization_guid": "dfcd498f-58e8-466b-9473-d281714eb81e",
        "owning_organization_url": "/v2/organizations/dfcd498f-58e8-466b-9473-d281714eb81e"
      }
    },
    {
      "metadata": {
        "guid": "98dce735-01bc-4e98-a2c9-423cf762a557",
        "url": "/v2/private_domains/98dce735-01bc-4e98-a2c9-423cf762a557",
        "created_at": "2015-02-12T01:42:20Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-43.example.com",
        "owning_organization_guid": "9f54cfa8-a1a4-4477-a509-b80e5bbb59ac",
        "owning_organization_url": "/v2/organizations/9f54cfa8-a1a4-4477-a509-b80e5bbb59ac"
      }
    }
  ]
}