• General
  • My Apps
  • SDKs
  • Protocols
  • Structures
  • Methods
  • Errors
Log in Register Log out
  • General

  • My Apps

  • SDKs
    • C
    • Java
    • Javascript
    • Php
    • Swift

  • Protocols
    • HTTP JSON Protocol
      • Authentication
      • Single Connection
      • Uploading Files
    • Binary Protocol
      • Sending Binary Request
      • Sending Files
      • Receiving Binary Response
      • Receiving Files Data

  • Structures
    • Datetime
    • Event
    • Filenames
    • Metadata
    • Share
    • Tree

  • Methods
    • Intro
      • Global Parameters
      • Authentication
    • General
      • getdigest
      • userinfo
      • supportedlanguages
      • setlanguage
      • feedback
      • currentserver
      • diff
      • getfilehistory
      • getip
      • getapiserver
    • Folder
      • createfolder
      • createfolderifnotexists
      • listfolder
      • renamefolder
      • deletefolder
      • deletefolderrecursive
      • copyfolder
    • File
      • uploadfile
      • uploadprogress
      • downloadfile
      • downloadfileasync
      • copyfile
      • checksumfile
      • deletefile
      • renamefile
      • stat
    • Auth
      • sendverificationemail
      • verifyemail
      • changepassword
      • lostpassword
      • resetpassword
      • register
      • invite
      • userinvites
      • logout
      • listtokens
      • deletetoken
      • sendchangemail
      • changemail
      • senddeactivatemail
      • deactivateuser
    • Streaming
      • getfilelink
      • getvideolink
      • getvideolinks
      • getaudiolink
      • gethlslink
      • gettextfile
    • Archiving
      • getzip
      • getziplink
      • savezip
      • extractarchive
      • extractarchiveprogress
      • savezipprogress
    • Sharing
      • sharefolder
      • listshares
      • sharerequestinfo
      • cancelsharerequest
      • acceptshare
      • declineshare
      • removeshare
      • changeshare
    • Public Links
      • getfilepublink
      • getfolderpublink
      • gettreepublink
      • showpublink
      • getpublinkdownload
      • copypubfile
      • listpublinks
      • listplshort
      • deletepublink
      • changepublink
      • getpubthumb
      • getpubthumblink
      • getpubthumbslinks
      • savepubthumb
      • getpubzip
      • getpubziplink
      • savepubzip
      • getpubvideolinks
      • getpubaudiolink
      • getpubtextfile
      • getcollectionpublink
    • Thumbnails
      • getthumblink
      • getthumbslinks
      • getthumb
      • savethumb
    • Upload Links
      • createuploadlink
      • listuploadlinks
      • deleteuploadlink
      • changeuploadlink
      • showuploadlink
      • uploadtolink
      • uploadlinkprogress
      • copytolink
    • Revisions
      • listrevisions
      • revertrevision
    • Newsletter
      • newsletter_subscribe
      • newsletter_check
      • newsletter_verifyemail
      • newsletter_unsubscribe
      • newsletter_unsibscribemail
    • Trash
      • trash_list
      • trash_restorepath
      • trash_restore
      • trash_clear
    • Collection
      • collection_list
      • collection_details
      • collection_create
      • collection_rename
      • collection_delete
      • collection_linkfiles
      • collection_unlinkfiles
      • collection_move
    • OAuth 2.0
      • authorize
      • oauth2_token
    • Transfer
      • uploadtransfer
      • uploadtransferprogress

  • Errors

Metadata

The metadata for a file or folder normally consists of:

FieldDescription
parentfolderidinteger is the folderid of the folder the object resides in
isfolderbool is it a folder(true) or file(false)
isminebool is the object owned by the user if ismine is false than four other bool fields are provided:
  • canread
  • canmodify
  • candelete
  • cancreate (cancreate - only for folders)
These are user's permissions for this object Also, when ismine is false, userid is provided with the id of the owner of the file/folder.

This userid can be matched with userid's provided by either listshares method or acceptedsharein/acceptedshareout events by diff method.
issharedbool is the object shared with other users
namestring the name of file or folder
idstring unique string id. For folders this is folderid prepended with letter d and for files it is the fileid with f in front.
folderidfor folders the folderid of the folder
fileidfor files file's fileid
deletedfileidstring It is possible that as a result of renamefile operation a file with the same name gets deleted (e.g. file old.txt is renamed to new.txt when new.txt already exists in this folder). In these cases deletedfileid is set to fileid of the deleted file.
createdtimestamp creation date of the object
modifiedtimestamp modification date of the object
iconstring name of the icon to display (one of document, database, archive, web, gis, spreadsheet, font, presentation, image, diskimage, package, executable, audio, video, file)
categoryint category of the file can be one of:
  • 0 - uncategorized
  • 1 - image
  • 2 - video
  • 3 - audio
  • 4 - document
  • 5 - archive
thumbbool true if thumbs can be created from the object
sizeint size in bytes, present only for files
contenttypestring content-type of the file, present only for files
hashint 64 bit integer representing hash of the contents of the file can be used to determine if two files are the same or to monitor file contents for changes. Present only for files.
contentsarray array of metadata objects representing contents of the directory
isdeletedbool isdeleted is never false, it is present only for deleted objects, only when deleted objects are requested
pathstring Full path might be provided in some cases. If you work with paths and request folders by path, it will be provided. Recursive listings do not have path provided.

Optionally image files may have:

FieldDescription
widthint width of the image in pixels
heightint height of the image of pixels

Optionally audio files may have:

FieldDescription
artiststring
albumstring
titlestring
genrestring
tracknostring

Optionally video files may have:

FieldDescription
widthint width of the video in pixels
heightint height of the video of pixels
durationfloat duration of the video in seconds (floating point number sent as string)
fpsfloat frames per second rate of the video (floating point number sent as string)
videocodecstring codec used for enconding of the video
audiocodecstring codec used for enconding of the audio
videobitrateint bitrate of the video in kilobits
audiobitrateint bitrate of the audio in kilobits
audiosamplerateint sampling rate of the audio in Hz
rotateint indicates that video should be rotated (0, 90, 180 or 270) degrees when playing

Example for folder

{
    "created": "Wed, 02 Oct 2013 13:11:53 +0000",
    "isfolder": true,
    "parentfolderid": 0,
    "icon": "folder",
    "id": "d230807",
    "path": "\/new folder",
    "modified": "Wed, 02 Oct 2013 13:11:53 +0000",
    "thumb": false,
    "folderid": 230807,
    "isshared": false,
    "ismine": true,
    "name": "new folder"
}

Example for video file

{
    "ismine": true,
    "hash": 14802317402369427389,
    "id": "f744",
    "parentfolderid": 73,
    "category": 2,
    "fps": "25.00",
    "audiobitrate": 189,
    "icon": "video",
    "created": "Fri, 26 Apr 2013 13:48:00 +0000",
    "audiocodec": "aac",
    "videocodec": "h264",
    "size": 182339732,
    "name": "Octane Team 2013 Winter Rally Training.mp4",
    "duration": "245.33",
    "audiosamplerate": 48000,
    "rotate": 0,
    "width": 1280,
    "videobitrate": 5737,
    "height": 720,
    "isshared": false,
    "fileid": 744,
    "contenttype": "video\/mp4",
    "isfolder": false,
    "modified": "Fri, 26 Apr 2013 14:52:02 +0000",
    "thumb": true
}
2014 © pCloud. Terms and Conditions. Privacy Policy. Intellectual Property.
© pCloud. Terms and Conditions. Privacy Policy. Intellectual Property.
Reset Password
Check your e-mail for further instructions.
Reset