What this API does
The NocoDB API is an open-source solution that transforms existing SQL databases into fully operational REST and GraphQL APIs. It supports various SQL engines, including MySQL, PostgreSQL, SQLite, and SQL Server, enabling developers to perform CRUD operations efficiently. By leveraging this API, developers can create robust data-driven applications and automation workflows with minimal setup.
How it works
Developers can use the NocoDB API to create REST and GraphQL endpoints that interact with their SQL databases. The API enables features like filtering, pagination, and webhook notifications, enhancing the flexibility and control over how data is accessed and manipulated. Integration with frontend frameworks and automation tools is straightforward due to its support for JSON data formatting.
Authentication
The NocoDB API supports role-based authentication using API tokens or JWT. This allows developers to implement fine-grained access control, ensuring that data is secure and that only authorized users have access to sensitive information.
Example usage
/api/v1/projects- Retrieves a list of available database projects./api/v1/projects/{project_id}/tables- Lists tables within a specific project./api/v1/projects/{project_id}/tables/{table_id}/records- Fetches records from a specified table./api/v1/projects/{project_id}/tables/{table_id}/create- Creates a new record in the specified table./api/v1/webhooks- Configures webhook notifications for database events.
Limits
Current rate limits and usage policies for the NocoDB API are not explicitly documented. Developers are encouraged to test performance based on their specific use cases.
Ideal use cases
- Building data-driven dashboards and applications.
- Creating automation workflows linked to SQL databases.
- Integrating existing SQL databases into modern web applications.
- Providing REST and GraphQL interfaces for legacy database systems.