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/334625d0-3825-4caa-aa7b-66c2f1f1ab57/private_domains/cabc04f2-66ff-4631-bec7-e3ffec72f9c7

Parameters

Name Description Valid Values Example Values
guid The guid of the Organization
private_domain_guid The guid of the private domain

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTU1IiwiZW1haWwiOiJlbWFpbC0zMkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDYxOTU4MzkxfQ.MiGdNUnkLc6I-V6Dw7jkZHH_dwBn77uVUSLqKEkYzmQ
Host: example.org
Content-Type: application/x-www-form-urlencoded
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/organizations/334625d0-3825-4caa-aa7b-66c2f1f1ab57/private_domains/cabc04f2-66ff-4631-bec7-e3ffec72f9c7" -d '' -X PUT \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTU1IiwiZW1haWwiOiJlbWFpbC0zMkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDYxOTU4MzkxfQ.MiGdNUnkLc6I-V6Dw7jkZHH_dwBn77uVUSLqKEkYzmQ" \
	-H "Host: example.org" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Status

201 Created

Body

{
  "metadata": {
    "guid": "334625d0-3825-4caa-aa7b-66c2f1f1ab57",
    "url": "/v2/organizations/334625d0-3825-4caa-aa7b-66c2f1f1ab57",
    "created_at": "2016-04-22T19:33:11Z",
    "updated_at": null
  },
  "entity": {
    "name": "name-89",
    "billing_enabled": false,
    "quota_definition_guid": "5c001ef7-e7b4-4f3f-888e-e043164afeda",
    "status": "active",
    "quota_definition_url": "/v2/quota_definitions/5c001ef7-e7b4-4f3f-888e-e043164afeda",
    "spaces_url": "/v2/organizations/334625d0-3825-4caa-aa7b-66c2f1f1ab57/spaces",
    "domains_url": "/v2/organizations/334625d0-3825-4caa-aa7b-66c2f1f1ab57/domains",
    "private_domains_url": "/v2/organizations/334625d0-3825-4caa-aa7b-66c2f1f1ab57/private_domains",
    "users_url": "/v2/organizations/334625d0-3825-4caa-aa7b-66c2f1f1ab57/users",
    "managers_url": "/v2/organizations/334625d0-3825-4caa-aa7b-66c2f1f1ab57/managers",
    "billing_managers_url": "/v2/organizations/334625d0-3825-4caa-aa7b-66c2f1f1ab57/billing_managers",
    "auditors_url": "/v2/organizations/334625d0-3825-4caa-aa7b-66c2f1f1ab57/auditors",
    "app_events_url": "/v2/organizations/334625d0-3825-4caa-aa7b-66c2f1f1ab57/app_events",
    "space_quota_definitions_url": "/v2/organizations/334625d0-3825-4caa-aa7b-66c2f1f1ab57/space_quota_definitions"
  }
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: d172318a-6a92-4f03-b8e3-97af90e846cb
Content-Length: 1298
X-Content-Type-Options: nosniff