Tenants

Last updated 1 month ago

Was this helpful?

Deprecated

Delete All Workspaces Endpoint

delete

Delete all workspaces.

Args: user: Authenticated user. workspace_manager: Workspace manager.

Raises: IllegalOperationError: If a regular user tries to force delete or if the operation is not allowed in the current environment.

Authorizations

Responses

Responseany

delete

DELETE /tenants HTTP/1.1
Host: 
Accept: */*

200

Successful Response

No content

Deprecated

List Workspaces Endpoint

get

Endpoint to list workspaces.

Only superusers can list all workspaces, without membership.

Args: tenant_id: Deprecated, use workspace_id instead. tenant_name: Deprecated, use workspace_name instead. workspace_id: Workspace ID to filter by. workspace_name: Workspace name to filter by. url: Workspace service URL to filter by. organization_id: Organization ID to filter by. status: Filter by workspace status. is_managed: Filter by whether the workspace is managed by ZenML Pro. owner_id: Id of the Workspace owner offset: Offset for pagination. limit: Limit for pagination. auth_context: Auth context. workspace_manager: Workspace manager. organization_manager: Organization manager. rbac: RBAC component.

Returns: List of all workspaces within the given filter params.

Raises: IllegalOperationError: If the operation is not allowed.

Authorizations

Query parameters

tenant_idstring · uuidOptional

tenant_namestringOptional

workspace_idstring · uuidOptional

workspace_namestringOptional

urlstringOptional

organization_idstring · uuidOptional

statusstring · enumOptional

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

Possible values:

is_managedbooleanOptional

owner_idstring · uuidOptional

offsetintegerOptionalDefault: 0

limitinteger · max: 100OptionalDefault: 100

Responses

get

GET /tenants HTTP/1.1
Host: 
Accept: */*

[
  {
    "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-26T17:46:46.324Z",
      "updated": "2025-04-26T17:46:46.324Z",
      "owner": {
        "name": "text",
        "avatar_url": "text",
        "company": "text",
        "job_title": "text",
        "metadata": {},
        "password": "text",
        "password_expired": true,
        "email": "name@gmail.com",
        "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": "name@gmail.com",
      "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-26T17:46:46.324Z",
    "updated": "2025-04-26T17:46:46.324Z",
    "status_updated": "2025-04-26T17:46:46.324Z"
  }
]

Deprecated

Create Workspace Endpoint

post

Create or enroll a workspace.

Args: workspace_create: Workspace create model. organization_id: ID of the organization to which the workspace belongs to. force: If it should be created regardless of workspace limits. enroll: Set if this is an unmanaged workspace that is being enrolled. name: Name of the workspace. description: Description of the workspace. rbac: RBAC component. user: Authenticated user. workspace_manager: Workspace manager. organization_manager: Organization manager.

Returns: Model of the created workspace.

Raises: IllegalOperationError: If the operation is not allowed.

Authorizations

Query parameters

organization_idstring · uuidOptional

namestringOptional

descriptionstringOptional

forcebooleanOptionalDefault: false

enrollbooleanOptionalDefault: false

Body

Pydantic Model for creating a workspace.

idstring · uuidOptional

Custom workspace ID. Use to enroll an existing workspace or to restore a deleted workspace.

namestring · min: 1 · max: 50Optional

The name of the workspace.

display_namestring · min: 1 · max: 50Optional

The display name of the workspace.

descriptionstring · min: 1 · max: 256Optional

The description of the workspace.

logo_urlstringOptional

The logo URL of the workspace.

owner_idstring · uuidOptional

The UUID of the workspace owner. If not set, the current user is set as the owner.

organization_idstring · uuidOptional

The UUID of the organization the workspace belongs to. If not set, the organization where the current user is owner is set as the workspace's organization.

is_managedbooleanOptional

Whether the workspace is managed by ZenML Pro or managed externally and enrolled.

Default: true

enrollment_keystringOptional

Credentials generated externally for enrolled workspaces. If not set, credentials are generated as part of the enrollment process.

zenml_serviceall ofOptional

The ZenML service configuration. If not set, a default configuration is generated.

mlflow_serviceall ofOptional

The MLflow service configuration. If not set, the MLflow service is not configured.

Responses

post

POST /tenants HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 1399

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "display_name": "text",
  "description": "text",
  "logo_url": "text",
  "owner_id": "123e4567-e89b-12d3-a456-426614174000",
  "organization_id": "123e4567-e89b-12d3-a456-426614174000",
  "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": {
    "enabled": true,
    "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"
        }
      }
    }
  }
}

{
  "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-26T17:46:46.324Z",
    "updated": "2025-04-26T17:46:46.324Z",
    "owner": {
      "name": "text",
      "avatar_url": "text",
      "company": "text",
      "job_title": "text",
      "metadata": {},
      "password": "text",
      "password_expired": true,
      "email": "name@gmail.com",
      "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": "name@gmail.com",
    "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-26T17:46:46.324Z",
  "updated": "2025-04-26T17:46:46.324Z",
  "status_updated": "2025-04-26T17:46:46.324Z"
}