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.eyJ1c2VyX2lkIjoidWFhLWlkLTkiLCJlbWFpbCI6ImVtYWlsLTlAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyMjk5MDg2Mn0.ml0d4pYgKuLC9SJhF0HQh4h7Y68Y8e3UQF8AsDIqVM8
Host: example.org
Cookie: 

Route

GET /v2/private_domains/e43b24f9-3b6e-4315-9f05-4b5460d566e8

cURL

curl "https://api.[your-domain.com]/v2/private_domains/e43b24f9-3b6e-4315-9f05-4b5460d566e8" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTkiLCJlbWFpbCI6ImVtYWlsLTlAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyMjk5MDg2Mn0.ml0d4pYgKuLC9SJhF0HQh4h7Y68Y8e3UQF8AsDIqVM8" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: bae94cfe-e035-4fcd-b31b-0b52f585d094
Content-Length: 413
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "metadata": {
    "guid": "e43b24f9-3b6e-4315-9f05-4b5460d566e8",
    "url": "/v2/private_domains/e43b24f9-3b6e-4315-9f05-4b5460d566e8",
    "created_at": "2015-01-27T19:14:21Z",
    "updated_at": null
  },
  "entity": {
    "name": "vcap.me",
    "owning_organization_guid": "2667189d-e832-4947-b63e-2e45b0352cac",
    "owning_organization_url": "/v2/organizations/2667189d-e832-4947-b63e-2e45b0352cac"
  }
}