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.eyJ1c2VyX2lkIjoidWFhLWlkLTY4IiwiZW1haWwiOiJlbWFpbC00OUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI0NDcxNjg4fQ.a_niJhG1a4uof8h6G0zzbn23Ww_hqVxT8ubSLnT3shk
Host: example.org
Cookie: 

Route

GET /v2/private_domains/e560de99-be61-4c73-8251-04012ae7db92

cURL

curl "https://api.[your-domain.com]/v2/private_domains/e560de99-be61-4c73-8251-04012ae7db92" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTY4IiwiZW1haWwiOiJlbWFpbC00OUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI0NDcxNjg4fQ.a_niJhG1a4uof8h6G0zzbn23Ww_hqVxT8ubSLnT3shk" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 3dc5a478-a789-4d37-bb1a-e524185b061e
Content-Length: 413
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "metadata": {
    "guid": "e560de99-be61-4c73-8251-04012ae7db92",
    "url": "/v2/private_domains/e560de99-be61-4c73-8251-04012ae7db92",
    "created_at": "2015-02-13T22:34:45Z",
    "updated_at": null
  },
  "entity": {
    "name": "vcap.me",
    "owning_organization_guid": "cd4f4314-4ddb-40ce-968d-9bc294719246",
    "owning_organization_url": "/v2/organizations/cd4f4314-4ddb-40ce-968d-9bc294719246"
  }
}