Tenants

Get a tenant by it's Id

get/tenants/{id}

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/tenants/{id}
  • 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

idstring required

ID of the Tenant to load

Response

Returns a tenant

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.