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.eyJ1c2VyX2lkIjoidWFhLWlkLTE0OSIsImVtYWlsIjoiZW1haWwtMTIyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTc0NjIzNTl9.5TNgUWRI6FnOwLeWXl4fcQ3gYmLgMzDZQ_NjhdH8qJI
Host: example.org
Cookie: 

Route

GET /v2/shared_domains/34923485-39f0-4173-a71f-8d7bdcc4efd8

cURL

curl "https://api.[your-domain.com]/v2/shared_domains/34923485-39f0-4173-a71f-8d7bdcc4efd8" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE0OSIsImVtYWlsIjoiZW1haWwtMTIyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTc0NjIzNTl9.5TNgUWRI6FnOwLeWXl4fcQ3gYmLgMzDZQ_NjhdH8qJI" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 06320685-a310-4900-93b6-b9ece753809a
Content-Length: 273
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "metadata": {
    "guid": "34923485-39f0-4173-a71f-8d7bdcc4efd8",
    "url": "/v2/shared_domains/34923485-39f0-4173-a71f-8d7bdcc4efd8",
    "created_at": "2014-11-24T19:32:34+00:00",
    "updated_at": null
  },
  "entity": {
    "name": "customer-app-domain1.com"
  }
}