835047dab520

latestSwagger 2.02026-08-101,9168873.7 MB
Tenants

Lists all tenants

Lists all of the tenants in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.

get/{spaceId}/tenants/all

Path parameters

spaceIdstring required

The ID of the space containing the resource(s).

Query parameters

idsstring[]

A set of Tenant IDs to retrieve Tenants for.

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 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

projectIdstring

A Project ID, to limit the set of retrieved Tenants to those connected to a particular Project.

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

Response

Requested list of Tenants

ClonedFromTenantIdstring
CustomFieldsstring[]
Descriptionstring
Idstring
IsDisabledboolean
LastModifiedBystring
LastModifiedOnstring date-time
Linksobject
Namestring
ProjectEnvironmentsobject
Slugstring
SpaceIdstring
TenantTagsstring[]