Home
Version 3
Organizations API

Organizations API

Associate Private Domain with the Organization

PUT /v2/organizations/:guid/private_domains/:private_domain_guid

Request

Route

PUT /v2/organizations/1188cd10-94f5-4b57-a6c5-340b4972336d/private_domains/b2ea9c67-efd0-45db-a0a1-b3fbaafbc79b

Parameters

Name Description Valid Values Example Values
guid The guid of the Organization

Body

Name Description Default Valid Values Example Values

Headers

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

cURL

curl "https://api.[your-domain.com]/v2/organizations/1188cd10-94f5-4b57-a6c5-340b4972336d/private_domains/b2ea9c67-efd0-45db-a0a1-b3fbaafbc79b" -d '' -X PUT \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTY4IiwiZW1haWwiOiJlbWFpbC01NkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDMyNzc0OTgxfQ.UNyCyKf_Ur3slzj5KLa1Dhbn4RNLwWLEB7_r31MRObs" \
	-H "Host: example.org" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Status

201 Created

Body

{
  "metadata": {
    "guid": "1188cd10-94f5-4b57-a6c5-340b4972336d",
    "url": "/v2/organizations/1188cd10-94f5-4b57-a6c5-340b4972336d",
    "created_at": "2015-05-21T01:03:01Z",
    "updated_at": null
  },
  "entity": {
    "name": "name-251",
    "billing_enabled": false,
    "quota_definition_guid": "dbc93096-df73-455f-ad1f-5173a9e47b34",
    "status": "active",
    "quota_definition_url": "/v2/quota_definitions/dbc93096-df73-455f-ad1f-5173a9e47b34",
    "spaces_url": "/v2/organizations/1188cd10-94f5-4b57-a6c5-340b4972336d/spaces",
    "domains_url": "/v2/organizations/1188cd10-94f5-4b57-a6c5-340b4972336d/domains",
    "private_domains_url": "/v2/organizations/1188cd10-94f5-4b57-a6c5-340b4972336d/private_domains",
    "users_url": "/v2/organizations/1188cd10-94f5-4b57-a6c5-340b4972336d/users",
    "managers_url": "/v2/organizations/1188cd10-94f5-4b57-a6c5-340b4972336d/managers",
    "billing_managers_url": "/v2/organizations/1188cd10-94f5-4b57-a6c5-340b4972336d/billing_managers",
    "auditors_url": "/v2/organizations/1188cd10-94f5-4b57-a6c5-340b4972336d/auditors",
    "app_events_url": "/v2/organizations/1188cd10-94f5-4b57-a6c5-340b4972336d/app_events",
    "space_quota_definitions_url": "/v2/organizations/1188cd10-94f5-4b57-a6c5-340b4972336d/space_quota_definitions"
  }
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 6cc845f6-48b8-4263-b3b0-fc41c8ce6d95
Content-Length: 1299
X-Content-Type-Options: nosniff