The ExaVault API v1.2 is provided so that customers who have upgraded from ExaVault can run their previous code without requiring widespread code changes.

This documentation is intended to help our customers maintain existing integration code that relied upon the ExaVault API.

Connecting to the API

Use your account's subdomain address, such as mysite.files.com, for all legacy version 1.2 calls.

Status Codes

The legacy ExaVault API 1.2 returns only two HTTP status codes for its responses: 200 and 500. It does not support traditional REST response codes such as 201 for inserting new records.

When the request could be successfully parsed, the response status code will be 200, regardless of whether the requested action could be taken. For example, the response to a getUser request for a user that does not exist in your account would have an HTTP status of 200, indicating that the request was received and processed but the error member of the returned response object would contain an error object.

When a malformed request is received, a 500 HTTP status will be returned, indicating that the request could not be processed.

Response Format

When a response is returned by the API, the response body object will include properties for success, results and error.

The results property of the response body will contain the relevant data, such as a list of deleted resources for the Delete Resources operation or the information about a new access token for the Authenticate With Password operation. The results property may be empty if there is no relevant information returned by the operation, or it may be null if an error occurred.

The success property of the response body indicates whether the request was processed without generating an error, and will contain either 0 or 1.

When the success property is 1, the operation is successful and the error property is null. When the success property is 0, the operation failed, and the error property with contain an error object.

The error object contains code and message properties that describe the error which occurred.

Example successful response body

This example is for a successful Logout operation. The HTTP status code returned with this response is 200.

{
  "error": null,
  "results": [],
  "success": 1
}

Example failed response body

This example is for a failed Authenticate With Password operation. The HTTP status code returned with this response is 200, even though the operation failed.

{
  "error": {
    "code": 100,
    "message": "Invalid username or password"
  },
  "results": null,
  "success": 0
}

New Development

The ExaVault platform and, by extension, the legacy ExaVault APIs, provided a limited set of features. We strongly urge developers to use the Files.com API, and its well-tested, tuned and optimized SDKs for new development in order to take advantage of all of the capabilities of the Files.com platform.

The Files.com API offers access to all of the features in your site including fine-grained user permissions, automations, IP address control, and history logs. We are continuously adding new functionality to our APIs and working to improve our SDKs.

Files.com offers SDKs in popular programming languages and provide developer-friendly features such as support for automatic pagination, automatic retries for file transfers and parallelization of uploads and downloads.