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.eyJ1c2VyX2lkIjoidWFhLWlkLTEwNyIsImVtYWlsIjoiZW1haWwtNzdAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyMjMyMzUzNn0.glYrBQAJ256eKWUnxpDsk7uwUjSIi6eKLsQxpfqiLUc
Host: example.org
Cookie: 

Route

GET /v2/private_domains/0780920a-dd73-44ce-b6e6-ae61d79e0947

cURL

curl "https://api.[your-domain.com]/v2/private_domains/0780920a-dd73-44ce-b6e6-ae61d79e0947" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEwNyIsImVtYWlsIjoiZW1haWwtNzdAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyMjMyMzUzNn0.glYrBQAJ256eKWUnxpDsk7uwUjSIi6eKLsQxpfqiLUc" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 46b8b16e-96df-4bd8-b0c6-93efd112cefb
Content-Length: 418
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "metadata": {
    "guid": "0780920a-dd73-44ce-b6e6-ae61d79e0947",
    "url": "/v2/private_domains/0780920a-dd73-44ce-b6e6-ae61d79e0947",
    "created_at": "2015-01-20T01:52:15+00:00",
    "updated_at": null
  },
  "entity": {
    "name": "vcap.me",
    "owning_organization_guid": "0468a4c0-e364-4d6d-b90a-4b5a27be9092",
    "owning_organization_url": "/v2/organizations/0468a4c0-e364-4d6d-b90a-4b5a27be9092"
  }
}