Tenant status

Deprecated

Workspace Status Update Endpoint

patch

Endpoint used to update the internal status of an existing workspace.

Args: request: HTTP request. workspace_update: Workspace status update model. tenant_id: Deprecated, use workspace_id instead. workspace_id: ID of the workspace to update. Only required for internal services that are not authenticated with a workspace session token. auth_context: Auth context. workspace_manager: Workspace manager.

Raises: IllegalOperationError: If the user lacks permission to call this endpoint. ValueError: If the workspace update or workspace ID are required but not provided.

Returns: Model of the updated workspace or None if the workspace was deleted.

Authorizations

Query parameters

tenant_idstring · uuidOptional

workspace_idstring · uuidOptional

Body

Defines all status fields that can be updated for a workspace.

statusall ofOptional

The new operational status of the workspace.

Enum that represents the desired state or status of a workspace.

These values can be used in two places:

• in the desired_state field of a workspace object, to indicate the desired state of the workspace (with the exception of PENDING and FAILED which are not valid values for desired_state)
• in the status field of a workspace object, to indicate the current state of the workspace

zenml_serviceall ofOptional

The ZenML service status update.

ZenML service status update model.

mlflow_serviceall ofOptional

The MLflow service status update.

MLflow service update model.

Responses

application/json

objectOptional

Pydantic Model for viewing a workspace.

application/json

patch

HTTPcURLJavaScriptPython

PATCH /tenant_status HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 180

{
  "status": "not_initialized",
  "zenml_service": {
    "status": {
      "server_url": "text",
      "version": "text"
    }
  },
  "mlflow_service": {
    "status": {
      "server_url": "text",
      "username": "text",
      "password": "text"
    }
  }
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "display_name": "text",
  "description": "text",
  "logo_url": "text",
  "organization": {
    "name": "text",
    "description": "text",
    "logo_url": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "created": "2025-04-21T16:49:05.607Z",
    "updated": "2025-04-21T16:49:05.607Z",
    "owner": {
      "name": "text",
      "avatar_url": "text",
      "company": "text",
      "job_title": "text",
      "metadata": {},
      "password": "text",
      "password_expired": true,
      "email": "[e-mail]",
      "oauth_provider": "text",
      "oauth_id": "text",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "is_active": true,
      "is_superuser": true
    },
    "has_active_subscription": true,
    "trial_expiry": 1
  },
  "owner": {
    "name": "text",
    "avatar_url": "text",
    "company": "text",
    "job_title": "text",
    "metadata": {},
    "password": "text",
    "password_expired": true,
    "email": "[e-mail]",
    "oauth_provider": "text",
    "oauth_id": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "is_active": true,
    "is_superuser": true
  },
  "is_managed": true,
  "enrollment_key": "text",
  "zenml_service": {
    "configuration": {
      "version": "text",
      "analytics_enabled": true,
      "secrets_store": {
        "type": "sql"
      },
      "backup_secrets_store": {
        "type": "sql"
      },
      "admin": {
        "helm_chart_version": "text",
        "image_repository": "text",
        "image_tag": "text",
        "debug": true,
        "rbac_implementation_source": "text",
        "workload_manager_implementation_source": "text",
        "feature_gate_implementation_source": "text",
        "environment_vars": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "secret_environment_vars": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "provider_type": "argocd",
        "provider_config": {},
        "service_tier": "basic",
        "resources": {
          "replicas": 1,
          "cpu": "text",
          "memory": "text",
          "max_cpu": "text",
          "max_memory": "text",
          "memory_migration": "text",
          "max_memory_migration": "text",
          "autoscaling_enabled": true,
          "min_replicas": 1,
          "max_replicas": 1,
          "thread_pool_size": 1,
          "db_pool_size": 1,
          "db_pool_overflow": 1
        }
      }
    },
    "status": {
      "server_url": "text",
      "version": "text"
    }
  },
  "mlflow_service": {
    "configuration": {
      "version": "text",
      "artifact_store": {
        "type": "cloud",
        "auth_config": {},
        "auth_config_secret": "text"
      },
      "admin": {
        "provider_config": {},
        "service_tier": "basic",
        "resources": {
          "replicas": 1,
          "cpu": "text",
          "memory": "text"
        }
      }
    },
    "status": {
      "server_url": "text",
      "username": "text",
      "password": "text"
    }
  },
  "usage_counts": {
    "ANY_ADDITIONAL_PROPERTY": 1
  },
  "desired_state": "not_initialized",
  "state_reason": "user_action",
  "status": "not_initialized",
  "created": "2025-04-21T16:49:05.607Z",
  "updated": "2025-04-21T16:49:05.607Z",
  "status_updated": "2025-04-21T16:49:05.607Z"
}