Sign in

v1

latestOpenAPI 3.0.0CoreStack Inc License2026-07-248001,5071.7 MB
Identity

Update Tenant

Update a tenant's status, description & metadata using its id. No operation can be performed when a tenant is made suspended.

put/tenants/{tenant_id}

Path parameters

tenant_idstring required

Id of the CoreStack account under which the tenant to be updated.

Request body

namestring

New name for the tenant. Tenant Name must be unique within the account. Must be 3-100 characters. Special characters ' " # ? / \ are not allowed.

descriptionstring

Description of the the tenant.

metadataobject

metadata is freeform JSON. It allows to store custom keys and values. It will be useful for storing information about an external applications that will refer to CoreStack tenant.

account_idstring

Id of the CoreStack account under which the tenant to be updated.

azure_hybrid_benefits_enabledboolean

azure hybrid benefits enabled under finOps

status'active' | 'suspended'

Indicates the status of the Tenant

Example request

{
  "cost_anomaly_settings": {
    "threshold_configuration": {
      "category": "all",
      "cost_impact_spend_operator": "and"
    }
  },
  "dimension_settings": [
    {
      "product": "AppSecOps"
    }
  ],
  "status": "active"
}

Response

Success

tenant_idstring required

Id of the updated tenant. This Id will be used for performing tenant level operations such as createPolicy, createScript, onboardCloudAccount and so on.