ExaVault
ExaVaults API allows you to incorporate ExaVaults suite of file transfer and user management tools into your own application.\nExaVault supports both POST…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
ExaVaults API allows you to incorporate ExaVaults suite of file transfer and user management tools into your own application.\nExaVault supports both POST (recommended when requesting large data sets) and GET operations, and requires an API key in order to use.
Endpoints 59
Resources
- GETGet Resource Properties
/resources?resource=string&include=stringReturns details for specified file/folder id or hash, including upload date, size and type. For the full list of returned properties, see the response syntax,… - POSTCreate a folder
/resourcesCreate a new empty folder at the specified path. New files can be uploaded via the /resources/upload endpoint. Notes: Authenticated user should have modify… - DELETEDelete Resources
/resourcesDelete multiple file or folder resourcess. Deleting a folder resource will also delete any resources in that folder. Notes: Authenticated user should have… - POSTCompress resources
/resources/compressCreate a zip archive containing the files from given set of paths. Note that this can be a very slow operation if you have indicated many files should be… - POSTCopy resources
/resources/copyCopies a set of exisiting files/folders (provided by an array resources) to the requested parentResource in your account. In the resources array, you may… - GETDownload a file
/resources/download?resources[]=string&downloadArchiveName=stringDownloads a file from the server. Whenever more than one file is being downloaded, the file are first zipped into a single file before the download starts,… - POSTExtract resources
/resources/extractExtract the contents of a zip archive to a specified directory. Note that this can be a very slow operation. Notes: You must have modify permission to do this. - GETGet a list of all resources
/resources/list?resource=string&sort=name&offset=0&limit=0&type=string&name=string&include=stringReturns a list of files and folders in the account. Use the resource query parameter to indicate the folder you wish to search in (which can be /). Searching… - GETList contents of folder
/resources/list/:id?sort=name&offset=0&limit=0&type=string&include=stringReturns a list of files/folders for the parent resource ID. You can use this API call to get information about all files and folders at a specified path. By… - POSTMove resources
/resources/moveMoves a set of exisiting files/folders (provided by an array resources) to the requested parentResource in your account. In the resources array, you may… - GETPreview a file
/resources/preview?resource=string&size=small&width=0&height=0&page=0Returns a resized image of the specified document for supported file types. Image data returned is encoded in base64 format and can be viewed using the <img>… - POSTUpload a file
/resources/upload?path=string&fileSize=2935&resume=true&allowOverwrite=trueUploads a file to a specified path, with optional support for resuming a partially uploaded existing file. - GETGet resource metadata
/resources/:id?include=stringReturns metadata for specified file/folder path, including upload date, size and type. For the full list of returned properties, see the response syntax,… - DELETEDelete a Resource
/resources/:idDelete a single file or folder resource. Deleting a folder will also delete all of the contents. Notes: Authenticated user should have delete permission.… - PATCHRename a resource.
/resources/:idUpdate the specified file or folder resource record's "name" parameter. The resource is identified by the numeric resource ID that is passed in as the last…
Activity
- GETGet activity logs
/activity/session?startDate=2019-10-18T06:48:40Z&endDate=2019-10-18T06:48:40Z&ipAddress=127.0.0.1&username=jdoe&path=/folder*&type=EDIT_SHARE&offset=100&limit=10&sort=-dateReturns the detailed activity logs for your account. Optional query paramaters will filter the returned results based on a number of options including… - GETGet webhook logs
/activity/webhooks?startDate=2024-01-01T00:00:00Z&endDate=2024-01-01T00:00:00Z&endpointUrl=https://example.com&event=resources.upload&statusCode=200&resourcePath=/folder*&username=exampleuser&offset=100&limit=10&sort=-date,eventReturns the webhook logs for your account. Use the available query parameters to filter the listing of activity that is returned. NOTE: Total Results will…
Users
- GETGet a list of users
/users?username=testuser&homeResource=string&nickname=string&email=*@example.co&role=use&status=0&search=string&offset=50&sort=homeDir,-modified&limit=100&include=homeResource,ownerAccountGet a list of the users in your account. There are three main types of searches you can do with this method: 1. Search for a user by username. If you provide… - POSTCreate a user
/usersAdds a new user to the account. The user may be configured as an admin or standard user, and (if a standard user) may be assigned a restricted home directory… - GETGet info for a user
/users/:id?include=homeResource,owneraccountGet the details for a specific user. You can use the include parameter to also get the details of related records, such as the account or the home directory.… - DELETEDelete a user
/users/:idDelete a user from the account. Deleting a user does NOT delete any files from the account; it merely removes a user's access. Aternatively, locking a user… - PATCHUpdate a user
/users/:idUpdates the settings for the user. Note that the unique key for this API call is our internal ID, and _not_ the username, as the username can be changed. In…
Shares
- GETGet a list of shares
/shares?offset=100&limit=10&scope=active&sort=created&type=receive&include=owner,notifications&name=Customer*&recipient=test@example.com&message=submitted&username=example&search=stringGet a list of shares that you would have access to view through the web interface. You can limit which results are returned by specifying specific types of… - POSTCreates a share
/sharesCreates a new share object for the given path in your account. We support three types of shares: A shared folder allows you to let outside parties access a… - POSTComplete send files
/shares/complete-send/:idAfter uploading the file(s) to be sent, this method will trigger invitation emails and finish the send files setup. If you are not sending files from your own… - GETGet a share
/shares/:id?include=owner,notificationsGet the details for a specific share entry. You can use the include parameter to also get the details of related records, such as the owning user or the… - DELETEDeactivate a share
/shares/:idDeactivate a share. Deactivating a share does not remove the underlying files for shared_folder and receive share types; it merely removes the access URL.… - PATCHUpdate a share
/shares/:idChange the settings on an active share. Any changes made will affect all users that have access to the share. When updating invitees, pass the recipients body…
Notifications
- GETGet a list of notifications
/notifications?type=file&offset=50&sort=date&limit=100&include=resource,share,user&action=allGet a list of all the notifications you have access to. You can use sorting and filtering to limit the returned list. Notes: Authenticated user should have… - POSTCreate a new notification
/notificationsCreate a new notification for a resource in your account. Notifications can be sent via email or webhook; To enable email, pass an array of email addresses to… - GETGet notification details
/notifications/:id?include=resource,shareGet the details for a notification with a specific ID number. You'll be able to review its path, triggers and who's getting the notification. Notes You need… - DELETEDelete a notification
/notifications/:idDeletes a notification. Note that deleting a notification _only_ deletes the notification – it does not delete any underlying files or folders. Notes:… - PATCHUpdate a notification
/notifications/:idUpdate an existing notification. You can add additional emails or change the action or users that cause a notification to trigger. When updating recipient…
Email Lists
- GETGet all email groups
/email-lists?include=stringList all email groups for authenticated user - POSTCreate new email list
/email-listsCreate a new email list. Among other things, email lists can be used to send files or share folders with a group of email addresses at once. - GETGet individual email group
/email-lists/:id?include=stringRetrieve all the details of a specific email list including it's name, when it was created and all the email addresses that belong to the group. - DELETEDelete an email group with given id
/email-lists/:idPermanently delete an email group. This action is not reversible. We recommend making a user confirm this action before sending the API call. - PATCHUpdate an email group
/email-lists/:idAdd or remove emails from an email list that can be used to send and share files with groups. Notes *This call will replace your current email list in its…
Account
- GETGet account settings
/account?include=masterUserGet settings for your account, such as current space usage, webhooks settings, welcome email content and IP address restrictions. - PATCHUpdate account settings
/accountUpdate account settings, such as welcome email content, IP address restrictions, webhooks settings and secure password requirements. Notes You must have…
SSH Keys
- GETGet metadata for a list of SSH Keys
/ssh-keys?userId=string&limit=0&offset=0Returns a list of SSH Keys within the account. Can be filtered for a single user. - POSTCreate a new SSH Key
/ssh-keysCreate a new SSH Key for a user. Provide the Public Key as formatted from the ssh-keygen command (openssh format or RFC-4716 format). If you'd prefer to let… - GETGet metadata for an SSH Key
/ssh-keys/:idReturn the information for a single SSH Key - DELETEDelete an SSH Key
/ssh-keys/:idDelete the specified SSH key. This will not delete or deactivate the user tied to the key.
Form
- GETGet receive folder form settings
/forms?shareHash=string&include=shareGet the information for the file upload form assigned to a receive folder by its shareHash. The form details will return all the input field settings and the… - GETGet form data entries for a receive
/forms/entries/:id?limit=10&offset=100Returns the form data entries for a specific form for a receive. Optional parameters can be included in the call to manage larger data sets. - DELETEDelete a receive form submission
/forms/entries/:idDeletes a form submission entry, which represents one time that a visitor filled out the form and uploaded files. This deletes only the record of the… - GETGet receive folder form by Id
/forms/:id?include=shareReturns the file upload form assigned to a receive folder. The form details will return all the input fields and their settings. Use the include parameter… - PATCHUpdates a form with given parameters
/forms/:idAdd, update, or delete a form's parameters. This will alter how your users/customers will see and interact with the form when sending you files. Notes *This…
Recipients
- POSTResend invitations to share recipients
/recipients/shares/invites/:shareIdResend invitations to one or all recipients attached to specified share. The most recent message that was sent for the share will be re-used for this email.…
- POSTSend referral email to a given address
/email/referralInvite a friend to sign up for a free trial of ExaVault. Send a referral email to an email address. If the recipient signs up for ExaVault, we'll apply a… - POSTResend welcome email to specific user
/email/welcome/:usernameSend a welcome email to a user. The contents of the welcome email can be set by PATCH /accounts.
Webhooks
- GETGet Webhooks List
/webhooks?include=string&offset=100&limit=10Returns a list of Webhooks. By default, this will return metadata on all Webhooks within the account. - POSTAdd A New Webhook
/webhooksCreate a new Webhook on your account. Creating a Webhook will require an endpoint URL, a path, what events should trigger a webhook, and what request version… - POSTRegenerate security token
/webhooks/regenerate-token/:idThis endpoint will allow you to regenerate the security token for a webhook if you believe it’s been compromised in any way. - POSTResend a webhook message
/webhooks/resend/:activityIdThis endpoint will allow you to resend a webhook that was previously sent. Resent webhooks will send exactly the same as the original webhook with the… - GETGet info for a webhook
/webhooks/:id?include=stringReturns the metadata for a specific webhook. Webhook IDs can be retrieve from GET /webhooks - DELETEDelete a webhook
/webhooks/:idDeleted the specified webhook. This will not affect logs or any resources the webhook is connected to. - PATCHUpdate a webhook
/webhooks/:idUpdate the specified webhook. Updated webhooks will take effect immediately and could impact active workflows. Please be certain the webhook is not currently…
API details
- Base URL
https://accountname.exavault.com/api/v2- Authentication
- None declared in the description
- Operations
- 59 operations on 35 pathsGET 24POST 18DELETE 9PATCH 8
- Main resources
- Resources 15Webhooks 7Shares 6Email Lists 5Form 5Notifications 5Users 5SSH Keys 4Account 2Activity 2
- Response formats
application/jsonapplication/octet-streamapplication/zip- Description format
- OpenAPI 3.0.0, API version
2.0 - Links
- Documentation · OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the ExaVault in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the ExaVault collection, without the publisher's secrets.
- Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
- Send a requestPick an endpoint, for example “Get Resource Properties” (GET /resources?resource=string&include=string), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the ExaVault?
ExaVaults API allows you to incorporate ExaVaults suite of file transfer and user management tools into your own application.\nExaVault supports both POST… It is listed under Other and has 59 endpoints.
Who publishes the ExaVault?
It is listed from Exavault's public API description (an OpenAPI document), not published by Exavault on Swastik Codes. Anyone who controls exavault.com can claim the profile by adding a DNS TXT record.
What is the base URL of the ExaVault?
Requests go to https://accountname.exavault.com/api/v2. Endpoint paths are added to this base URL.
How do I authenticate with the ExaVault?
Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.
How many endpoints does the ExaVault have?
59 operations on 35 paths (24 GET, 18 POST, 9 DELETE, 8 PATCH). The largest groups are Resources, Webhooks, Shares, Email Lists.
Is forking the ExaVault free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.