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.eyJ1c2VyX2lkIjoidWFhLWlkLTQ0NCIsImVtYWlsIjoiZW1haWwtMzEyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTY0NTIyNDd9.oW1WnoXW9-ZViBnUZJ0qAa8Eg0xeBGLMlb8katR_f-g
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.eyJ1c2VyX2lkIjoidWFhLWlkLTQ0NCIsImVtYWlsIjoiZW1haWwtMzEyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTY0NTIyNDd9.oW1WnoXW9-ZViBnUZJ0qAa8Eg0xeBGLMlb8katR_f-g" \
	-H "Host: example.org" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Status

201 Created

Body

{
  "metadata": {
    "guid": "cd68b407-0092-4d21-b6a5-214f694b58c5",
    "url": "/v2/shared_domains/cd68b407-0092-4d21-b6a5-214f694b58c5",
    "created_at": "2016-02-19T02:04:07Z",
    "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/cd68b407-0092-4d21-b6a5-214f694b58c5
X-VCAP-Request-ID: 
Content-Length: 345
X-Content-Type-Options: nosniff