list_datalab_lifecycle_configurations

DatalabsApi.list_datalab_lifecycle_configurations(role_id, offset=None, limit=None, sortorder=None, sortby=None, fields=None, filter_expression=None, system_enabled=None, projection_expression=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

List datalab lifecycle configurations

Returns the lifecycle configurations the caller has access to, together with the built-in ones supplied with the platform. Startup scripts are omitted from the listing - use the get-by-id operation to retrieve them.

Parameters:

  • role_id (str) – User role id (required)

  • offset (int) – 1-based index of the first item to return, so offset=1 is the first page.

  • limit (int) – Maximum number of items to return in one page.

  • sortorder (str) – Direction to sort by.

  • sortby (str) – Configuration field to sort by. Must be a text field present on every configuration, such as LifecycleName, Description, CreatedBy, CreationTime, LastModifiedBy or LastModifiedTime.

  • fields (str) – Restricts which fields sortby may use, and sets the default sortby to the first of them. This does not change which fields are returned - use projectionExpression for that.

  • filter_expression (str) – Filter as one or more Field:Value pairs, comma-separated and combined with AND, for example LifecycleName:install-*. Any field on the item may be used. Matching is case-insensitive; LifecycleName also supports * as a wildcard against the whole value, so use a trailing * for a prefix search. Pairs without a colon are ignored, and a filter with no valid pairs returns everything.

  • system_enabled (str) – Filters the built-in configurations to only those enabled (true) or disabled (false). Configurations the caller owns or has access to are returned either way. Any value other than true is treated as false.

  • projection_expression (str) – Comma-separated list of fields to return; all other fields are omitted.

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

DatalabLifecycleConfigurationList

Returns:

Returns the result object.

Request and Response Examples

HTTP: GET /datalabs/lifecycle-configurations

Success (HTTP 200)

Successful API response

Request / response example

{
  "LifecycleConfigurations": [
    {
      "LifecycleId": "7c2f1b90-3d5e-4a11-9c88-0e5b7a1d2f34",
      "LifecycleName": "install-team-packages",
      "Description": "Installs the team's shared Python packages on startup",
      "Type": "notebook",
      "IsEnabled": true,
      "AccessType": "owner",
      "CreatedBy": "jdoe",
      "CreationTime": "2026-07-20 10:00:00",
      "LastModifiedBy": "jdoe",
      "LastModifiedTime": "2026-08-05 16:42:11",
      "DatalabsAttached": [
        "ml-exploration"
      ]
    }
  ],
  "count": 1,
  "total_count": 1,
  "next_available": "no"
}

Errors

Documented error codes: IPV-1050, IPV-1039, GE-1020.

HTTP 400

Invalid input

limit above the page cap

{
  "Message": "IPV-1050 - Out of range for items per page, Limit is 1000"
}

sortby not in the allowed field list

{
  "Message": "IPV-1039 - Invalid sort_by column, please use one from the list of fields"
}

HTTP 500

Something went wrong at backend

Request / response example

{
  "Message": "GE-1020 - Unable to update LifecycleConfiguration table, please retry or contact administrator"
}