Organizations API

Update an Organization

PUT /v2/organizations/:guid

Request

Route

PUT /v2/organizations/0f345184-4fd5-4728-8cda-d5ad7f183e9f

Parameters

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

Body

Name	Description	Default	Valid Values	Example Values
name	The name of the organization			my-org-name
status	Status of the organization		active suspended
quota_definition_guid	The guid of quota to associate with this organization			org-quota-def-guid
default_isolation_segment_guid	The guid of the isolation segment to set as the organizational default			isolation-segment-guid
billing_enabled	If billing is enabled for this organization

{
  "name": "New Organization Name",
  "quota_definition_guid": "55b3bbcb-e075-4fc3-904d-733feb8964dc"
}

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE5NCIsImVtYWlsIjoiZW1haWwtMTQ5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjYwMDg4OTN9.cGU1H7Md2Vgq6EQ91bPu-Di7B_WQkZ4X5xrYrWL5JiA
Host: example.org
Content-Type: application/json
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/organizations/0f345184-4fd5-4728-8cda-d5ad7f183e9f" -d '{
  "name": "New Organization Name",
  "quota_definition_guid": "55b3bbcb-e075-4fc3-904d-733feb8964dc"
}' -X PUT \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE5NCIsImVtYWlsIjoiZW1haWwtMTQ5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjYwMDg4OTN9.cGU1H7Md2Vgq6EQ91bPu-Di7B_WQkZ4X5xrYrWL5JiA" \
	-H "Host: example.org" \
	-H "Content-Type: application/json" \
	-H "Cookie: "

Response

Status

201 Created

Body

{
  "metadata": {
    "guid": "0f345184-4fd5-4728-8cda-d5ad7f183e9f",
    "url": "/v2/organizations/0f345184-4fd5-4728-8cda-d5ad7f183e9f",
    "created_at": "2016-06-08T16:41:33Z",
    "updated_at": "2016-06-08T16:41:33Z"
  },
  "entity": {
    "name": "New Organization Name",
    "billing_enabled": false,
    "quota_definition_guid": "55b3bbcb-e075-4fc3-904d-733feb8964dc",
    "status": "active",
    "quota_definition_url": "/v2/quota_definitions/55b3bbcb-e075-4fc3-904d-733feb8964dc",
    "spaces_url": "/v2/organizations/0f345184-4fd5-4728-8cda-d5ad7f183e9f/spaces",
    "domains_url": "/v2/organizations/0f345184-4fd5-4728-8cda-d5ad7f183e9f/domains",
    "private_domains_url": "/v2/organizations/0f345184-4fd5-4728-8cda-d5ad7f183e9f/private_domains",
    "users_url": "/v2/organizations/0f345184-4fd5-4728-8cda-d5ad7f183e9f/users",
    "managers_url": "/v2/organizations/0f345184-4fd5-4728-8cda-d5ad7f183e9f/managers",
    "billing_managers_url": "/v2/organizations/0f345184-4fd5-4728-8cda-d5ad7f183e9f/billing_managers",
    "auditors_url": "/v2/organizations/0f345184-4fd5-4728-8cda-d5ad7f183e9f/auditors",
    "app_events_url": "/v2/organizations/0f345184-4fd5-4728-8cda-d5ad7f183e9f/app_events",
    "space_quota_definitions_url": "/v2/organizations/0f345184-4fd5-4728-8cda-d5ad7f183e9f/space_quota_definitions"
  }
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 7f410426-c4dc-4067-92b4-b800bb5ac4f4
Content-Length: 1330
X-Content-Type-Options: nosniff