Intercode SaaS Kit
  • Welcome to SaaS Starter Kit
  • Getting Started
    • Technology stack
    • Database Setup
    • Local Environment Setup
  • Basics
    • Dependencies
    • App architecture
    • Deployment
    • App roles
    • Endpoints List
      • Auth
      • Two Factor Auth
      • Businesses
      • Demo
      • Email
      • Export Document
      • Email Files
      • Files Demo
      • Leads
      • Orders
      • Payments
      • Subscriptions
      • Teams
      • Team Memberships
      • User Admin
  • Animation and Styles
    • Framer Motion
    • Ant Design and Styles
  • Pages
    • Auth
      • Working with PassportJS
      • Two-Factor Auth
      • OAuth Providers
    • Leads
    • Businesses
    • Team management
      • Ownership
    • Profile
    • User Settings
      • App Tour
    • App Settings
      • Lead Statuses
    • Dashboard
      • Lead volume widget
      • Doughnut chart widget
      • Recent leads table widget
      • Lead count over period widget
    • Demo
  • Features
    • Impersonation
    • Subscriptions (Stripe)
    • Search
    • Sentry
    • Captcha
    • Audit Logs
    • Internationalization
  • External integrations
    • Mailer
    • Google oAuth2
    • Facebook oAuth2
    • S3 compatible storage (AWS, MinIO)
Powered by GitBook
On this page
  1. Basics
  2. Endpoints List

Files Demo

PreviousEmail FilesNextLeads

Last updated 6 months ago

GET

POST

DELETE

Retrieves a file by its name from the S3 bucket.

get
Path parameters
fileNamestringRequired
Responses
200
File retrieved successfully
application/json
Responsestring · binary
404
File not found
application/json
500
Internal server error
application/json
get
GET /action-demo-files/{fileName} HTTP/1.1
Host: 
Accept: */*

binary

Deletes a file by its name from the S3 bucket.

delete
Path parameters
fileNamestringRequired
Responses
200
File deleted successfully
application/json
ResponseanyExample: {"message":"File deleted successfully","description":"The file has been deleted successfully."}
404
File not found
application/json
500
Internal server error
application/json
delete
DELETE /action-demo-files/{fileName} HTTP/1.1
Host: 
Accept: */*

{
  "message": "File deleted successfully",
  "description": "The file has been deleted successfully."
}
  • GET
  • GETRetrieves a file by its name from the S3 bucket.
  • POST
  • POSTUploads a file to the S3 bucket.
  • DELETE
  • DELETEDeletes a file by its name from the S3 bucket.

Uploads a file to the S3 bucket.

post
Body
filestring · binaryOptional
Responses
200
File uploaded successfully
application/json
ResponsestringExample: formatted_file_name.jpg
400
Invalid file
application/json
post
POST /action-demo-files HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "file": "binary"
}
formatted_file_name.jpg