Home
Version 3
Shared Domains API

Shared Domains API

Retrieve a Particular Shared Domain

GET /v2/shared_domains/:guid

Fields

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

Parameters

Name Description Valid Values Example Values
guid The guid of the Shared Domain

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTU4IiwiZW1haWwiOiJlbWFpbC01MUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDE2NTI2Njk4fQ.X2b21TzdO_ncr_6qR_PXrnQ66SfnktmThWx8f1Q8CG4
Host: example.org
Cookie: 

Route

GET /v2/shared_domains/10e72d9a-9f21-4fdc-a17e-7a3c8f5dcdf9

cURL

curl "https://api.[your-domain.com]/v2/shared_domains/10e72d9a-9f21-4fdc-a17e-7a3c8f5dcdf9" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTU4IiwiZW1haWwiOiJlbWFpbC01MUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDE2NTI2Njk4fQ.X2b21TzdO_ncr_6qR_PXrnQ66SfnktmThWx8f1Q8CG4" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 6e277c76-d337-4fef-93da-1bd18c8b426c
Content-Length: 273
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "metadata": {
    "guid": "10e72d9a-9f21-4fdc-a17e-7a3c8f5dcdf9",
    "url": "/v2/shared_domains/10e72d9a-9f21-4fdc-a17e-7a3c8f5dcdf9",
    "created_at": "2014-11-13T23:38:13+00:00",
    "updated_at": null
  },
  "entity": {
    "name": "customer-app-domain1.com"
  }
}