Sign in

v1

latestOpenAPI 3.0.22026-08-062794201004.1 KB
Organizations

Update Organization Configuration

Updates an existing organization configuration. Use this endpoint to add, update, and delete network subdomains.

Subdomains are not automatically available. You must contact Couchbase support to enable this feature. To open a Support ticket, see Create a Support Ticket.

Subdomains:

  • Can have a maximum of 30 alphanumeric characters.
  • Must be a unique string and not already in use in another tenant or organization. Empty strings are allowed.
  • Only affect new clusters. You cannot update existing clusters to include a new subdomain.

In order to access this endpoint, the provided API key must have the following role:

  • Organization Owner

To learn more, see Organization, Project, and Database Access Overview.

put/v4/organizations/{organizationId}/configuration

Headers

If-Matchstring
Example:12

A precondition header that specifies the entity tag of a resource.

Request body

subdomainstring required

The new name of the subdomain for the organization.

Example request

{
  "subdomain": "abc"
}

Response

Successfully updated the organization configuration.