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/2871f0aa-b477-496c-b27e-6002058bff6d

Body

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

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM5MyIsImVtYWlsIjoiZW1haWwtMjk1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDU1NTc5NzB9.z_2fYqNbdGNMDRbVfA5cdT9Kg11phRE_eoylMttuOCc
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/shared_domains/2871f0aa-b477-496c-b27e-6002058bff6d" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM5MyIsImVtYWlsIjoiZW1haWwtMjk1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDU1NTc5NzB9.z_2fYqNbdGNMDRbVfA5cdT9Kg11phRE_eoylMttuOCc" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "metadata": {
    "guid": "2871f0aa-b477-496c-b27e-6002058bff6d",
    "url": "/v2/shared_domains/2871f0aa-b477-496c-b27e-6002058bff6d",
    "created_at": "2015-10-15T23:52:47Z",
    "updated_at": null
  },
  "entity": {
    "name": "customer-app-domain1.com",
    "router_group_guid": null
  }
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 1e7b4332-74de-45d4-bcc0-b976ae4119ac
Content-Length: 299
X-Content-Type-Options: nosniff