Update an existing tenant on the Cohesity Cluster.

put

https://cluster.ip.address/irisservices/api/v1/public/tenants

Privileges: ORGANIZATION_MODIFY

Returns the tenant that was updated on the Cohesity Cluster.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request to update existing tenant.

Specifies update details about a tenant.

bifrostEnabled

boolean | null

Specifies whether bifrost (Ambassador proxy) is enabled for tenant.

clusterHostname

string | null

The hostname for Cohesity cluster as seen by tenants and as is routable
from the tenant's network. Tenant's VLAN's hostname, if available can be
used instead but it is mandatory to provide this value if there's no VLAN
hostname to use. Also, when set, this field would take precedence over
VLAN hostname.

clusterIps

array of strings | null

Set of IPs as seen from the tenant's network for the Cohesity cluster.
Only one from 'ClusterHostname' and 'ClusterIps' is needed.

clusterIps

dataSourceConnectorEnabled

boolean | null

Specifies whether data source connector is enabled for the tenant.

description

string | null

Specifies the description of this tenant.

isManagedOnHelios

boolean | null

Specifies whether this tenant is manged on helios

name

string | null

Specifies the name of the tenant.

subscribeToAlertEmails

boolean | null

Service provider can optionally unsubscribe from the Tenant Alert Emails.

tenantId

string | null

Specifies the unique id of the tenant.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Update Tenants Response

defaultError