List existing Airboxes

GET {{protocol}}://{{api-server}}/{{token}}/v4/airboxes?type=airbox

The API endpoint retrieves the list of airboxes existing in the scope of the Filerobot token. The response is in JSON format and includes an array of airboxes, along with additional information about the request and API version.

{
  "status": "",
  "airboxes": [
    {
      "uuid": "",
      "title": "",
      "type": "",
      "description": "",
      "token": "",
      "starts_at": "",
      "expires_at": "",
      "starts_tz": "",
      "expires_tz": "",
      "auth": [
        {
          "pass": ""
        }
      ],
      "target_folder": "",
      "airbox_limits": {
        "max_file_size_mb": 0,
        "max_total_files_count": 0,
        "max_total_files_size_mb": 0
      },
      "airbox_configurations": {
        "notifications": {
          "recipients": {
            "owner": true
          },
          "schedule": {
            "daily": true
          }
        }
      },
      "airbox_data": {},
      "airbox_uri": ""
    }
  ],
  "info": {
    "duration": 0,
    "api_version": 0
  },
  "api_version": {
    "hash": "",
    "datetime": "",
    "module": ""
  }
}

Request Params

HEADERS

RESPONSES

status: OK

{"status":"success","airboxes":[{"uuid":"db06cd6a-3b02-44cd-baf7-b835761853dc","title":"Test","type":"airbox","description":"Airbox Description","token":"token","starts_at":"2024-08-15T09:00:00Z","expires_at":"2024-08-21T09:00:00Z","starts_tz":"Europe/London","expires_tz":"Europe/London","auth":[{"pass":"test-password"}],"target_folder":"/Demo","airbox_limits":{"max_file_size_mb":50,"max_total_files_count":100,"max_total_files_size_mb":5120},"airbox_configurations":{"notifications":{"recipients":{"owner":true},"schedule":{"daily":true}}},"airbox_data":{},"airbox_uri":"https://airbox.filerobot.com/token/v4/a/u2I78YxrjRRddlv/test"},{"uuid":"a10bba40-8f71-4d48-b20e-96984963030a","title":"ABC","type":"airbox","description":"Airbox Description","token":"token","starts_at":"2024-08-15T09:00:00Z","expires_at":"2024-08-21T09:00:00Z","starts_tz":"Europe/London","expires_tz":"Europe/London","auth":[{"pass":"test-password"}],"target_folder":"/","airbox_limits":{"max_file_size_mb":50,"max_total_files_count":100,"max_total_files_size_mb":5120},"airbox_configurations":{},"airbox_data":{},"airbox_uri":"https://airbox.filerobot.com/token/v4/a/u6E9pxCJFtyuEsoaS/abc"},{"uuid":"69a5fbef-171c-4e35-bebe-159a6887879c","title":"ABC-1","type":"airbox","description":"Airbox Description","token":"token","starts_at":"2024-08-15T09:00:00Z","expires_at":"2024-08-21T09:00:00Z","starts_tz":"Europe/London","expires_tz":"Europe/London","auth":[{"pass":"test-password"}],"target_folder":"/","airbox_limits":{"max_file_size_mb":50,"max_total_files_count":100,"max_total_files_size_mb":5120},"airbox_configurations":{},"airbox_data":{},"airbox_uri":"https://airbox.filerobot.com/token/v4/a/ulnjC3Y2yRxk515d0q/abc-1"}],"info":{"duration":0.0901021957397461,"api_version":4},"api_version":{"hash":"1ce24f12ff9f3205395f34065a5b87bbfa619e25","datetime":"2024-08-13T12:13:54+07:00","module":"elastic_v2"}}