Send Docs Feedback

Note: Most user interface tasks can be performed in Edge Classic or the New Edge experience. For an overview, getting started topics, and release notes specific to the New Edge experience, see the docs.

Update organization properties

Resource Summary

Security

Content Type

application/json, application/xml

Category

Organization,

Updateanorganization

POST

Update organization properties

Some Edge functionality is controlled by properties set on an organization. For example, when defining resource paths in API products, you can change the way Edge treats a single forward slash (/) by setting an organization property.

 

Caution: When updating properties, you must pass all existing properties to the API, even if they are not being changed. If you leave properties out of the payload in this API call, the properties are removed. To get the current list of properties for the environment, use the Get Organization API. 

If you try to set a property but it doesn't appear in the response payload, that means the property must be set by a user in the sysadmin role (Apigee Support if your organization is in the cloud). 

 

Some properties you may see in your organization are reserved and unchangable. For example:

  • features.isCpsEnabled - Core Persistence Services is the persistence framework on which Edge runs. You can't change this property.
  • features.isMonetizationEnabled - Monetization is a paid feature. You can't turn it on and off with this API call.

 

When you update other organizaiton properties, you must include any existing reserved properties and their current values in order for this update call to succeed.

 

Available properties are covered in the relevant sections of the documentation.

Resource URL

https://api.enterprise.apigee.com/v1 /organizations/{org_name}

Header Parameters

Name Values Description
Content-Type
(required)

Specify the content type as application/json or application/xml.

Request Body

Note that for an XML payload you must include the Organization element with the organization name and type (trial or paid). For example: <Organization name='myorg' type='trial'>.

org_name Mention the organization name true

HTTP Basic

OAuth 2.0

API Key

Reset

Make a request and see the response.

Make a request and see the response.

Make a request and see the response.

Working...

Help or comments?