Sign in
Tenants

Update tenant display metadata

Changed on
patch/api/v1/tenants/{name}

Request

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

Path parameters

namestring Tenant identifier and logical tenant scope; not a Kubernetes Namespace. required

Request body

annotationsStringMap
descriptionstring

Updated free-text tenant description.

displayNamestring

Updated human-readable tenant name.

labelsStringMap

Example request

{
  "description": "Updated team description.",
  "displayName": "Vision Team (core)"
}

Response

Updated tenant.

activeExperimentRunsinteger required

Number of active experiment runs in the tenant.

activeJobRunsinteger required

Number of active job runs in the tenant.

annotationsStringMap
createdAtstring date-time required

Time the tenant was created.

descriptionstring

Free-text tenant description.

displayNamestring required

Human-readable tenant name.

identifierstring required

Stable logical tenant scope used across Platform, compute and artifacts.

kubernetesNamespacestring required

Physical Kubernetes namespace backing the tenant (may be shared).

labelsStringMap
memberCountinteger required

Number of members bound to the tenant.

onlineServicesinteger required

Number of online ML services in the tenant.

ownerstring

Username of the tenant owner.

phase'Creating' | 'Active' | 'Suspended' | 'Failed' required
suspendedboolean required

Whether new workloads are blocked (Platform-enforced).

updatedAtstring date-time required

Time the tenant was last updated.

Example response

{
  "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"
}

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