Home
Version 3
Private Domains API

Private Domains API

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": "fe5e0ed5-28b1-43ae-bcea-9c11262f2a47"
}

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE5MSIsImVtYWlsIjoiZW1haWwtMTQyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjU5NDg2Njd9.lOBHpEPJTd2kcSnKZwhdyTll4MKMgrxv0M_aj9nDrYk
Host: example.org
Content-Type: application/x-www-form-urlencoded
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/private_domains" -d '{
  "name": "exmaple.com",
  "owning_organization_guid": "fe5e0ed5-28b1-43ae-bcea-9c11262f2a47"
}' -X POST \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE5MSIsImVtYWlsIjoiZW1haWwtMTQyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjU5NDg2Njd9.lOBHpEPJTd2kcSnKZwhdyTll4MKMgrxv0M_aj9nDrYk" \
	-H "Host: example.org" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Status

201 Created

Body

{
  "metadata": {
    "guid": "b75a2d32-f7db-4353-843f-a824ee724841",
    "url": "/v2/private_domains/b75a2d32-f7db-4353-843f-a824ee724841",
    "created_at": "2015-03-03T00:51:07Z",
    "updated_at": null
  },
  "entity": {
    "name": "exmaple.com",
    "owning_organization_guid": "fe5e0ed5-28b1-43ae-bcea-9c11262f2a47",
    "owning_organization_url": "/v2/organizations/fe5e0ed5-28b1-43ae-bcea-9c11262f2a47",
    "shared_organizations_url": "/v2/private_domains/b75a2d32-f7db-4353-843f-a824ee724841/shared_organizations"
  }
}

Headers

Content-Type: application/json;charset=utf-8
Location: /v2/private_domains/b75a2d32-f7db-4353-843f-a824ee724841
X-VCAP-Request-ID: 8cfcc257-fe7d-4ead-8da6-156edb69f9e4
Content-Length: 530
X-Content-Type-Options: nosniff