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/159aa6b5-89d1-4021-a883-5c265c7d1a0a

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.eyJ1c2VyX2lkIjoidWFhLWlkLTM2MyIsImVtYWlsIjoiZW1haWwtMjY1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDUzNjIzMTd9.s150uO8R5bDVbMRQ-efS6sn6H_ek34Vcid17xPLcGlA
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/shared_domains/159aa6b5-89d1-4021-a883-5c265c7d1a0a" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM2MyIsImVtYWlsIjoiZW1haWwtMjY1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDUzNjIzMTd9.s150uO8R5bDVbMRQ-efS6sn6H_ek34Vcid17xPLcGlA" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "metadata": {
    "guid": "159aa6b5-89d1-4021-a883-5c265c7d1a0a",
    "url": "/v2/shared_domains/159aa6b5-89d1-4021-a883-5c265c7d1a0a",
    "created_at": "2015-10-13T17:31:45Z",
    "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: 9d3740de-c2bc-486f-92c8-a6ddadf831fc
Content-Length: 299
X-Content-Type-Options: nosniff