---
title: "Create a new Tenant."
method: POST
path: "/tenants"
tags: ["Tenants"]
---

# Create a new Tenant.

`POST /tenants`

Creates a new Tenant, optionally cloning an existing tenant if the clone query string parameter is provided.

## Request body

- CreateTenantCommand — Creates a new Tenant, optionally cloning an existing tenant if the clone query string parameter is provided.
  - `Clone` string — The ID of the Tenant to clone. Example: Tenants-101.
  - `Description` string
  - `IsDisabled` boolean
  - `Name` string, required
  - `ProjectEnvironments` object — The 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", "Environments-2"]}.
  - `Slug` string — A URL-friendly, unique identifier for the tenant. Generated from the name when omitted, which is usually what you want.
  - `SpaceId` string, required
  - `TenantTags` string[] — Tags to apply to the tenant, as canonical tag names in the form 'TagSetName/TagName'. Example: ["Regions/EU-West", "Tier/Premium"]. Only tags from tenant-scoped tag sets are valid.

## Response `201`

Created

- TenantResource
  - `ClonedFromTenantId` string
  - `CustomFields` string[]
  - `Description` string
  - `Icon` IconResource
    - `Color` string — Icon background colour, as a Hex string
    - `Id` string — Font Awesome Icon Id
  - `Id` string — Gets or sets a unique identifier for this resource.
  - `IsDisabled` boolean
  - `LastModifiedBy` string — Gets or sets the username of the user who last modified this resource.
  - `LastModifiedOn` string, date-time — Gets or sets the date/time that this resource was last modified.
  - `Links` object — Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
  - `Name` string
  - `ProjectEnvironments` object
  - `Slug` string
  - `SpaceId` string
  - `TenantTags` string[] — Tags are referenced by CanonicalName like {TagSetName}/{TagName}

## Other responses

- `400` — Bad request. Either the payload was not structurally valid or business rules did not permit the operation.
- `404` — Not found. One or more of the entities involved in the operation was not found.

---

[API](https://skmtc.net/octopus/apis/octopus-server-api.md) · [All operations](https://skmtc.net/octopus/apis/octopus-server-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/octopus/octopus-server-api/revisions/b296c3a60aa5/schema)