Tenants

Create a new Tenant.

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

post/tenants

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/tenants
  • Auth
    • API key in header X-Octopus-ApiKey
    • or API key in query parameter ApiKey
    • or API key in header X-NuGet-ApiKey

Request body

Clonestring

The ID of the Tenant to clone. Example: Tenants-101.

Descriptionstring
IsDisabledboolean
Namestring required
ProjectEnvironmentsobject

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"]}.

Slugstring

A URL-friendly, unique identifier for the tenant. Generated from the name when omitted, which is usually what you want.

SpaceIdstring required
TenantTagsstring[]

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.

Example request

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

Response

Created

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

{
  "Icon": {
    "Color": "#3CA4F3",
    "Id": "rocket"
  },
  "Links": {
    "Self": "/api/..."
  },
  "SpaceId": "Spaces-1"
}

Changes

No recorded changes to this operation across all 13 revisions of this API.