Skip to main content

Files.Warwick APIs

The main interface to Files.Warwick is via a web browser. However, there are HTTP-based APIs to enable developers to write scripts to automate particular tasks.

The Files.Warwick APIs work in a similar way to the SiteBuilder APIs. (See the related FAQs on getting started and authentication via Single Sign-on, and so on.)

Name Description
Atom Publishing Protocol Using the Atom Publishing Protocol (AtomPub) to manage Files.Warwick file spaces.
Uploading a file Using the Files.Warwick API to upload a file.
Creating a folder Using the Files.Warwick API to create a new folder.
JSON view of a folder Using the Files.Warwick API to represent a folder.
XML view of a folder Using the Files.Warwick API to represent a folder.

Important: Because of the way that HTTP basic authentication sends an encrypted version of the username and password with every request, it's less secure than standard authentication via Single Sign-on. Also, by their very nature, automated programs require usernames and passwords to be stored on a computer. Storing your actual ITS usercode and password in this way would breach the Terms and Conditions of IT Services Accounts.

For automated systems that access Files.Warwick APIs, you must use an external user account for API access. Do not share an API account between multiple systems. Also, you should ensure that you grant each account the minimal permissions required to perform its tasks – and only for pages where it needs to perform these tasks.

Request an external user account for API access

To obtain an external user account, please email webteam at warwick dot ac dot uk with your request.