Sign in
Tenants

Modify an existing Tenant.

put/spaces/{spaceIdentifier}/tenants/{id}

Path parameters

spaceIdentifierstring required

Identifier (ID or slug) of the space

idstring required

ID of the Tenant to modify.

Request body

Descriptionstring
Idstring required

ID of the Tenant to modify.

IsDisabledboolean
Namestring required
ProjectEnvironmentsobject

The complete set of projects the tenant is connected to, as an object keyed by project ID where each value is the array of environment IDs the tenant can deploy to for that project. Example: {"Projects-1": ["Environments-1"]}. Replaces the tenant's current connections; omitting an existing project disconnects it and deletes the tenant's variable values for it.

Slugstring

A URL-friendly, unique identifier for the tenant. Resubmit the tenant's current slug unless you intend to change it; changing it breaks existing links that use the old slug.

SpaceIdstring required
TenantTagsstring[]

The complete set of tags for the tenant, as canonical tag names in the form 'TagSetName/TagName'. Example: ["Regions/EU-West", "Tier/Premium"]. Replaces the tenant's current tags; any existing tag omitted here is removed.

Example request

{
  "Id": "Tenants-1",
  "SpaceId": "Spaces-1"
}

Response

Confirms that a Tenant has been modified, containing the updated Tenant

ClonedFromTenantIdstring
CustomFieldsstring[]
Descriptionstring
Idstring

Gets or sets a unique identifier for this resource.

IsDisabledboolean
LastModifiedBystring

Gets or sets the username of the user who last modified this resource.

LastModifiedOnstring date-time

Gets or sets the date/time that this resource was last modified.

Linksobject

Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.

Namestring
ProjectEnvironmentsobject
Slugstring
SpaceIdstring
TenantTagsstring[]

Tags are referenced by CanonicalName like {TagSetName}/{TagName}

Example response

{
  "SpaceId": "Spaces-1"
}

Changes

No recorded changes to this endpoint across all 7 revisions of this API.