Skip to main content

Developer Experience (DX)

Filess is built by developers, for developers. We believe infrastructure should be programmable.

REST API

Our complete REST API allows you to manage your shared and dedicated databases programmatically.

  • Authentication: Bearer Token (JWT)

Shared Database API

Manage your shared database instances.

  • Base URL: https://api.filess.io/v1
  • Capabilities:
    • List Regions: GET /v1/regions - Retrieve a list of all available regions.
    • Create Instance: POST /v1/instances - Create a new database instance (MySQL, PostgreSQL, MongoDB, etc.).
    • Delete Instance: DELETE /v1/instances/{id} - Permanently delete a database instance.
# Example: Create a new shared instance
curl -X POST "https://api.filess.io/v1/instances" \
-H "Authorization: Bearer <your-token>" \
-H "Content-Type: application/json" \
-d '{
"identifier": "mydatabase",
"region": "4747ed15-34b7-4f41-a80b-387a6a907a1e",
"motor": "mysql-8.0.29"
}'

Dedicated Database API

Manage your dedicated database resources.

  • Base URL: https://backend.filess.io/v1
  • Capabilities:
    • List Engines: GET /v1/engines - Retrieve available dedicated database engines.
    • List Regions: GET /v1/regions - Retrieve available regions for dedicated databases.
    • List Databases: GET /v1/databases - List all your dedicated databases.
    • Get Database: GET /v1/databases/{id} - Get details of a specific database.
    • Create Database: POST /v1/databases - Provision a new dedicated database.
    • Delete Database: DELETE /v1/databases/{id} - Delete a dedicated database.
    • Get Metadata: GET /v1/databases/create/metadata - Get metadata needed for creation (plans, billable items).
# Example: List dedicated databases
curl -X GET "https://backend.filess.io/v1/databases" \
-H "Authorization: Bearer <your-token>" \
-H "Content-Type: application/json"
API Documentation

Full API reference documentation is hosted inside the panel