v1

latestSwagger 2.02026-08-061,9128853.7 MB
Tenants

Gets a list of tenants

Lists all of the tenants in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name, and returned 30 at a time.

get/tenants

Query parameters

clonedFromTenantIdstring

A Tenant ID, to limit the included Tenants to those cloned from that Tenant. Example: Tenants-1

idsstring[]

A list of Tenant IDs, to limit the matching of Tenants to those with a particular ID. Example: ["Tenants-1", "Tenants-2"]

isDisabledboolean

Disabled Status, to limit the set of retrieved Tenants to those with the specified disabled status.

namestring

(Obsolete) A partial or complete name to limit the set of retrieved Tenants to. This will perform a "contains" style match against the supplied name or name-fragment. Left for backwards compatibility.

partialNamestring

A partial name, to limit the set of Tenants to those with a name that includes the partial name

projectIdstring

A Project ID, to limit the set of Tenants to those connected to a particular Project. Example: Projects-1

skipinteger

Number of items to skip. Defaults to zero

tagsstring[]

A set of Tenant Tags, to limit the set of retrieved Tenants to those which are tagged with the specific tags. Example: Alpha,Beta,Stable

takeinteger

Number of items to take. Defaults to 30

Response

Requested list of Tenants

Idstring
ItemsPerPageinteger
ItemTypestring
LastModifiedBystring
LastModifiedOnstring date-time
LastPageNumberinteger
Linksobject
NumberOfPagesinteger
TotalResultsinteger