list_tenants
Retrieve all tenants within a specified Octopus Deploy space, with optional filtering by project, tags, IDs, or name for targeted tenant management.
Instructions
List tenants in a space
This tool lists all tenants in a given space. The space name is required. Optionally provide skip and take parameters for pagination.
Input Schema
Name | Required | Description | Default |
---|---|---|---|
ids | No | Filter by specific tenant IDs | |
partialName | No | Filter by partial tenant name match | |
projectId | No | Filter by specific project ID | |
skip | No | ||
spaceName | Yes | The space name | |
tags | No | Filter by tenant tags (comma-separated list) | |
take | No |
Input Schema (JSON Schema)
{
"properties": {
"ids": {
"description": "Filter by specific tenant IDs",
"items": {
"type": "string"
},
"type": "array"
},
"partialName": {
"description": "Filter by partial tenant name match",
"type": "string"
},
"projectId": {
"description": "Filter by specific project ID",
"type": "string"
},
"skip": {
"type": "number"
},
"spaceName": {
"description": "The space name",
"type": "string"
},
"tags": {
"description": "Filter by tenant tags (comma-separated list)",
"type": "string"
},
"take": {
"type": "number"
}
},
"required": [
"spaceName"
],
"type": "object"
}