Linux File & Folder Monitoring APIs

GainAPIs for real-time visibility and control over your Linux filesystem with our powerful monitoring APIs. Track file/folder creation, modification,monitoring and deletion events instantly, and retrieve comprehensive permission details—including owner, group, ACL-like access information, and exact read/write/execute rights.checks.

These APIs are perfect for audit logging, security monitoring, compliance tracking, automated backups, or building custom file-watching workflows.

Authentication

All endpoints require a valid Bearer token obtained from the /token endpoint.

Headers (required for all requests):

Authorization: Bearer {{token}}
Content-Type: application/json

Base URL

Replace {{base_url}} with your actual API base URL (provided upon account setup).

---

1. File Action Monitoring API

Capture real-time file and folder events (Create, Modify, Delete)

Endpoint: POST {{base_url}}/base/fileAction

Query Parameters:

Example Request:

POST {{base_url}}/base/fileAction?path=/home/hiteshkumar/Documents/reports
Authorization: Bearer {{token}}

Success Response (200 OK):

[
  {
    "time": "2025-11-24T18:04:31.933000",
    "action": "CREATE",
    "path": "/home/hiteshkumar/Documents/reports/budget.xlsx",
    "user": "hiteshkumar"
  },
  {
    "time": "2025-11-24T18:15:22.104000",
    "action": "MODIFY",
    "path": "/home/hiteshkumar/Documents/reports/budget.xlsx",
    "user": "hiteshkumar"
  },
  {
    "time": "2025-11-24T19:02:11.567000",
    "action": "DELETE",
    "path": "/home/hiteshkumar/Desktop/old_backup.zip",
    "user": "hiteshkumar"
  }
]

Possible Action Values:

• CREATE → New file or directory created
• MODIFY → File content or metadata changed
• DELETE → File or directory removed

Error Response (404 Not Found):

{
  "detail": "No events found"
}

Use Case: Ideal for building audit trails, triggering backups on file changes, or alerting on unauthorized deletions.

---

2. File & Folder PermissionsPermission API

Retrieve complete permission and ownership details

Endpoint: POST {{base_url}}/base/filePermissions

Query Parameters:

Example Request:

POST {{base_url}}/base/filePermissions?path=/home/hiteshkumar/shared/project_data
Authorization: Bearer {{token}}

Success Response (200 OK):

{
  "path": "/home/hiteshkumar/shared/project_data",
  "type": "directory",
  "owner": "hiteshkumar",
  "group": "developers",
  "permissions": {
    "owner": {
      "read": true,
      "write": true,
      "execute": true
    },
    "group": {
      "read": true,
      "write": true,
      "execute": false
    },
    "others": {
      "read": true,
      "write": false,
      "execute": false
    }
  },
  "users_with_access": [
    "hiteshkumar",
    "alice",
    "bob"
  ],
  "groups_with_access": {
    "developers": [
      "alice",
      "bob",
      "hiteshkumar"
    ]
  },
  "everyone_can_access": false
}

Response Fields Explanation:

Error Response (404 Not Found):

{
  "detail": "Path does not exist."
}

Use Case: Perfect for compliance checks, security audits, access reviews, or automatically enforcing permission policies.