Tenants

Deprecated

List Organization Workspaces Endpoint

get

Endpoint to list workspaces of an organization.

Args: organization_id: Organization ID. status: Filter for only workspaces with this status. offset: Offset for pagination. limit: Limit for pagination. auth_context: The authentication context. rbac: RBAC component. workspace_manager: Workspace manager.

Returns: List of all workspaces matching the given filters.

Authorizations
OAuth2clientCredentialsRequired
Token URL:

OAuth2authorizationCodeRequired
Authorization URL: Token URL: Refresh URL:
Path parameters
organization_idstring · uuidRequired
Query parameters
statusany ofOptional
string · 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:
or
nullOptional
offsetintegerOptionalDefault: 0
limitinteger · max: 100OptionalDefault: 100
Responses
chevron-right
200

Successful Response

application/json

Pydantic Model for viewing a workspace.

idstring · uuidRequired
namestring · min: 1 · max: 50Required

The name of the workspace.

display_namestring · min: 1 · max: 50Required

The display name of the workspace.

descriptionany ofOptional

The description of the workspace.

string · min: 1 · max: 256Optional
or
nullOptional
logo_urlany ofOptional

The logo URL of the workspace.

stringOptional
or
nullOptional
is_managedbooleanOptional

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

Default: true
enrollment_keyany ofOptional

Credentials generated for enrolled workspaces. Only set for enrolled workspaces and only during the enrollment process.

stringOptional
or
nullOptional
mlflow_serviceany ofRequired

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

or
nullOptional
desired_statestring · enumRequired

The desired state of the workspace.

Possible values:
state_reasonstring · enumRequired

The reason for the current workspace state.

Possible values:
statusstring · enumRequired

The current operational state of the workspace.

Possible values:
createdstring · date-timeRequired
updatedstring · date-timeRequired
status_updatedany ofOptional

The time the status was last updated.

string · date-timeOptional
or
nullOptional
get
/organizations/{organization_id}/tenants

Last updated

Was this helpful?