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/2bd654ef-9343-4dcf-ae9d-940da1b1009e

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.eyJ1c2VyX2lkIjoidWFhLWlkLTQxNCIsImVtYWlsIjoiZW1haWwtMzEwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDcxMTY4NTd9.p-25KyBXAGswgo1fiO4o323i6UhXti8BRnNbn_TZGlk
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/shared_domains/2bd654ef-9343-4dcf-ae9d-940da1b1009e" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQxNCIsImVtYWlsIjoiZW1haWwtMzEwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDcxMTY4NTd9.p-25KyBXAGswgo1fiO4o323i6UhXti8BRnNbn_TZGlk" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "metadata": {
    "guid": "2bd654ef-9343-4dcf-ae9d-940da1b1009e",
    "url": "/v2/shared_domains/2bd654ef-9343-4dcf-ae9d-940da1b1009e",
    "created_at": "2015-11-03T00:54:10Z",
    "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: 0c415585-a116-4f4d-ad09-419e2f3715e2
Content-Length: 299
X-Content-Type-Options: nosniff