-
Notifications
You must be signed in to change notification settings - Fork 0
Media Directory
Media Directory endpoints for API usage.
All calls are made on the standard api endpoint:
https://api-prod.maxloapi.com
Retrieve the media_id and other data for a specific path in the volume.
The media_id is stable for a priticular path forever. Deleting or modifying
the file does not change it's media_id.
GET /api/1/media/find
user_session_key - string - provided in query string or body
volume_id - number - Volume to search
media_path - string - Path to search for media. Case-insensitive.
200 OK
media_id - number - Media ID
media_path - string - The path for the file.
file_hash - string - The hash of the file.
file_size - number - The size of the file.
ctime - string - The ISO8601 string of the ctime of the file.
mtime - string - The ISO8601 string of the ctime of the file.
last_update_user_id - number - The ID of the last user to modify the file, may be null if the last update was a device.
last_update_device_id - number - The ID of the last user to modify the file, may be null if the last update was a user.
last_updated - string - The ISO8601 string of the last update of the file.
is_deleted - number - 1 if the file is deleted.
403 Forbidden
Not logged in
404 Not Found
No media object at that path.
Retreieve the files and directories at a particular path.
GET /api/1/media/dir
user_session_key - string - provided in query string or body
volume_id - number - Volume to search
prefix_path - string - Prefix to search for media. (Case insenstive)
200 OK
media_list - list of object - List of files with that prefix_path.
-
media_id - number - Media ID
-
media_path - string - The path for the file.
-
file_hash - string - The hash of the file.
-
file_size - number - The size of the file.
-
ctime - string - The ISO8601 string of the ctime of the file.
-
mtime - string - The ISO8601 string of the ctime of the file.
-
last_update_user_id - number - The ID of the last user to modify the file, may be null if the last update was a device.
-
last_update_device_id - number - The ID of the last user to modify the file, may be null if the last update was a user.
-
last_updated - string - The ISO8601 string of the last update of the file.
-
is_deleted - number - 1 if the file is deleted.
dir_list - list of object - List of sub-directoriess with that prefix_path
-
dir_name - string - Complete subdirectory path.
-
file_count - number - Number of live files in that subdirectory and all further subdirectories. 0 indicated the sudirectory tree only contains deleted files.
403 Forbidden
Not logged in
Retreieve the details of a particular file.
GET /api/1/media/<media_id>
user_session_key - string - provided in query string or body
media_id - number - Media ID for the file.
volume_id - number - Volume containing the media object.
200 OK
media_id - number - Media ID
media_path - string - The path for the file.
file_hash - string - The hash of the file.
file_size - number - The size of the file.
ctime - string - The ISO8601 string of the ctime of the file.
mtime - string - The ISO8601 string of the ctime of the file.
last_update_user_id - number - The ID of the last user to modify the file, may be null if the last update was a device.
last_update_device_id - number - The ID of the last user to modify the file, may be null if the last update was a user.
last_updated - string - The ISO8601 string of the last update of the file.
is_deleted - number - 1 if the file is deleted.
403 Forbidden
Not logged in
404 Not Found
No media object with that ID.