XanoOverview
The Instance endpoints allow you to browse, inspect, and retrieve metadata for your Xano instances.All endpoints use Bearer access tokens for authentication. Base URL: Your base URL is the URL of your Xano instance.
API Endpoints
Authentication
Retrieve information about the authenticated user including ID, name, and email address
Returns the authenticated user’s basic account information
Retrieve all accessible workspaces for the authenticated user
Returns all workspaces accessible to the authenticated user
Workspace Management
Retrieve detailed information about a specific workspace
Returns detailed information about a specific workspace
Retrieve all branches in a workspace
Returns all branches in a workspace
Delete a workspace branch cannot delete the default branch or currently live branch
Deletes a workspace branch (cannot delete default or live branch)
Retrieve all external data sources for a workspace
Returns all external data sources for a workspace
Create a new external data source with custom label and color
Creates a new external data source with custom label and color
Update an existing data sources label and color properties
Updates an existing data source’s label and color properties
Delete a data source permanently this action cannot be undone
Deletes a data source permanently (cannot be undone)
Export complete workspace data and configuration as an archive
Exports complete workspace data and configuration as an archive
Export database table schemas and branch configuration as a file
Exports database table schemas and branch configuration as a file
Import database schema into a new branch with optional deployment
Imports database schema into a new branch with optional deployment
Replace workspace content and configuration with imported archive
Replaces workspace content and configuration with imported archive
Upload files to workspace
Uploads files to workspace
Retrieve workspace files with optional search filtering and pagination
Returns workspace files with optional search filtering and pagination
Delete a file permanently this action cannot be undone
Deletes a file permanently (cannot be undone)
Delete multiple files permanently this action cannot be undone
Deletes multiple files permanently (cannot be undone)
Update workspace tables autocomplete
Updates workspace tables autocomplete
Update workspace table
Updates workspace table
API Groups & Endpoints
Create a new API group in a workspace include name description and optional tags
Creates a new API group in a workspace with name, description and optional tags
Retrieve a list of API groups inside of a workspace use the optional filtering and sorting parameters for more granular returns
Returns a list of API groups in a workspace with optional filtering and sorting
Get detailed information for a specific API group returns complete metadata and configuration
Returns detailed information for a specific API group
Update an existing API group modify name description documentation settings or tags
Updates an existing API group settings
Delete an API group and all its endpoints this action cannot be undone
Deletes an API group and all its endpoints (cannot be undone)
Get the OpenAPI specification for an API group returns the complete Swagger JSON for all endpoints
Returns the complete OpenAPI specification for an API group
Update security settings for an API group configure access permissions and authentication requirements
Updates security settings for an API group
Create a new API endpoint
Creates a new API endpoint
Retrieve all API endpoints in a group with optional filtering and pagination
Returns all API endpoints in a group with optional filtering and pagination
Retrieve a specific API endpoint by ID
Returns a specific API endpoint by ID
Update API endpoint code settings and authentication rules
Updates API endpoint code settings and authentication rules
Update API endpoint security configuration and access controls
Updates API endpoint security configuration and access controls
Generate OpenAPI specification for a specific API endpoint
Generates OpenAPI specification for a specific API endpoint
Delete an API endpoint permanently this action cannot be undone
Deletes an API endpoint permanently (cannot be undone)
Configure table security rules by assigning an API group GUID or removing restrictions
Configures table security rules by assigning an API group GUID
Functions
Create a new function
Creates a new function
Retrieve all functions in a workspace with optional filtering and pagination
Returns all functions in a workspace with optional filtering and pagination
Retrieve a specific function by ID
Returns a specific function by ID
Update function code metadata and caching settings
Updates function code metadata and caching settings
Update function security configuration and access controls
Updates function security configuration and access controls
Delete a function permanently this action cannot be undone
Deletes a function permanently (cannot be undone)
Retrieve API function request history with optional filtering and pagination
Returns API function request history with optional filtering and pagination
Search function request history using advanced filters and custom sorting options
Searches function request history using advanced filters and custom sorting
Tables & Schema
Create a new database table with optional schema definition
Creates a new database table with optional schema definition
Retrieve all tables in a workspace with optional filtering and pagination
Returns all tables in a workspace with optional filtering and pagination
Retrieve detailed information for a specific table
Returns detailed information for a specific table
Update table properties including name description tags and authentication settings
Updates table properties including name, description, tags and authentication settings
Delete a database table and all its data permanently
Deletes a database table and all its data permanently
Retrieve the complete schema definition for a database table
Returns the complete schema definition for a database table
Replace the entire schema definition for a database table
Replaces the entire schema definition for a database table
Retrieve details for a specific column in a tables schema
Returns details for a specific column in a table’s schema
Rename a column in a tables schema
Renames a column in a table’s schema
Delete a column from a tables schema this action cannot be undone
Deletes a column from a table’s schema (cannot be undone)
Retrieve all indexes for a database table
Returns all indexes for a database table
Replace all indexes for a database table with new index configuration
Replaces all indexes for a database table with new index configuration
Delete a specific table index this action cannot be undone
Deletes a specific table index (cannot be undone)
Delete all records from the table and optionally reset the primary key
Deletes all records from the table and optionally resets the primary key
Table Content
Create a new record in the table
Creates a new record in the table
Create multiple records in a single batch operation
Creates multiple records in a single batch operation
Retrieve paginated records from a table
Returns paginated records from a table
Retrieve a specific record by ID
Returns a specific record by ID
Update a specific record by ID
Updates a specific record by ID
Update multiple records in a single batch operation
Updates multiple records in a single batch operation
Update all records matching specified search criteria
Updates all records matching specified search criteria
Delete a specific record by ID
Deletes a specific record by ID
Delete multiple records by their IDs in a single operation
Deletes multiple records by their IDs in a single operation
Delete all records matching specified search criteria
Deletes all records matching specified search criteria
Search table records with advanced filtering and sorting options
Searches table records with advanced filtering and sorting options
Tasks
Create a new scheduled task
Creates a new scheduled task
Retrieve all scheduled tasks in a workspace with optional filtering and pagination
Returns all scheduled tasks in a workspace with optional filtering and pagination
Retrieve a specific scheduled task by ID
Returns a specific scheduled task by ID
Update task code schedule settings and activation status
Updates task code, schedule settings and activation status
Update scheduled task security configuration and access controls
Updates scheduled task security configuration and access controls
Delete a scheduled task permanently this action cannot be undone
Deletes a scheduled task permanently (cannot be undone)
Retrieve task request history with optional filtering and pagination
Returns task request history with optional filtering and pagination
Search task request history using advanced filters and custom sorting options
Searches task request history using advanced filters and custom sorting
Real-time
Retrieve real-time operational metrics and connection details
Returns real-time operational metrics and connection details
Update real-time settings and connection configuration
Updates real-time settings and connection configuration
Audit & History
Browse audit logs across all workspaces
Returns audit logs across all workspaces
Search audit logs across all workspaces with support for complex filtering and sorting
Searches audit logs across all workspaces with complex filtering and sorting
Retrieve workspace audit logs with pagination support
Returns workspace audit logs with pagination support
Search audit logs using advanced filters and custom sorting options
Searches audit logs using advanced filters and custom sorting
Retrieve API request history with optional filtering and pagination
Returns API request history with optional filtering and pagination
Search API request history using advanced filters and custom sorting options
Searches API request history using advanced filters and custom sorting
Retrieve middleware request history with optional filtering and pagination
Returns middleware request history with optional filtering and pagination
Search middleware request history using advanced filters and custom sorting options
Searches middleware request history using advanced filters and custom sorting
Retrieve tool request history with optional filtering and pagination
Returns tool request history with optional filtering and pagination
Search tool request history using advanced filters and custom sorting options
Searches tool request history using advanced filters and custom sorting
Retrieve trigger request history with optional filtering and pagination
Returns trigger request history with optional filtering and pagination
Search trigger request history using advanced filters and custom sorting options
Searches trigger request history using advanced filters and custom sorting
Common errors
- 400 — Input Error. Check the request payload for issues.
- 401 — Unauthorized.
- 403 — Access denied. Additional privileges are needed.
- 404 — Not Found.
- 429 — Rate Limited.
- 500 — Unexpected error.
Changelog
- v0.0.1 — Initial beta endpoints for listing and retrieving instances.