Shared Domains API

Create a Shared Domain

POST /v2/shared_domains

Request

Route

POST /v2/shared_domains

Body

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

{
  "name": "example.com",
  "router_group_guid": "my-random-guid"
}

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQ3MyIsImVtYWlsIjoiZW1haWwtMzQxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTg4NTU2OTR9.OQLe9DZha-4taOoeukh6ryLBenxFO3DQsPTTCp1zkoY
Host: example.org
Content-Type: application/x-www-form-urlencoded
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/shared_domains" -d '{
  "name": "example.com",
  "router_group_guid": "my-random-guid"
}' -X POST \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQ3MyIsImVtYWlsIjoiZW1haWwtMzQxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTg4NTU2OTR9.OQLe9DZha-4taOoeukh6ryLBenxFO3DQsPTTCp1zkoY" \
	-H "Host: example.org" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Status

201 Created

Body

{
  "metadata": {
    "guid": "fa430b9d-bf4a-40b0-8556-f1b6ce54f058",
    "url": "/v2/shared_domains/fa430b9d-bf4a-40b0-8556-f1b6ce54f058",
    "created_at": "2016-03-17T21:41:34Z",
    "updated_at": null
  },
  "entity": {
    "name": "example.com",
    "router_group_guid": "my-random-guid",
    "router_group_types": [
      "tcp"
    ]
  }
}

Headers

Content-Type: application/json;charset=utf-8
Location: /v2/shared_domains/fa430b9d-bf4a-40b0-8556-f1b6ce54f058
X-VCAP-Request-ID: 
Content-Length: 345
X-Content-Type-Options: nosniff