Sign Up

Create File Endpoints

Overview

Twidget allows you to create file endpoints, which enable you to manage files in your file store. This feature is designed to streamline your workflow by providing predefined endpoints for common file operations.

Creating File Endpoints

To create a file endpoint in Twidget, follow these steps:

  1. Navigate to the API Page:

    • Go to the API page in your Twidget dashboard.
  2. Click 'Create Endpoint':

    • In the top right corner, click the 'Create Endpoint' button.
  1. Select 'Manage Files':

    • In the newly opened sidebar, select 'Manage Files'.
  1. Choose an Endpoint:

    • You'll be presented with a selection of seven endpoints to choose from. Each endpoint is designed for a specific file operation, as detailed below.

Available File Endpoints

Here are the endpoints you can generate along with their details:

  1. Upload a Single File to the File Store

    • Method: POST

    • Name: Upload a single file to the file store

    • Path: /single

-

  1. Upload Multiple Files to the File Store

    • Method: POST

    • Name: Upload multiple files to the file store

    • Path: /multiple

    • Note: This endpoint is disabled for users on the 'FREE' plan.

-

  1. Retrieve a Single File

    • Method: POST

    • Name: Retrieve a single file

    • Path: /file

-

  1. Retrieve List of Files

    • Method: POST

    • Name: Retrieve list of files

    • Path: /folder

  2. Retrieve Content of a File

    • Method: POST

    • Name: Retrieve content of a file

    • Path: /content

  3. Rename a File in the File Store

    • Method: PUT

    • Name: Rename a file in the file store

    • Path: /rename

-

  1. Delete Files from the File Store

    • Method: DELETE

    • Name: Delete files from the file store

-

  1. Update File Permissions

    • Method: PUT

    • Name: Update File Permissions

    • Path: /permissions

-

Customizing Endpoints

Each of these endpoints can be customized to fit your specific requirements. This flexibility allows you to tailor the endpoint commands to meet the unique needs of your application, saving you significant time and effort.

Related Topics

Custom Endpoints

In addition to generating CRUD (Create, Read, Update, Delete), authentication, and file management endpoints, Twidget allows you to create completely custom endpoints from scratch. These custom endpoints give you full control over the various aspects of endpoint configuration, including the inputs, ...

Generate CRUD Endpoints

What are CRUD Endpoints?. CRUD stands for Create, Read, Update, Delete. These are the basic operations required to manage data in a database. Each operation corresponds to a specific HTTP method: - Create: Adds new data (HTTP POST) - Read: Retrieves data (HTTP GET) - Update: Modifies existing data (...

Authentication

Twidget supports Bearer Authentication to ensure secure access to your endpoints. You can specify which endpoints should be secured or open. Once secured, an endpoint can only be accessed using a valid Bearer Token, which is generated via our API. Additionally, we provide functionality to generate a...

API Settings

The API settings in Twidget enable you to customize your APIs to fit your requirements. Here’s how you can do it: Configure. 1. Navigate to the API page. 2. Click on the Settings button located at the top-right corner. This will open a sidebar where you can configure various settings for your API. A...

What is an API

An API (Application Programming Interface) is a set of rules and protocols that allows different software applications to communicate and interact with each other. It defines the methods and data formats that applications can use to request and exchange information, services, or functionalities from...