Home
Version 3
Shared Domains API

Shared Domains API

Create a Shared Domain

POST /v2/shared_domains

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

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMiLCJlbWFpbCI6ImVtYWlsLTNAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQxOTk4OTk2MH0.mZaPdu50huuSHPfiE5jE5X9w-NW--_LhJA-T6ieCTWE
Host: example.org
Content-Type: application/x-www-form-urlencoded
Cookie: 

Route

POST /v2/shared_domains

Body

{
  "name": "example.com"
}

cURL

curl "https://api.[your-domain.com]/v2/shared_domains" -d '{
  "name": "example.com"
}' -X POST \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMiLCJlbWFpbCI6ImVtYWlsLTNAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQxOTk4OTk2MH0.mZaPdu50huuSHPfiE5jE5X9w-NW--_LhJA-T6ieCTWE" \
	-H "Host: example.org" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
Location: /v2/shared_domains/d7d1c853-79d0-4542-a3ff-4506d4372a53
X-VCAP-Request-ID: 69088676-bf8f-404e-835d-6642d28de70f
Content-Length: 260
X-Content-Type-Options: nosniff

Status

201 Created

Body

{
  "metadata": {
    "guid": "d7d1c853-79d0-4542-a3ff-4506d4372a53",
    "url": "/v2/shared_domains/d7d1c853-79d0-4542-a3ff-4506d4372a53",
    "created_at": "2014-12-24T01:39:20+00:00",
    "updated_at": null
  },
  "entity": {
    "name": "example.com"
  }
}