Permanently deletes all records in a Tulip Table. All record-level data will be irrecoverably deleted. After this operation, the table will be empty. Use with caution!
The operation will fail if any record in the table is currently being used by a running Tulip app.
Requires the tables:write
API key scope.
Access to the Tulip API requires the use of HTTP Basic Authentication using the credentials of an active Tulip API Token. All requests require the Authorization
HTTP header with the Basic
scheme to provide API credentials unless otherwise noted.
API tokens can be configured with a set of scopes which determine what parts of the API that specific token has access to. Security best practices dictate that API credentials be given the minimum set of capabilities required to fulfill their intended purpose. For example, an API token created for use in an integration that is only designed to use the Tables API should probably only be given the tables:read
and tables:write
scopes. In this way you can minimize risk in the event that API credentials are compromised. API endpoints will document what API token scopes are required to access that endpoint in their descriptions. If a request is made to an endpoint with an API token which does not have the required scopes, the response will be an authorization error.
The id of a Tulip Table.
If this option is set to true
, the operation will not check for records in the table being used by a running Tulip app. If there are records in use, the apps using them may not work properly.
The Tulip Table was cleared successfully.
The request was malformed. This could mean that headers, query parameters, or the request body was unable to be parsed or had unexpected values.
The request was made unauthorized. HTTP Basic Authorization using a Tulip API Key is required for use of the API.
The provided authentication info was rejected. The response will provide additional details.
The requested database entry was not found.
The request was syntactically sound, but could not be processed due to a logical problem.
The server encountered an unexpected error.