Streamlit

List Streamlits¶

GET/api/v2/databases/{database}/schemas/{schema}/streamlits
List Streamlits in a schema. Supports filtering with pattern matching.

Path Parameters¶

ParameterDescription
database 
Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases.
schema 
Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database.

Query Parameters¶

ParameterDescription
like string
Parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters.
startsWith string
Parameter to filter the command output based on the string of characters that appear at the beginning of the object name. Uses case-sensitive pattern matching.
showLimit integer
Parameter to limit the maximum number of rows returned by a command.
fromName string
Parameter to enable fetching rows only following the first row whose object name matches the specified string. Case-sensitive and does not have to be the full name.

Response¶

CodeDescription
200
Successful
202
Successfully accepted the request, but it is not completed yet.

Create a Streamlit¶

POST/api/v2/databases/{database}/schemas/{schema}/streamlits
Create a new Streamlit application, or replace an existing one. Supports CREATE, CREATE OR REPLACE, and CREATE IF NOT EXISTS modes.

Query Parameters¶

ParameterDescription
createMode string
Parameter allowing support for different modes of resource creation. Possible values include:
  • errorIfExists: Throws an error if you try to create a resource that already exists.
  • orReplace: Automatically replaces the existing resource with the current one.
  • ifNotExists: Creates a new resource when an alter is requested for a non-existent resource.

Response¶

CodeDescription
200
Successful request.
202

Fetch a Streamlit¶

GET/api/v2/databases/{database}/schemas/{schema}/streamlits/{name}
Fetch detailed information about a specific Streamlit by name, including metadata, configuration, and version details.

Path Parameters¶

ParameterDescription
name 
Identifier (i.e. name) for the resource.

Response¶

CodeDescription
200
Successful
202

Delete a Streamlit¶

DELETE/api/v2/databases/{database}/schemas/{schema}/streamlits/{name}
Delete a Streamlit. The Streamlit can be restored using undrop within the retention period.

Query Parameters¶

ParameterDescription
ifExists boolean
Parameter that specifies how to handle the request for a resource that does not exist:
  • true: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource.
  • false: The endpoint throws an error if the resource doesn't exist.

Response¶

CodeDescription
200
202

Undrop a Streamlit¶

POST/api/v2/databases/{database}/schemas/{schema}/streamlits/{name}:undrop
Restore a previously deleted Streamlit within the retention period.

Response¶

CodeDescription
200
202

Rename a Streamlit¶

POST/api/v2/databases/{database}/schemas/{schema}/streamlits/{name}:rename
Rename a Streamlit to a new name, optionally in a different database or schema.

Query Parameters¶

ParameterDescription
targetDatabase string
Database of the target resource. Defaults to the source's database
targetSchema 
Schema of the target resource. Defaults to the source's schema
targetName 
Name of the target resource.

Response¶

CodeDescription
200
202

Add live version¶

POST/api/v2/databases/{database}/schemas/{schema}/streamlits/{name}:add-live-version
Add a live version to the Streamlit, making a specific version active for users.

Query Parameters¶

ParameterDescription
fromLast boolean
Set the LIVE version to the LAST version of the Streamlit.

Response¶

CodeDescription
200
202

Commit live version¶

POST/api/v2/databases/{database}/schemas/{schema}/streamlits/{name}:commit
If a Git connection is set up, commit the LIVE version of the Streamlit to the Git repository.

Response¶

CodeDescription
200
202

Add version from source¶

POST/api/v2/databases/{database}/schemas/{schema}/streamlits/{name}:add-version
Add a new version to the Streamlit by copying files from a specified stage location.

Response¶

CodeDescription
200
202

Add version from Git¶

POST/api/v2/databases/{database}/schemas/{schema}/streamlits/{name}:add-version-from-git
Add a new version to the Streamlit using a Git reference URI. The URI can point to either a tag or a commit.

Response¶

CodeDescription
200
202

Abort live version¶

POST/api/v2/databases/{database}/schemas/{schema}/streamlits/{name}:abort
Abort the live version of the Streamlit, discarding uncommitted changes if a Git connection is configured.

Response¶

CodeDescription
200
202

Pull from Git¶

POST/api/v2/databases/{database}/schemas/{schema}/streamlits/{name}:pull
Pull the latest changes from the Git repository for a Streamlit with Git integration.

Response¶

CodeDescription
200
202

Push to Git¶

POST/api/v2/databases/{database}/schemas/{schema}/streamlits/{name}:push
Push committed changes from the Streamlit back to its connected Git repository.

Response¶

CodeDescription
200
202
Language: English