Home
Version 3
Shared Domains API

Shared Domains API

Retrieve a Particular Shared Domain

GET /v2/shared_domains/:guid

Request

Route

GET /v2/shared_domains/a5a8dd53-df40-45a0-b04b-1cdc71bdc545

Body

Name Description Default Valid Values Example Values
guid The guid of the domain.
name The name of the domain.
  • example.com
  • foo.example.com

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI1MSIsImVtYWlsIjoiZW1haWwtMTc5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzE2NDY2Mzh9.KrEY8_W82xpEwHX7HWQGO-7XAsd998IVxY03HlVozkM
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/shared_domains/a5a8dd53-df40-45a0-b04b-1cdc71bdc545" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI1MSIsImVtYWlsIjoiZW1haWwtMTc5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzE2NDY2Mzh9.KrEY8_W82xpEwHX7HWQGO-7XAsd998IVxY03HlVozkM" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "metadata": {
    "guid": "a5a8dd53-df40-45a0-b04b-1cdc71bdc545",
    "url": "/v2/shared_domains/a5a8dd53-df40-45a0-b04b-1cdc71bdc545",
    "created_at": "2015-05-07T23:37:05Z",
    "updated_at": null
  },
  "entity": {
    "name": "customer-app-domain1.com"
  }
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 17bfc97f-5d1d-4bcc-b37b-52672cbc62a2
Content-Length: 268
X-Content-Type-Options: nosniff