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/022b327d-a0e2-405c-9b6f-495278af60e7

Parameters

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

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.eyJ1c2VyX2lkIjoidWFhLWlkLTM3OSIsImVtYWlsIjoiZW1haWwtMjgxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjYxODc3NjV9.VVnNkPTttA3fcH9XWqgwqNiTn36Hja8JGL7prucFVd4
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/shared_domains/022b327d-a0e2-405c-9b6f-495278af60e7" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM3OSIsImVtYWlsIjoiZW1haWwtMjgxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjYxODc3NjV9.VVnNkPTttA3fcH9XWqgwqNiTn36Hja8JGL7prucFVd4" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "metadata": {
    "guid": "022b327d-a0e2-405c-9b6f-495278af60e7",
    "url": "/v2/shared_domains/022b327d-a0e2-405c-9b6f-495278af60e7",
    "created_at": "2015-03-05T19:15:53Z",
    "updated_at": null
  },
  "entity": {
    "name": "customer-app-domain1.com"
  }
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 8c556424-040c-4101-b52d-868b362929c0
Content-Length: 268
X-Content-Type-Options: nosniff