• 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

Global parameters

Global parameters are such that are optional for every method and could be used with it.

These parameters are skipped in the methods description, since they are common for them.

ParameterDescription
idif set to anything, you will get it back in the reply (no matter successful or not). This might be useful if you pipeline requests from many places over single connection.
timeformatif set to timestamp all datetime fields will be represented as UTC unix timestamps, any other value leaves the default date format and is meaningless. The default datetime format is Thu, 21 Mar 2013 18:31:45 +0000 (rfc 2822), exactly 31 bytes long.
getauthIf set to any value upon successful authentication an auth token will be returned. Auth tokens are at most 64 bytes long and can be passed back instead of username/password credentials by auth parameter. This token is especially good for setting the auth cookie to keep the user logged in.
filtermetaIf it is set, it is supposed to be a coma (with no whitespace after it) separated list of fileds of metadata that you wish to receive from all calls returning metadata. This may be used to eliminate fields that you don't use and thus reduce the amount of traffic and parsing required for communications. If set to empty string/0 restores the default all value. You don't need to send this with every request, once per connection suffices.
filterfilemetasame as above, but only has effect of meta of the files.
filterfoldermetasame as above, but for folders.
revisionidAll methods that take fileid or path as parameters to identify a file can also take optional parameter revisionid to choose a revision of the file.

This makes sense only in some cases like for example with getfilelink or copyfile and is meaningless with deletefile as the file itself will be deleted in any case.
logoutIf set, logouts current connection. Logout is performed before processing any login parameters. In order to switch the logged user on a connection both logout and any form of authentication should be present.
username/passwordUsername and password in plain text. Should only be used over SSL connections.
username/passworddigest/digestDigest authentication.

digest is to be received before logging in with getdigest

passworddigest is to be computed as sha1 hash of concatenated user's password, sha1 of lowercase of username and received digest. In both cases sha1 is presented as 40 byte hex with lowercase letters.
access_tokenThis is an OAuth 2.0 bearer token that is used to authenticate your app.

This token could be received by the code or token authorization flows using the methods - authorize and if code flow is used - oauth2_token.
devicestring Identifies the device that is requesting auth token from the server. This is required for the binary protocol. For the HTTP JSON protocol, this field defaults to the HTTP User-Agent header.
authexpireint Define the expire value of authentication token, when it is requested. This field is in seconds and the expire will the moment after these seconds since the current moment.

Defaults to 31536000 and its maximum is 63072000.
authinactiveexpireint Define the expire_inactive value of authentication token, when it is requested. This field is in seconds and the expire_incative will the moment after these seconds since the current moment. Defaults to 2678400 and its maximum is 5356800.
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