Tenants

Get 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

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

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

Gets or sets a unique identifier for this resource.

ItemsPerPageinteger
ItemTypestring

The type of item in this list

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.

LastPageNumberinteger
Linksobject

Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.

NumberOfPagesinteger
TotalResultsinteger

Example response

{
  "Items": [
    {
      "Icon": {
        "Color": "#3CA4F3",
        "Id": "rocket"
      },
      "Links": {
        "Self": "/api/..."
      },
      "SpaceId": "Spaces-1"
    }
  ],
  "ItemsPerPage": 30,
  "ItemType": "Tenant",
  "LastPageNumber": 1,
  "Links": {
    "Self": "/api/..."
  },
  "NumberOfPages": 2,
  "TotalResults": 42
}

Changes

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