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/cfcbd98b-e135-462c-90db-1e648c0ddd12/private_domains/175a932b-7041-471f-ae9a-fc45b4126086

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.eyJ1c2VyX2lkIjoidWFhLWlkLTEzMCIsImVtYWlsIjoiZW1haWwtOTZAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyNTk0ODY2NX0.rvKmP9ydmEl9Z0ZXlX4GnQC127WfOiCuQso0e_q7Yu0
Host: example.org
Content-Type: application/x-www-form-urlencoded
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/organizations/cfcbd98b-e135-462c-90db-1e648c0ddd12/private_domains/175a932b-7041-471f-ae9a-fc45b4126086" -d '' -X PUT \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEzMCIsImVtYWlsIjoiZW1haWwtOTZAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyNTk0ODY2NX0.rvKmP9ydmEl9Z0ZXlX4GnQC127WfOiCuQso0e_q7Yu0" \
	-H "Host: example.org" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Status

201 Created

Body

{
  "metadata": {
    "guid": "cfcbd98b-e135-462c-90db-1e648c0ddd12",
    "url": "/v2/organizations/cfcbd98b-e135-462c-90db-1e648c0ddd12",
    "created_at": "2015-03-03T00:51:05Z",
    "updated_at": null
  },
  "entity": {
    "name": "name-1066",
    "billing_enabled": false,
    "quota_definition_guid": "fed74fd1-f4d7-4b86-ac66-5e0d9c0abae8",
    "status": "active",
    "quota_definition_url": "/v2/quota_definitions/fed74fd1-f4d7-4b86-ac66-5e0d9c0abae8",
    "spaces_url": "/v2/organizations/cfcbd98b-e135-462c-90db-1e648c0ddd12/spaces",
    "domains_url": "/v2/organizations/cfcbd98b-e135-462c-90db-1e648c0ddd12/domains",
    "private_domains_url": "/v2/organizations/cfcbd98b-e135-462c-90db-1e648c0ddd12/private_domains",
    "users_url": "/v2/organizations/cfcbd98b-e135-462c-90db-1e648c0ddd12/users",
    "managers_url": "/v2/organizations/cfcbd98b-e135-462c-90db-1e648c0ddd12/managers",
    "billing_managers_url": "/v2/organizations/cfcbd98b-e135-462c-90db-1e648c0ddd12/billing_managers",
    "auditors_url": "/v2/organizations/cfcbd98b-e135-462c-90db-1e648c0ddd12/auditors",
    "app_events_url": "/v2/organizations/cfcbd98b-e135-462c-90db-1e648c0ddd12/app_events",
    "space_quota_definitions_url": "/v2/organizations/cfcbd98b-e135-462c-90db-1e648c0ddd12/space_quota_definitions"
  }
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 32e1e837-8e40-4b4d-a1d2-843fb0fe3071
Content-Length: 1300
X-Content-Type-Options: nosniff