Home
Version 3
Private Domains API

Private Domains API

Retrieve a Particular Private Domain

GET /v2/private_domains/:guid

Request

Route

GET /v2/private_domains/35e73dbe-411d-4ca1-8174-3d04bf4f74a2

Parameters

Name Description Valid Values Example Values
guid The guid of the Private Domain

Body

Name Description Default Valid Values Example Values

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE1IiwiZW1haWwiOiJlbWFpbC0xNUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI2MTg3NzM1fQ.-18jgGyhH0JDHpzg6tiwS7HGFSjOz7YHpEnFcl_GVN8
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/private_domains/35e73dbe-411d-4ca1-8174-3d04bf4f74a2" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE1IiwiZW1haWwiOiJlbWFpbC0xNUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI2MTg3NzM1fQ.-18jgGyhH0JDHpzg6tiwS7HGFSjOz7YHpEnFcl_GVN8" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "metadata": {
    "guid": "35e73dbe-411d-4ca1-8174-3d04bf4f74a2",
    "url": "/v2/private_domains/35e73dbe-411d-4ca1-8174-3d04bf4f74a2",
    "created_at": "2015-03-05T19:15:29Z",
    "updated_at": null
  },
  "entity": {
    "name": "vcap.me",
    "owning_organization_guid": "204b56c1-66ab-45da-9aa6-2bacfa5e6584",
    "owning_organization_url": "/v2/organizations/204b56c1-66ab-45da-9aa6-2bacfa5e6584",
    "shared_organizations_url": "/v2/private_domains/35e73dbe-411d-4ca1-8174-3d04bf4f74a2/shared_organizations"
  }
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 956fd260-e66a-494c-b511-630bf41f52a0
Content-Length: 526
X-Content-Type-Options: nosniff