Tenants

List all tenants

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

get/spaces/{spaceIdentifier}/tenants/all

Request

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

Path parameters

spaceIdentifierstring required

Identifier (ID or slug) of the space

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

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.