Home
Version 3
Private Domains API

Private Domains API

Retrieve a Particular Private Domain

GET /v2/private_domains/:guid

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
guid The guid of the Private Domain

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMyMSIsImVtYWlsIjoiZW1haWwtMjQ2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTc0NjIzNzJ9.wrfUafhBjsq2V42d_81qX60fZ5hbvTFq2K0FbokP9wg
Host: example.org
Cookie: 

Route

GET /v2/private_domains/2905d93a-2816-430d-9120-b5320416728c

cURL

curl "https://api.[your-domain.com]/v2/private_domains/2905d93a-2816-430d-9120-b5320416728c" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMyMSIsImVtYWlsIjoiZW1haWwtMjQ2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTc0NjIzNzJ9.wrfUafhBjsq2V42d_81qX60fZ5hbvTFq2K0FbokP9wg" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 1070dcae-777f-4f98-a71c-5daeff412228
Content-Length: 418
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "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"
  }
}