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/4d30b491-9432-45a7-9120-d94b651ef821

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.eyJ1c2VyX2lkIjoidWFhLWlkLTIzNyIsImVtYWlsIjoiZW1haWwtMTU1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzM5ODExMTB9.ETyhI-1jHbfT2ctNNZYXhP5W_zr8dq0XL2-99SvMDNc
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/shared_domains/4d30b491-9432-45a7-9120-d94b651ef821" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIzNyIsImVtYWlsIjoiZW1haWwtMTU1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzM5ODExMTB9.ETyhI-1jHbfT2ctNNZYXhP5W_zr8dq0XL2-99SvMDNc" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "metadata": {
    "guid": "4d30b491-9432-45a7-9120-d94b651ef821",
    "url": "/v2/shared_domains/4d30b491-9432-45a7-9120-d94b651ef821",
    "created_at": "2015-06-04T00:05:05Z",
    "updated_at": null
  },
  "entity": {
    "name": "customer-app-domain1.com"
  }
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 05e7c887-3791-40c5-9401-9e4f055e1683
Content-Length: 268
X-Content-Type-Options: nosniff