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.eyJ1c2VyX2lkIjoidWFhLWlkLTMxOSIsImVtYWlsIjoiZW1haWwtMjQ0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTc0NjIzNzJ9.394Q85afqlTMLrj1W3Wwn0vT_fsgqlObPR00wN8lReg
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.eyJ1c2VyX2lkIjoidWFhLWlkLTMxOSIsImVtYWlsIjoiZW1haWwtMjQ0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTc0NjIzNzJ9.394Q85afqlTMLrj1W3Wwn0vT_fsgqlObPR00wN8lReg" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: fe0fd689-5dfe-41d8-b1f7-77205475c29e
Content-Length: 2035
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 4,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "2905d93a-2816-430d-9120-b5320416728c",
        "url": "/v2/private_domains/2905d93a-2816-430d-9120-b5320416728c",
        "created_at": "2014-11-24T19:32:47+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "vcap.me",
        "owning_organization_guid": "174db504-3682-4c56-9297-4dafe1a91ca8",
        "owning_organization_url": "/v2/organizations/174db504-3682-4c56-9297-4dafe1a91ca8"
      }
    },
    {
      "metadata": {
        "guid": "0cee62d8-a558-430a-8b8e-e1a0e29298e5",
        "url": "/v2/private_domains/0cee62d8-a558-430a-8b8e-e1a0e29298e5",
        "created_at": "2014-11-24T19:32:52+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "domain-41.example.com",
        "owning_organization_guid": "437973c5-3bf3-41f7-9909-4dd4d3e51bfd",
        "owning_organization_url": "/v2/organizations/437973c5-3bf3-41f7-9909-4dd4d3e51bfd"
      }
    },
    {
      "metadata": {
        "guid": "f473248a-8785-44f2-ac53-857c0274a24b",
        "url": "/v2/private_domains/f473248a-8785-44f2-ac53-857c0274a24b",
        "created_at": "2014-11-24T19:32:52+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "domain-42.example.com",
        "owning_organization_guid": "7ca9e220-2414-4a01-abd5-bdf09cf5a820",
        "owning_organization_url": "/v2/organizations/7ca9e220-2414-4a01-abd5-bdf09cf5a820"
      }
    },
    {
      "metadata": {
        "guid": "63221593-65da-4334-8688-bd20893be186",
        "url": "/v2/private_domains/63221593-65da-4334-8688-bd20893be186",
        "created_at": "2014-11-24T19:32:52+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "domain-43.example.com",
        "owning_organization_guid": "365be08d-a437-4298-9819-26b86655dc68",
        "owning_organization_url": "/v2/organizations/365be08d-a437-4298-9819-26b86655dc68"
      }
    }
  ]
}