Tenants

List visible tenants

Changed on
get/api/v1/tenants

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/tenants
  • Auth: none declared

Query parameters

qstring

Fuzzy keyword on name / displayName.

phase'Creating' | 'Active' | 'Suspended' | 'Failed'

Filter by tenant status.phase.

statsboolean

Enrich each row with live workload roll-ups (member / active-run / online-service counts). Costs one compute-service call pair per tenant; omit for the cheap name-only listing.

limitinteger

Page size (default 50, max 200).

continuestring

Opaque continue token from the previous response.

Response

A page of visible tenants.

continueTokenstring

Opaque token to fetch the next page.

countinteger required

Number of tenants in this page.

partialboolean

True if some rows could not be enriched with live status.

Example response

{
  "continueToken": "",
  "count": 1,
  "items": [
    {
      "activeExperimentRuns": 2,
      "activeJobRuns": 3,
      "annotations": {
        "axisml.io/created-by": "system-admin"
      },
      "createdAt": "2026-06-20T08:00:00Z",
      "description": "Computer-vision model training and inference team.",
      "displayName": "Vision Team",
      "identifier": "team-vision",
      "initResources": {
        "configMaps": [
          {
            "name": "shared-config",
            "sourceConfigMapRef": {
              "name": "shared-config",
              "namespace": "axisml-system"
            }
          }
        ],
        "imagePullSecrets": [
          {
            "name": "registry-pull",
            "sourceSecretRef": {
              "name": "registry-pull",
              "namespace": "axisml-system"
            }
          }
        ],
        "secrets": [
          {
            "name": "wandb-api-key",
            "sourceSecretRef": {
              "name": "wandb-api-key",
              "namespace": "axisml-system"
            },
            "type": "Opaque"
          }
        ],
        "serviceAccounts": [
          {
            "imagePullSecrets": [
              "registry-pull"
            ],
            "name": "trainer",
            "rbac": {
              "roleRefs": [
                {
                  "kind": "ClusterRole",
                  "name": "edit"
                }
              ]
            }
          }
        ]
      },
      "kubernetesNamespace": "axisml-team-vision",
      "labels": {
        "team": "vision"
      },
      "memberCount": 8,
      "onlineServices": 1,
      "owner": "li.wei",
      "phase": "Active",
      "quotas": [
        {
          "pool": "gpu-a100",
          "units": [
            {
              "quantity": 4,
              "unitName": "a100-2x"
            }
          ]
        }
      ],
      "status": {
        "conditions": [
          {
            "lastTransitionTime": "2026-06-28T09:30:00Z",
            "message": "Namespace and quota provisioned.",
            "reason": "Provisioned",
            "status": "True",
            "type": "Ready"
          }
        ],
        "message": "Tenant is active.",
        "quotas": [
          {
            "pool": "gpu-a100",
            "units": [
              {
                "quantity": 4,
                "unitName": "a100-2x",
                "used": 3
              }
            ]
          }
        ]
      },
      "suspended": false,
      "updatedAt": "2026-06-28T09:30:00Z"
    }
  ],
  "partial": false
}

Changes

  • ba338d5efb11Revision changes
    • info

      added the optional property // to the response with the status

  • 5c2c399c552fRevision changes
    • breaking

      the response property //// became optional for the status

    • info

      added the optional property //// to the response with the status