v1.0.0
OAS 2.0
MASV Agent API
MASV
The MASV Agent Management API (MAPI) controls and manages a local MASV Agent instance. Use it to automate uploads, downloads, and transfer management.
Client Libraries
System
Health checks, version info, and service management
System Operations
Get system info
The 'about' endpoint returns the system information. The response includes version, build information etc.
Responses
- application/json
- application/json
Request Example for get/about
curl http://localhost:8080/api/v1/about \
--header 'X-API-Key: YOUR_SECRET_TOKEN'
{
"version": "string",
"build_stamp": "string",
"masv_host": "string",
"backend": {
"hash": "string",
"build_number": "string",
"build_time": "string"
}
}Check version
Returns the current version info and the latest version info.
Responses
- application/json
- application/json
Request Example for get/version_check
curl http://localhost:8080/api/v1/version_check \
--header 'X-API-Key: YOUR_SECRET_TOKEN'
{
"current_version": {
"version": "string",
"build_stamp": "string",
"masv_host": "string"
},
"latest_version": {}
}Health check
Responses
- application/json
Request Example for get/health
curl http://localhost:8080/api/v1/health \
--header 'X-API-Key: YOUR_SECRET_TOKEN'
{
"code": 1
}Get validation rules
Responses
- application/json
- application/json
Request Example for get/validation
curl http://localhost:8080/api/v1/validation \
--header 'X-API-Key: YOUR_SECRET_TOKEN'
{
"version": "string",
"rules": {
"user.password": {
"additionalProperty": 1
}
}
}Shutdown service
Responses
- application/json
- application/json
Request Example for post/shutdown
curl http://localhost:8080/api/v1/shutdown \
--request POST \
--header 'X-API-Key: YOUR_SECRET_TOKEN'
{
"code": 1
}Authentication (Collapsed)
Login, logout, signup, and session management
Teams (Collapsed)
Team membership, credits, subscriptions, and limits
Uploads (Collapsed)
Create, manage, pause, resume, and finalize uploads
Uploads Operations
- get/uploads
- post/uploads
- delete/uploads
- post/uploads/token
- get/uploads/{upload_id}
- post/uploads/{upload_id}
- delete/uploads/{upload_id}
- post/uploads/pause
- post/uploads/resume
- post/uploads/{upload_id}/pause
- post/uploads/{upload_id}/resume
- post/uploads/{upload_id}/priority
- post/uploads/{upload_id}/fifo_rank
- post/uploads/{upload_id}/finalize
- post/uploads/preview
- get/uploads/{upload_id}/items/{item_id}
- get/link
- post/uploads/{upload_id}/link
- post/portals/uploads
- post/portals/uploads/preview
Downloads (Collapsed)
Create, manage, pause, and resume downloads
Downloads Operations
- get/downloads
- post/downloads
- delete/downloads
- get/downloads/{download_id}
- delete/downloads/{download_id}
- post/downloads/{download_id}/pause
- post/downloads/resume
- post/downloads/pause
- post/downloads/{download_id}/resume
- post/downloads/{download_id}/priority
- post/downloads/{download_id}/fifo_rank
- get/downloads/{download_id}/items/{item_id}
Transfers (Collapsed)
Query and manage all transfers (uploads and downloads)
Transfers Operations
Packages (Collapsed)
Retrieve package information for downloads
Packages Operations
Portals (Collapsed)
Browse and query Portal information
Portals Operations
Automations (Collapsed)
Create and manage automated transfer workflows
Automations Operations
- get/automations
- post/automations/import
- post/automations/portal_download
- get/automations/portal_download/{automation_id}
- put/automations/portal_download/{automation_id}
- delete/automations/portal_download/{automation_id}
- get/automations/portal_download/{automation_id}/export
- post/automations/all_portals_download
- get/automations/all_portals_download/{automation_id}
- put/automations/all_portals_download/{automation_id}
- delete/automations/all_portals_download/{automation_id}
- get/automations/all_portals_download/{automation_id}/export
- post/automations/portal_upload
- get/automations/portal_upload/{automation_id}
- put/automations/portal_upload/{automation_id}
- delete/automations/portal_upload/{automation_id}
- get/automations/portal_upload/{automation_id}/export
- post/automations/team_upload
- get/automations/team_upload/{automation_id}
- put/automations/team_upload/{automation_id}
- delete/automations/team_upload/{automation_id}
- get/automations/team_upload/{automation_id}/export
- post/automations/portal_stream
- get/automations/portal_stream/{automation_id}
- put/automations/portal_stream/{automation_id}
- delete/automations/portal_stream/{automation_id}
- get/automations/portal_stream/{automation_id}/export
- post/automations/team_stream
- get/automations/team_stream/{automation_id}
- put/automations/team_stream/{automation_id}
- delete/automations/team_stream/{automation_id}
- get/automations/team_stream/{automation_id}/export
Settings (Collapsed)
Rate limits, network interfaces, disk management, and filters
Settings Operations
- get/settings/download_rate_limits
- post/settings/download_rate_limits
- get/settings/download_rate_limit
- post/settings/download_rate_limit
- get/settings/download_rate_limit/{iface_id}
- post/settings/download_rate_limit/{iface_id}
- get/settings/upload_rate_limits
- post/settings/upload_rate_limits
- get/settings/upload_rate_limit
- post/settings/upload_rate_limit
- get/settings/upload_rate_limit/{iface_id}
- post/settings/upload_rate_limit/{iface_id}
- get/settings/worker_config
- post/settings/worker_config
- get/settings/multiconnect
- post/settings/multiconnect
- get/settings/multiconnect/status
- post/settings/multiconnect/ifaces/{id}
- get/settings/disk_config
- post/settings/disk_config
- delete/settings/disk_config/{disk_id}
- get/settings/disk_config_default
- post/settings/disk_config_default
- get/settings/disk_status
- post/settings/disk_status/scan
- get/settings/download_filters
- post/settings/download_filters
- get/settings/fifo_mode
- post/settings/fifo_mode
Storage Gateway (Collapsed)
Register and manage Storage Gateway connections
Storage Gateway Operations
Contacts (Collapsed)
User contact list
Contacts Operations
Webhooks (Collapsed)
Register and manage webhook endpoints for event notifications
Diagnostics (Collapsed)
Disk speed tests and system diagnostics
Diagnostics Operations