Uptimeify Docs
MonitorsFtp monitors

Get FTP Monitor

Returns details of a specific FTP monitor.

GET /api/ftp-monitors/:ftpMonitorPublicId

The response contains the FTP monitor itself and does not embed the full customer record.

Authentication

Authorization: Bearer <token>

Parameters

  • ftpMonitorPublicId (Path, required): FTP monitor public UUID.

Example (cURL)

BASE_URL="https://uptimeify.io"
TOKEN="<your-api-token>"

curl -X GET \
  "$BASE_URL/api/ftp-monitors/55555555-5555-4555-8555-555555555555" \
  -H "Authorization: Bearer $TOKEN"

Response

{
  "id": 400,
  "organizationId": 1,
  "customerId": 10,
  "name": "Partner FTP",
  "hostname": "ftp.example.com",
  "port": 21,
  "status": "active",
  "checkInterval": 30,
  "timeoutSeconds": 30,
  "allowedCheckCountryCodes": null,
  "notificationPhoneNumber": null,
  "notificationEmail": null,
  "lastCheckedAt": null,
  "createdAt": "2026-02-25T10:00:00.000Z",
  "updatedAt": "2026-02-25T10:00:00.000Z",
  "config": {
    "user": "monitor",
    "password": "<ftp-password>",
    "secure": false
  },
  "ftpConfig": {
    "user": "monitor",
    "password": "<ftp-password>",
    "secure": false
  }
}

Common Errors

  • 400 FTP monitor public ID (UUID) required if ftpMonitorPublicId is missing or invalid
  • 401 Unauthorized if you are not authenticated
  • 403 Forbidden if you do not have access
  • 404 FTP monitor not found if the monitor does not exist

On this page