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/265e804e-05de-4d0c-a3e9-1817df0ff230/private_domains/f45956a2-1c83-4633-bc7b-d21c8783e659

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

cURL

curl "https://api.[your-domain.com]/v2/organizations/265e804e-05de-4d0c-a3e9-1817df0ff230/private_domains/f45956a2-1c83-4633-bc7b-d21c8783e659" -d '' -X PUT \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM2MiIsImVtYWlsIjoiZW1haWwtMjQ0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDQ3ODI5NDJ9.PIbNIjIceMNeuoWrQQ05Wdpjzk8i-pywlHr18u35rDI" \
	-H "Host: example.org" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Status

201 Created

Body

{
  "metadata": {
    "guid": "265e804e-05de-4d0c-a3e9-1817df0ff230",
    "url": "/v2/organizations/265e804e-05de-4d0c-a3e9-1817df0ff230",
    "created_at": "2015-10-07T00:35:42Z",
    "updated_at": null
  },
  "entity": {
    "name": "name-2158",
    "billing_enabled": false,
    "quota_definition_guid": "36fd2ba9-265b-4ada-9391-97a29f09da44",
    "status": "active",
    "quota_definition_url": "/v2/quota_definitions/36fd2ba9-265b-4ada-9391-97a29f09da44",
    "spaces_url": "/v2/organizations/265e804e-05de-4d0c-a3e9-1817df0ff230/spaces",
    "domains_url": "/v2/organizations/265e804e-05de-4d0c-a3e9-1817df0ff230/domains",
    "private_domains_url": "/v2/organizations/265e804e-05de-4d0c-a3e9-1817df0ff230/private_domains",
    "users_url": "/v2/organizations/265e804e-05de-4d0c-a3e9-1817df0ff230/users",
    "managers_url": "/v2/organizations/265e804e-05de-4d0c-a3e9-1817df0ff230/managers",
    "billing_managers_url": "/v2/organizations/265e804e-05de-4d0c-a3e9-1817df0ff230/billing_managers",
    "auditors_url": "/v2/organizations/265e804e-05de-4d0c-a3e9-1817df0ff230/auditors",
    "app_events_url": "/v2/organizations/265e804e-05de-4d0c-a3e9-1817df0ff230/app_events",
    "space_quota_definitions_url": "/v2/organizations/265e804e-05de-4d0c-a3e9-1817df0ff230/space_quota_definitions"
  }
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 5de4fcf5-c352-425a-8cfd-5d8066fe0e8b
Content-Length: 1300
X-Content-Type-Options: nosniff