Postman Collection

We provide an official Postman collection with all API endpoints pre-configured.

Download

Download Postman Collection

Import

1. Open Postman
2. Click Import (top left)
3. Drag the downloaded JSON file or click Upload Files
4. The FileSafety API collection appears in your sidebar

Configure

After importing, set your API key:

1. Click the FileSafety API collection name
2. Go to the Variables tab
3. Set api_key to your API key (e.g., fs_live_...)
4. Save

All requests inherit the x-api-key header automatically.

Included requests

Folder	Request	Description
Scanning	Scan file (direct upload)	POST /v1/scan with multipart file
Scanning	Scan file (presigned URL)	POST /v1/scan with JSON body — returns upload URL for large files
Scanning	Upload file to presigned URL	PUT file to the presigned URL
Status	Get scan status	GET /v1/scan/{scan_id}
Account	Get usage & quota	GET /v1/usage

Auto-set variables

The collection includes test scripts that automatically save scan_id and upload_url from responses. Run the requests in order — the scan ID flows through to subsequent requests automatically.

Base URL

The collection uses https://api.filesafety.dev as the default base URL. You can change this in the collection Variables tab if needed.