List all Xano instances associated with the account. Returns: A dictionary containing a list of Xano instances under the 'instances' key. Example: ``` result = await xano_list_instances() # Returns: {"instances": [{"name": "instance-name", ...}]} ```
Get details for a specific Xano instance. Args: instance_name: The name of the Xano instance (e.g., "xnwv-v1z6-dvnr") Returns: A dictionary containing details about the specified Xano instance. Example: ``` result = await xano_get_instance_details("xnwv-v1z6-dvnr") # Returns instance details as a dictionary ```
List all databases (workspaces) in a specific Xano instance. Args: instance_name: The name of the Xano instance (e.g....
Get details for a specific Xano workspace. Args: instance_name: The name of the Xano instance (e.g., "xnwv-v1z6-dvnr") workspace_id: The ID of the workspace (can be provided as string or number) Returns: A dictionary containing details about the specified workspace. Example: ``` # Both of these will work: result = await xano_get_workspace_details("xnwv-v1z6-dvnr", "5") result = await xano_get_workspace_details("xnwv-v1z6-dvnr", 5) ```
List all tables in a specific Xano database (workspace). Args: instance_name: The name of the Xano instance (e.g., "xnwv-v1z6-dvnr") database_id: The ID of the Xano workspace/database (can be provided as string or number) Returns: A dictionary containing a list of tables under the 'tables' key. Example: ``` # Both of these will work: result = await xano_list_tables("xnwv-v1z6-dvnr", "5") result = await xano_list_tables("xnwv-v1z6-dvnr", 5) ```
Get details for a specific Xano table. Args: instance_name: The name of the Xano instance (e.g., "xnwv-v1z6-dvnr") workspace_id: The ID of the workspace (can be provided as string or number) table_id: The ID of the table (can be provided as string or number) Returns: A dictionary containing details about the specified table. Example: ``` # All of these formats will work: result = await xano_get_table_details("xnwv-v1z6-dvnr", "5", "10") result = await xano_get_table_details("xnwv-v1z6-dvnr", 5, 10) result = await xano_get_table_details("xnwv-v1z6-dvnr", "5", 10) ```
Create a new table in a workspace. Args: instance_name: The name of the Xano instance (e.g., "xnwv-v1z6-dvnr") workspace_id: The ID of the workspace (can be provided as string or number) name: The name of the new table description: Table description docs: Documentation text auth: Whether authentication is required tag: List of tags for the table Returns: A dictionary containing details about the newly created table. Example: ``` result = await xano_create_table("xnwv-v1z6-dvnr", 5, "Users", description="Stores user information") ```
Update an existing table in a workspace. Args: instance_name: The name of the Xano instance (e.g., "xnwv-v1z6-dvnr") workspace_id: The ID of the workspace (can be provided as string or number) table_id: The ID of the table to update (can be provided as string or number) name: The new name of the table description: New table description docs: New documentation text auth: New authentication setting tag: New list of tags for the table Returns: A dictionary containing details about the updated table. Example: ``` # Both formats work: result = await xano_update_table("xnwv-v1z6-dvnr", 5, 10, name="NewTableName") result = await xano_update_table("xnwv-v1z6-dvnr", "5", "10", description="Updated description") ```
Delete a table from a workspace. Args: instance_name: The name of the Xano instance (e.g., "xnwv-v1z6-dvnr") workspace_id: The ID of the workspace (can be provided as string or number) table_id: The ID of the table to delete (can be provided as string or number) Returns: A dictionary containing the result of the delete operation. Example: ``` # Both formats work: result = await xano_delete_table("xnwv-v1z6-dvnr", 5, 10) result = await xano_delete_table("xnwv-v1z6-dvnr", "5", "10") ```
Get schema for a specific Xano table. Args: instance_name: The name of the Xano instance (e.g., "xnwv-v1z6-dvnr") workspace_id: The ID of the workspace (can be provided as string or number) table_id: The ID of the table (can be provided as string or number) Returns: A dictionary containing the schema of the specified table under the 'schema' key. Example: ``` # Both formats work: result = await xano_get_table_schema("xnwv-v1z6-dvnr", 5, 10) result = await xano_get_table_schema("xnwv-v1z6-dvnr", "5", "10") ```
Browse content for a specific Xano table. Args: instance_name: The name of the Xano instance (e.g., "xnwv-v1z6-dvnr") workspace_id: The ID of the workspace (can be provided as string or number) table_id: The ID of the table (can be provided as string or number) page: Page number (default: 1) per_page: Number of records per page (default: 50) Returns: A dictionary containing the table content with pagination. Example: ``` # Any of these formats will work: result = await xano_browse_table_content("xnwv-v1z6-dvnr", 5, 10) result = await xano_browse_table_content("xnwv-v1z6-dvnr", "5", "10", page=2) ```
Add a new field to a table schema. Args: instance_name: The name of the Xano instance (e.g....
Rename a field in a table schema. Args: instance_name: The name of the Xano instance (e.g., "xnwv-v1z6-dvnr") workspace_id: The ID of the workspace (can be provided as string or number) table_id: The ID of the table (can be provided as string or number) old_name: The current name of the field new_name: The new name for the field Returns: A dictionary containing the result of the rename operation Example: ``` # Rename a field result = await xano_rename_schema_field( "xnwv-v1z6-dvnr", 5, 10, old_name="user_email", new_name="email_address" ) ```
Delete a field from a table schema. Args: instance_name: The name of the Xano instance (e.g., "xnwv-v1z6-dvnr") workspace_id: The ID of the workspace (can be provided as string or number) table_id: The ID of the table (can be provided as string or number) field_name: The name of the field to delete Returns: A dictionary containing the result of the delete operation Example: ``` # Delete a field result = await xano_delete_field( "xnwv-v1z6-dvnr", 5, 10, field_name="obsolete_field" ) ```
List all indexes for a table. Args: instance_name: The name of the Xano instance (e.g., "xnwv-v1z6-dvnr") workspace_id: The ID of the workspace (can be provided as string or number) table_id: The ID of the table (can be provided as string or number) Returns: A dictionary containing all indexes defined on the table Example: ``` # Get all indexes for a table result = await xano_list_indexes("xnwv-v1z6-dvnr", 5, 10) ```
Create a btree index on a table. Args: instance_name: The name of the Xano instance (e.g., "xnwv-v1z6-dvnr") workspace_id: The ID of the workspace (can be provided as string or number) table_id: The ID of the table (can be provided as string or number) fields: List of fields and operations for the index [{"name": "field_name", "op": "asc/desc"}] Returns: A dictionary containing the result of the index creation operation Example: ``` # Create an index on a single field result = await xano_create_btree_index( "xnwv-v1z6-dvnr", 5, 10, fields=[{"name": "email", "op": "asc"}] ) # Create a composite index on multiple fields result = await xano_create_btree_index( "xnwv-v1z6-dvnr", "5", "10", fields=[ {"name": "last_name", "op": "asc"}, {"name": "first_name", "op": "asc"} ] ) ```
Create a unique index on a table. Args: instance_name: The name of the Xano instance (e.g., "xnwv-v1z6-dvnr") workspace_id: The ID of the workspace (can be provided as string or number) table_id: The ID of the table (can be provided as string or number) fields: List of fields and operations for the index [{"name": "field_name", "op": "asc/desc"}] Returns: A dictionary containing the result of the unique index creation operation Example: ``` # Create a unique index on email field result = await xano_create_unique_index( "xnwv-v1z6-dvnr", 5, 10, fields=[{"name": "email", "op": "asc"}] ) # Create a composite unique index result = await xano_create_unique_index( "xnwv-v1z6-dvnr", "5", "10", fields=[ {"name": "company_id", "op": "asc"}, {"name": "employee_id", "op": "asc"} ] ) ```
Create a search index on a table. Args: instance_name: The name of the Xano instance (e.g....
Delete an index from a table. Args: instance_name: The name of the Xano instance (e.g., "xnwv-v1z6-dvnr") workspace_id: The ID of the workspace (can be provided as string or number) table_id: The ID of the table (can be provided as string or number) index_id: The ID of the index to delete (can be provided as string or number) Returns: A dictionary containing the result of the index deletion operation Example: ``` # Delete an index result = await xano_delete_index("xnwv-v1z6-dvnr", 5, 10, 15) ```
Search table content using complex filtering. Args: instance_name: The name of the Xano instance (e.g., "xnwv-v1z6-dvnr") workspace_id: The ID of the workspace (can be provided as string or number) table_id: The ID of the table (can be provided as string or number) search_conditions: List of search conditions sort: Dictionary with field names as keys and "asc" or "desc" as values page: Page number (default: 1) per_page: Number of records per page (default: 50) Returns: A dictionary containing the search results and pagination information Example: ``` # Simple search for active users result = await xano_search_table_content( "xnwv-v1z6-dvnr", 5, 10, search_conditions=[ {"field": "status", "operator": "equals", "value": "active"} ], sort={"created_at": "desc"} ) # Complex search with multiple conditions result = await xano_search_table_content( "xnwv-v1z6-dvnr", "5", "10", search_conditions=[ {"field": "age", "operator": "greater_than", "value": 18}, {"field": "subscribed", "operator": "equals", "value": true}, {"field": "last_login", "operator": "greater_than", "value": "2023-01-01"} ], sort={"last_name": "asc", "first_name": "asc"}, page=2, per_page=25 ) ```
Get a specific record from a table. Args: instance_name: The name of the Xano instance (e.g., "xnwv-v1z6-dvnr") workspace_id: The ID of the workspace (can be provided as string or number) table_id: The ID of the table (can be provided as string or number) record_id: The ID of the record to retrieve (can be provided as string or number) Returns: A dictionary containing the record data Example: ``` # Both formats work: result = await xano_get_table_record("xnwv-v1z6-dvnr", 5, 10, 100) result = await xano_get_table_record("xnwv-v1z6-dvnr", "5", "10", "100") ```
Create a new record in a table. Args: instance_name: The name of the Xano instance (e.g....
Update an existing record in a table. Args: instance_name: The name of the Xano instance (e.g., "xnwv-v1z6-dvnr") workspace_id: The ID of the workspace (can be provided as string or number) table_id: The ID of the table (can be provided as string or number) record_id: The ID of the record to update (can be provided as string or number) record_data: The updated data for the record Returns: A dictionary containing the updated record data Example: ``` # Update a user's status result = await xano_update_table_record( "xnwv-v1z6-dvnr", 5, 10, 100, record_data={ "status": "inactive", "last_updated": "2023-08-15T14:30:00Z" } ) ```
Delete a specific record from a table. Args: instance_name: The name of the Xano instance (e.g., "xnwv-v1z6-dvnr") workspace_id: The ID of the workspace (can be provided as string or number) table_id: The ID of the table (can be provided as string or number) record_id: The ID of the record to delete (can be provided as string or number) Returns: A dictionary containing the result of the delete operation Example: ``` # Both formats work: result = await xano_delete_table_record("xnwv-v1z6-dvnr", 5, 10, 100) result = await xano_delete_table_record("xnwv-v1z6-dvnr", "5", "10", "100") ```
Create multiple records in a table in a single operation. Args: instance_name: The name of the Xano instance (e.g....
Update multiple records in a table in a single operation. Args: instance_name: The name of the Xano instance (e.g., "xnwv-v1z6-dvnr") workspace_id: The ID of the workspace (can be provided as string or number) table_id: The ID of the table (can be provided as string or number) updates: List of update operations, each containing row_id and updates Returns: A dictionary containing information about the batch update operation Example: ``` # Update multiple user records result = await xano_bulk_update_records( "xnwv-v1z6-dvnr", 5, 10, updates=[ { "row_id": 100, "updates": { "status": "active", "last_login": "2023-08-15T10:30:00Z" } }, { "row_id": 101, "updates": { "status": "inactive", "last_login": "2023-08-10T14:45:00Z" } } ] ) ```
Delete multiple records from a table in a single operation. Args: instance_name: The name of the Xano instance (e.g., "xnwv-v1z6-dvnr") workspace_id: The ID of the workspace (can be provided as string or number) table_id: The ID of the table (can be provided as string or number) record_ids: List of record IDs to delete (can be provided as strings or numbers) Returns: A dictionary containing information about the batch deletion operation Example: ``` # Delete multiple records result = await xano_bulk_delete_records( "xnwv-v1z6-dvnr", 5, 10, record_ids=[100, 101, 102] ) # Also works with string IDs result = await xano_bulk_delete_records( "xnwv-v1z6-dvnr", "5", "10", record_ids=["100", "101", "102"] ) ```
Truncate a table, optionally resetting the primary key. Args: instance_name: The name of the Xano instance (e.g., "xnwv-v1z6-dvnr") workspace_id: The ID of the workspace (can be provided as string or number) table_id: The ID of the table (can be provided as string or number) reset: Whether to reset the primary key counter Returns: A dictionary containing the result of the truncate operation Example: ``` # Truncate a table but keep the ID counter result = await xano_truncate_table("xnwv-v1z6-dvnr", 5, 10) # Truncate a table and reset the ID counter to 1 result = await xano_truncate_table("xnwv-v1z6-dvnr", "5", "10", reset=True) ```
List files within a workspace. Args: instance_name: The name of the Xano instance (e.g., "xnwv-v1z6-dvnr") workspace_id: The ID of the workspace (can be provided as string or number) page: Page number (default: 1) per_page: Number of files per page (default: 50) search: Search term for filtering files access: Filter by access level ("public" or "private") sort: Field to sort by ("created_at", "name", "size", "mime") order: Sort order ("asc" or "desc") Returns: A dictionary containing a list of files and pagination information Example: ``` # List all files in a workspace result = await xano_list_files("xnwv-v1z6-dvnr", 5) # List files with filtering and sorting result = await xano_list_files( "xnwv-v1z6-dvnr", "5", search="report", access="public", sort="created_at", order="desc", page=2, per_page=25 ) ```
Get details for a specific file. Args: instance_name: The name of the Xano instance (e.g., "xnwv-v1z6-dvnr") workspace_id: The ID of the workspace (can be provided as string or number) file_id: The ID of the file (can be provided as string or number) Returns: A dictionary containing details about the specified file Example: ``` # Both formats work: result = await xano_get_file_details("xnwv-v1z6-dvnr", 5, 10) result = await xano_get_file_details("xnwv-v1z6-dvnr", "5", "10") ```
Delete a file from a workspace. Args: instance_name: The name of the Xano instance (e.g., "xnwv-v1z6-dvnr") workspace_id: The ID of the workspace (can be provided as string or number) file_id: The ID of the file to delete (can be provided as string or number) Returns: A dictionary containing the result of the delete operation Example: ``` # Both formats work: result = await xano_delete_file("xnwv-v1z6-dvnr", 5, 10) result = await xano_delete_file("xnwv-v1z6-dvnr", "5", "10") ```
Delete multiple files from a workspace in a single operation. Args: instance_name: The name of the Xano instance (e.g., "xnwv-v1z6-dvnr") workspace_id: The ID of the workspace (can be provided as string or number) file_ids: List of file IDs to delete (can be provided as strings or numbers) Returns: A dictionary containing the result of the bulk delete operation Example: ``` # Delete multiple files at once result = await xano_bulk_delete_files( "xnwv-v1z6-dvnr", 5, file_ids=[10, 11, 12] ) # Also works with string IDs result = await xano_bulk_delete_files( "xnwv-v1z6-dvnr", "5", file_ids=["10", "11", "12"] ) ```
Browse request history for a workspace. Args: instance_name: The name of the Xano instance (e.g., "xnwv-v1z6-dvnr") workspace_id: The ID of the workspace (can be provided as string or number) page: Page number (default: 1) per_page: Number of results per page (default: 50) branch: Filter by branch api_id: Filter by API ID (can be provided as string or number) query_id: Filter by query ID (can be provided as string or number) include_output: Whether to include response output Returns: A dictionary containing request history entries and pagination information Example: ``` # Get recent request history result = await xano_browse_request_history("xnwv-v1z6-dvnr", 5) # Get filtered request history with response output result = await xano_browse_request_history( "xnwv-v1z6-dvnr", "5", branch="main", api_id=10, include_output=True, page=2, per_page=25 ) ```
Export a workspace to a file. Args: instance_name: The name of the Xano instance (e.g., "xnwv-v1z6-dvnr") workspace_id: The ID of the workspace to export (can be provided as string or number) branch: Branch to export (defaults to live branch if not specified) password: Password to encrypt the export (optional) Returns: A dictionary containing export information, including a download URL Example: ``` # Export the live branch result = await xano_export_workspace("xnwv-v1z6-dvnr", 5) # Export a specific branch with password protection result = await xano_export_workspace( "xnwv-v1z6-dvnr", "5", branch="development", password="secure_password" ) ```
Export only the schema of a workspace to a file. Args: instance_name: The name of the Xano instance (e.g., "xnwv-v1z6-dvnr") workspace_id: The ID of the workspace (can be provided as string or number) branch: Branch to export (defaults to live branch if not specified) password: Password to encrypt the export (optional) Returns: A dictionary containing export information, including a download URL Example: ``` # Export only the schema of the live branch result = await xano_export_workspace_schema("xnwv-v1z6-dvnr", 5) # Export the schema of a specific branch with password protection result = await xano_export_workspace_schema( "xnwv-v1z6-dvnr", "5", branch="development", password="secure_password" ) ```
Browse API groups in a workspace. Args: instance_name: The name of the Xano instance (e.g., "xnwv-v1z6-dvnr") workspace_id: The ID of the workspace (can be provided as string or number) branch: Filter by branch name page: Page number (default: 1) per_page: Number of results per page (default: 50) search: Search term for filtering API groups sort: Field to sort by ("created_at", "updated_at", "name") order: Sort order ("asc" or "desc") Returns: A dictionary containing a list of API groups and pagination information Example: ``` # List all API groups in a workspace result = await xano_browse_api_groups("xnwv-v1z6-dvnr", 5) # Search for API groups with pagination and sorting result = await xano_browse_api_groups( "xnwv-v1z6-dvnr", "5", search="auth", sort="name", order="asc", page=2, per_page=25 ) ```
Get details for a specific API group. Args: instance_name: The name of the Xano instance (e.g., "xnwv-v1z6-dvnr") workspace_id: The ID of the workspace (can be provided as string or number) apigroup_id: The ID of the API group (can be provided as string or number) Returns: A dictionary containing details about the specified API group Example: ``` # Both formats work: result = await xano_get_api_group("xnwv-v1z6-dvnr", 5, 10) result = await xano_get_api_group("xnwv-v1z6-dvnr", "5", "10") ```
Create a new API group in a workspace. Args: instance_name: The name of the Xano instance (e.g., "xnwv-v1z6-dvnr") workspace_id: The ID of the workspace (can be provided as string or number) name: The name of the new API group description: API group description docs: Documentation text branch: Branch to create the API group in (defaults to current branch) swagger: Whether to enable Swagger documentation tag: List of tags for the API group Returns: A dictionary containing details about the newly created API group Example: ``` # Create a simple API group result = await xano_create_api_group( "xnwv-v1z6-dvnr", 5, name="Authentication APIs" ) # Create an API group with additional details result = await xano_create_api_group( "xnwv-v1z6-dvnr", "5", name="User Management", description="APIs for user management operations", docs="Use these endpoints to create, update, and delete users", branch="development", tag=["auth", "users"] ) ```
Update an existing API group in a workspace. Args: instance_name: The name of the Xano instance (e.g., "xnwv-v1z6-dvnr") workspace_id: The ID of the workspace (can be provided as string or number) apigroup_id: The ID of the API group to update (can be provided as string or number) name: The new name of the API group description: New API group description docs: New documentation text swagger: Whether to enable Swagger documentation tag: New list of tags for the API group Returns: A dictionary containing details about the updated API group Example: ``` # Update the name of an API group result = await xano_update_api_group( "xnwv-v1z6-dvnr", 5, 10, name="Updated API Group Name" ) # Update multiple properties result = await xano_update_api_group( "xnwv-v1z6-dvnr", "5", "10", description="Updated description", docs="New documentation", tag=["updated", "api"] ) ```
Delete an API group from a workspace. Args: instance_name: The name of the Xano instance (e.g., "xnwv-v1z6-dvnr") workspace_id: The ID of the workspace (can be provided as string or number) apigroup_id: The ID of the API group to delete (can be provided as string or number) Returns: A dictionary containing the result of the delete operation Example: ``` # Both formats work: result = await xano_delete_api_group("xnwv-v1z6-dvnr", 5, 10) result = await xano_delete_api_group("xnwv-v1z6-dvnr", "5", "10") ```
Update the security settings for an API group. Args: instance_name: The name of the Xano instance (e.g....
Browse APIs within a specific API group. Args: instance_name: The name of the Xano instance (e.g., "xnwv-v1z6-dvnr") workspace_id: The ID of the workspace (can be provided as string or number) apigroup_id: The ID of the API group (can be provided as string or number) page: Page number (default: 1) per_page: Number of APIs per page (default: 50) search: Search term for filtering APIs sort: Field to sort by ("created_at", "updated_at", "name") order: Sort order ("asc" or "desc") Returns: A dictionary containing a list of APIs and pagination information Example: ``` # List all APIs in a group result = await xano_browse_apis_in_group("xnwv-v1z6-dvnr", 5, 10) # Search for APIs with sorting result = await xano_browse_apis_in_group( "xnwv-v1z6-dvnr", "5", "10", search="user", sort="name", order="asc", page=2, per_page=25 ) ```
Get details for a specific API. Args: instance_name: The name of the Xano instance (e.g., "xnwv-v1z6-dvnr") workspace_id: The ID of the workspace (can be provided as string or number) apigroup_id: The ID of the API group (can be provided as string or number) api_id: The ID of the API (can be provided as string or number) Returns: A dictionary containing details about the specified API Example: ``` # All of these formats work: result = await xano_get_api("xnwv-v1z6-dvnr", 5, 10, 15) result = await xano_get_api("xnwv-v1z6-dvnr", "5", "10", "15") ```
Create a new API within an API group. Args: instance_name: The name of the Xano instance (e.g., "xnwv-v1z6-dvnr") workspace_id: The ID of the workspace (can be provided as string or number) apigroup_id: The ID of the API group (can be provided as string or number) name: The name of the new API description: API description docs: Documentation text verb: HTTP method (GET, POST, PUT, DELETE, PATCH, HEAD) tag: List of tags for the API Returns: A dictionary containing details about the newly created API Example: ``` # Create a GET API result = await xano_create_api( "xnwv-v1z6-dvnr", 5, 10, name="Get User Profile", verb="GET" ) # Create a POST API with more details result = await xano_create_api( "xnwv-v1z6-dvnr", "5", "10", name="Create User", description="Creates a new user in the system", docs="Use this endpoint to register new users", verb="POST", tag=["users", "auth"] ) ```
Update an existing API. Args: instance_name: The name of the Xano instance (e.g., "xnwv-v1z6-dvnr") workspace_id: The ID of the workspace (can be provided as string or number) apigroup_id: The ID of the API group (can be provided as string or number) api_id: The ID of the API to update (can be provided as string or number) name: The new name of the API description: New API description docs: New documentation text verb: New HTTP method (GET, POST, PUT, DELETE, PATCH, HEAD) auth: Authentication settings tag: New list of tags for the API cache: Cache settings Returns: A dictionary containing the result of the update operation Example: ``` # Update the name of an API result = await xano_update_api( "xnwv-v1z6-dvnr", 5, 10, 15, name="Updated API Name" ) # Update multiple properties result = await xano_update_api( "xnwv-v1z6-dvnr", "5", "10", "15", description="Updated description", docs="New documentation", verb="PUT", tag=["updated", "api"], cache={"active": True, "ttl": 300} ) ```
Delete an API from an API group. Args: instance_name: The name of the Xano instance (e.g., "xnwv-v1z6-dvnr") workspace_id: The ID of the workspace (can be provided as string or number) apigroup_id: The ID of the API group (can be provided as string or number) api_id: The ID of the API to delete (can be provided as string or number) Returns: A dictionary containing the result of the delete operation Example: ``` # All formats work: result = await xano_delete_api("xnwv-v1z6-dvnr", 5, 10, 15) result = await xano_delete_api("xnwv-v1z6-dvnr", "5", "10", "15") ```
Update the security settings for an API. Args: instance_name: The name of the Xano instance (e.g., "xnwv-v1z6-dvnr") workspace_id: The ID of the workspace (can be provided as string or number) apigroup_id: The ID of the API group (can be provided as string or number) api_id: The ID of the API (can be provided as string or number) guid: The new GUID for the API Returns: A dictionary containing the result of the update operation Example: ``` # Update API security settings result = await xano_update_api_security( "xnwv-v1z6-dvnr", 5, 10, 15, guid="new-api-guid-value" ) ```
The Xano API token used to authenticate with the Xano API.
Access and manage servers by signing in.
