UNunitycatalog
RegisteredModels

List models

Changed on

Gets a paginated list of all available models either under the specified parent catalog and schema, or all models stored in UC. There is no guarantee of a specific ordering of the elements in the array.

get/models

Request

  • Base URL
    http://localhost:8080/api/2.1/unity-catalog
  • Auth
    none declared

Query parameters

catalog_namestring

Name of parent catalog for models of interest.

schema_namestring

Name of parent schema for models of interest.

max_resultsinteger

Maximum number of models to return.

  • when set to a value greater than 0, the page length is the minimum of this value and a server configured value;
  • when set to 0, the page length is set to a server configured value;
  • when set to a value less than 0, an invalid parameter error is returned;
page_tokenstring

Opaque token to send for the next page of results (pagination).

Response

The models list was successfully retrieved.

next_page_tokenstring

Opaque token to retrieve the next page of results. Absent if there are no more pages. page_token should be set to this value for the next request (for the next page of results).

Changes

  • 2dd9fd4253e0Revision changes
    • warning

      removed the optional property // from the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • c480cce16063Revision changes
    • info

      the query request parameter catalog_name became optional

    • info

      the query request parameter schema_name became optional