Create a Private Domain owned by the given Organization
POST /v2/private_domains
Request
Route
POST /v2/private_domains
Body
| Name |
Description |
Default |
Valid Values |
Example Values |
|
name
|
The name of the domain.
|
|
|
- example.com
- foo.example.com
|
|
owning_organization_guid
|
The organization that owns the domain. If not specified, the domain is shared.
|
|
|
|
{
"name": "exmaple.com",
"owning_organization_guid": "62e23a1f-4ce0-4e34-a36f-2e8cef0095d7"
}
Headers
cURL
curl "https://api.[your-domain.com]/v2/private_domains" -d '{
"name": "exmaple.com",
"owning_organization_guid": "62e23a1f-4ce0-4e34-a36f-2e8cef0095d7"
}' -X POST \
-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTc4IiwiZW1haWwiOiJlbWFpbC00NkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDQyNjAxNTI4fQ.mBKETjqbxN01CvdRAPYSVxKf5oIvURT3JbeuS-5rK5Y" \
-H "Host: example.org" \
-H "Content-Type: application/x-www-form-urlencoded" \
-H "Cookie: "
Response
Status
201 Created
Body
{
"metadata": {
"guid": "0741213b-126e-483f-96c4-610d63535afc",
"url": "/v2/private_domains/0741213b-126e-483f-96c4-610d63535afc",
"created_at": "2015-09-11T18:38:48Z",
"updated_at": null
},
"entity": {
"name": "exmaple.com",
"owning_organization_guid": "62e23a1f-4ce0-4e34-a36f-2e8cef0095d7",
"owning_organization_url": "/v2/organizations/62e23a1f-4ce0-4e34-a36f-2e8cef0095d7",
"shared_organizations_url": "/v2/private_domains/0741213b-126e-483f-96c4-610d63535afc/shared_organizations"
}
}
Headers