Skip to content

Latest commit

 

History

History

api

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 

Documentation for Unity Catalog API

Documentation for API Endpoints

All URIs are relative to http://localhost:8080/api/2.1/unity-catalog

Class Method HTTP request Description
CatalogsApi createCatalog POST /catalogs Create a catalog
CatalogsApi deleteCatalog DELETE /catalogs/{name} Delete a catalog
CatalogsApi getCatalog GET /catalogs/{name} Get a catalog
CatalogsApi listCatalogs GET /catalogs List catalogs
CatalogsApi updateCatalog PATCH /catalogs/{name} Update a catalog
FunctionsApi createFunction POST /functions Create a function. WARNING: This API is experimental and will change in future versions.
FunctionsApi deleteFunction DELETE /functions/{name} Delete a function
FunctionsApi getFunction GET /functions/{name} Get a function
FunctionsApi listFunctions GET /functions List functions
GrantsApi get GET /permissions/{securable_type}/{full_name} Get permissions
GrantsApi update PATCH /permissions/{securable_type}/{full_name} Update a permission
ModelVersionsApi createModelVersion POST /models/versions Create a model version.
ModelVersionsApi deleteModelVersion DELETE /models/{full_name}/versions/{version} Delete a model version
ModelVersionsApi finalizeModelVersion PATCH /models/{full_name}/versions/{version}/finalize Finalize a model version
ModelVersionsApi getModelVersion GET /models/{full_name}/versions/{version} Get a model version
ModelVersionsApi listModelVersions GET /models/{full_name}/versions List model versions of the specified registered model.
ModelVersionsApi updateModelVersion PATCH /models/{full_name}/versions/{version} Update a model version
RegisteredModelsApi createRegisteredModel POST /models Create a model. WARNING: This API is experimental and will change in future versions.
RegisteredModelsApi deleteRegisteredModel DELETE /models/{full_name} Delete a specified registered model.
RegisteredModelsApi getRegisteredModel GET /models/{full_name} Get a specified registered model
RegisteredModelsApi listRegisteredModels GET /models List models
RegisteredModelsApi updateRegisteredModel PATCH /models/{full_name} Update a registered model
SchemasApi createSchema POST /schemas Create a schema
SchemasApi deleteSchema DELETE /schemas/{full_name} Delete a schema
SchemasApi getSchema GET /schemas/{full_name} Get a schema
SchemasApi listSchemas GET /schemas List schemas
SchemasApi updateSchema PATCH /schemas/{full_name} Update a schema
TablesApi createTable POST /tables Create a table. Only external table creation is supported. WARNING: This API is experimental and will change in future versions.
TablesApi deleteTable DELETE /tables/{full_name} Delete a table
TablesApi getTable GET /tables/{full_name} Get a table
TablesApi listTables GET /tables List tables
TemporaryCredentialsApi generateTemporaryModelVersionCredentials POST /temporary-model-version-credentials Generate temporary model version credentials. These credentials are used by clients to write and retrieve model artifacts from the model versions external storage location.
TemporaryCredentialsApi generateTemporaryPathCredentials POST /temporary-path-credentials Generate temporary path credentials.
TemporaryCredentialsApi generateTemporaryTableCredentials POST /temporary-table-credentials Generate temporary table credentials.
TemporaryCredentialsApi generateTemporaryVolumeCredentials POST /temporary-volume-credentials Generate temporary volume credentials.
VolumesApi createVolume POST /volumes Create a Volume
VolumesApi deleteVolume DELETE /volumes/{name} Delete a Volume
VolumesApi getVolume GET /volumes/{name} Get a Volume
VolumesApi listVolumes GET /volumes List Volumes
VolumesApi updateVolume PATCH /volumes/{name} Update a Volume

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.