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/1c1aad37-9f20-4269-8e74-5d258b4bbbac

Body

Name Description Default Valid Values Example Values

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI3NiIsImVtYWlsIjoiZW1haWwtMjA0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzE2NDY2Mzl9.Sv6o0zAm5o5eH8KS_keBwNVg3c80shdklWjOKxGCs0I
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/private_domains/1c1aad37-9f20-4269-8e74-5d258b4bbbac" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI3NiIsImVtYWlsIjoiZW1haWwtMjA0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzE2NDY2Mzl9.Sv6o0zAm5o5eH8KS_keBwNVg3c80shdklWjOKxGCs0I" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "metadata": {
    "guid": "1c1aad37-9f20-4269-8e74-5d258b4bbbac",
    "url": "/v2/private_domains/1c1aad37-9f20-4269-8e74-5d258b4bbbac",
    "created_at": "2015-05-07T23:37:05Z",
    "updated_at": null
  },
  "entity": {
    "name": "vcap.me",
    "owning_organization_guid": "93ec0abc-2f58-4e1a-8d35-75ccffaac783",
    "owning_organization_url": "/v2/organizations/93ec0abc-2f58-4e1a-8d35-75ccffaac783",
    "shared_organizations_url": "/v2/private_domains/1c1aad37-9f20-4269-8e74-5d258b4bbbac/shared_organizations"
  }
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 02add0e9-465c-4353-aaaf-f181ebf6ec57
Content-Length: 526
X-Content-Type-Options: nosniff