Module files.com

ballerinax/files.com Ballerina library

1.5.1

Overview

This is a generated connector from Files.com API v1.0 OpenAPI specification.

Welcome to the Files.com API. Our REST API are designed for people who require the highest level of integration between Files.com and their own application, website, or database.

Prerequisites

Before using this connector in your Ballerina application, complete the following:

Create a Files.com account
Obtain tokens by following this guide

Quickstart

To use the Files.com connector in your Ballerina application, update the .bal file as follows:

Step 1: Import connector

First, import the ballerinax/files.com module into the Ballerina project.


import ballerinax/files.com as filesdotcom;

Step 2: Create a new connector instance

Create a filesdotcom:ClientConfig with the API key obtained, and initialize the connector with it.


filesdotcom:ClientConfig clientConfig = {
    authConfig : {
        token: <ACCESS_TOKEN>
    }
};

filesdotcom:Client baseClient = check new Client(clientConfig);

Step 3: Invoke connector operation

Now you can use the operations available within the connector. Note that they are in the form of remote operations.

Following is an example on how to get API activity using the connector.


public function main() {
    filesdotcom:SiteEntity|error response = baseClient->getSite();
    if (response is filesdotcom:SiteEntity) {
        log:printInfo(response.toString());
    } else {
        log:printError(response.message());
    }
}

Use bal run command to compile and run the Ballerina program.

Clients

files.com: Client

Isolated

This is a generated connector from Files.com API v1.0 OpenAPI specification. Welcome to the Files.com API. Our REST API are designed for people who require the highest level of integration between Files.com and their own application, website, or database.

Constructor

Gets invoked to initialize the connector. The connector initialization requires setting the API credentials. Obtain API keys following this guide.

init (ApiKeysConfig apiKeyConfig, string serviceUrl, ConnectionConfig config)

apiKeyConfig ApiKeysConfig - API keys for authorization

serviceUrl string - URL of the target service

config ConnectionConfig {} - The configurations to be used when initializing the connector

postActionNotificationExports

Isolated FunctionRemote Function

function postActionNotificationExports(ActionNotificationExportsBody payload) returns ActionNotificationExportEntity|error

Create Action Notification Export

Parameters

payload ActionNotificationExportsBody -

Return Type

ActionNotificationExportEntity|error - The ActionNotificationExports object.

getActionNotificationExportsId

Isolated FunctionRemote Function

function getActionNotificationExportsId(int id) returns ActionNotificationExportEntity|error

Show Action Notification Export

Parameters

id int - Action Notification Export ID.

Return Type

ActionNotificationExportEntity|error - The ActionNotificationExports object.

getActionNotificationExportResults

Isolated FunctionRemote Function

function getActionNotificationExportResults(int actionNotificationExportId, int? userId, string? cursor, int? perPage) returns ActionNotificationExportResultEntity[]|error

List Action Notification Export Results

Parameters

actionNotificationExportId int - ID of the associated action notification export.

userId int? (default ()) - User ID. Provide a value of 0 to operate the current session's user.

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

Return Type

ActionNotificationExportResultEntity[]|error - A list of ActionNotificationExportResults objects.

postActionWebhookFailuresIdRetry

Isolated FunctionRemote Function

function postActionWebhookFailuresIdRetry(int id) returns Response|error

retry Action Webhook Failure

Parameters

id int - Action Webhook Failure ID.

Return Type

Response|error - The ActionWebhookFailures object.

apiKeyFindCurrent

Isolated FunctionRemote Function

function apiKeyFindCurrent() returns ApiKeyEntity|error

Show information about current API key. (Requires current API connection to be using an API key.)

Return Type

ApiKeyEntity|error - The ApiKey object.

apiKeyDeleteCurrent

Isolated FunctionRemote Function

function apiKeyDeleteCurrent() returns Response|error

Delete current API key. (Requires current API connection to be using an API key.)

Return Type

Response|error - No body.

apiKeyUpdateCurrent

Isolated FunctionRemote Function

function apiKeyUpdateCurrent(ApiKeyBody payload) returns ApiKeyEntity|error

Update current API key. (Requires current API connection to be using an API key.)

Parameters

payload ApiKeyBody -

Return Type

ApiKeyEntity|error - The ApiKey object.

getApiKeysId

Isolated FunctionRemote Function

function getApiKeysId(int id) returns ApiKeyEntity|error

Show Api Key

Parameters

id int - Api Key ID.

Return Type

ApiKeyEntity|error - The ApiKeys object.

deleteApiKeysId

Isolated FunctionRemote Function

function deleteApiKeysId(int id) returns Response|error

Delete Api Key

Parameters

id int - Api Key ID.

Return Type

Response|error - No body.

patchApiKeysId

Isolated FunctionRemote Function

function patchApiKeysId(int id, ApiKeysIdBody payload) returns ApiKeyEntity|error

Update Api Key

Parameters

id int - Api Key ID.

payload ApiKeysIdBody -

Return Type

ApiKeyEntity|error - The ApiKeys object.

getApiKeys

Isolated FunctionRemote Function

function getApiKeys(int? userId, string? cursor, int? perPage, record {}? sortBy, record {}? filter, record {}? filterGt, record {}? filterGteq, record {}? filterLike, record {}? filterLt, record {}? filterLteq) returns ApiKeyEntity[]|error

List Api Keys

Parameters

userId int? (default ()) - User ID. Provide a value of 0 to operate the current session's user.

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

sortBy record {}? (default ()) - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are expires_at.

filter record {}? (default ()) - If set, return records where the specifiied field is equal to the supplied value. Valid fields are expires_at.

filterGt record {}? (default ()) - If set, return records where the specifiied field is greater than the supplied value. Valid fields are expires_at.

filterGteq record {}? (default ()) - If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are expires_at.

filterLike record {}? (default ()) - If set, return records where the specifiied field is equal to the supplied value. Valid fields are expires_at.

filterLt record {}? (default ()) - If set, return records where the specifiied field is less than the supplied value. Valid fields are expires_at.

filterLteq record {}? (default ()) - If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are expires_at.

Return Type

ApiKeyEntity[]|error - A list of ApiKeys objects.

postApiKeys

Isolated FunctionRemote Function

function postApiKeys(ApiKeysBody payload) returns ApiKeyEntity|error

Create Api Key

Parameters

payload ApiKeysBody -

Return Type

ApiKeyEntity|error - The ApiKeys object.

getSiteUsage

Isolated FunctionRemote Function

function getSiteUsage() returns UsageSnapshotEntity|error

Get the most recent usage snapshot (usage data for billing purposes) for a Site.

Return Type

UsageSnapshotEntity|error - The Site object.

getSite

Isolated FunctionRemote Function

function getSite() returns SiteEntity|error

Show site settings

Return Type

SiteEntity|error - The Site object.

patchSite

Isolated FunctionRemote Function

function patchSite(SiteBody payload) returns SiteEntity|error

Update site settings.

Parameters

payload SiteBody -

Return Type

SiteEntity|error - The Site object.

getSiteIpAddresses

Isolated FunctionRemote Function

function getSiteIpAddresses(string? cursor, int? perPage) returns IpAddressEntity[]|error

List IP Addresses associated with the current site

Parameters

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

Return Type

IpAddressEntity[]|error - A list of IpAddresses objects.

getSiteDnsRecords

Isolated FunctionRemote Function

function getSiteDnsRecords(string? cursor, int? perPage) returns DnsRecordEntity[]|error

Show site DNS configuration.

Parameters

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

Return Type

DnsRecordEntity[]|error - A list of DnsRecords objects.

postSiteTestWebhook

Isolated FunctionRemote Function

function postSiteTestWebhook(SiteTestwebhookBody payload) returns StatusEntity|error

Test webhook.

Parameters

payload SiteTestwebhookBody -

Return Type

StatusEntity|error - The Behaviors object.

getSiteApiKeys

Isolated FunctionRemote Function

function getSiteApiKeys(int? userId, string? cursor, int? perPage, record {}? sortBy, record {}? filter, record {}? filterGt, record {}? filterGteq, record {}? filterLike, record {}? filterLt, record {}? filterLteq) returns ApiKeyEntity[]|error

List Api Keys

Parameters

userId int? (default ()) - User ID. Provide a value of 0 to operate the current session's user.

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

sortBy record {}? (default ()) - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are expires_at.

filter record {}? (default ()) - If set, return records where the specifiied field is equal to the supplied value. Valid fields are expires_at.

filterGt record {}? (default ()) - If set, return records where the specifiied field is greater than the supplied value. Valid fields are expires_at.

filterGteq record {}? (default ()) - If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are expires_at.

filterLike record {}? (default ()) - If set, return records where the specifiied field is equal to the supplied value. Valid fields are expires_at.

filterLt record {}? (default ()) - If set, return records where the specifiied field is less than the supplied value. Valid fields are expires_at.

filterLteq record {}? (default ()) - If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are expires_at.

Return Type

ApiKeyEntity[]|error - A list of ApiKeys objects.

postSiteApiKeys

Isolated FunctionRemote Function

function postSiteApiKeys(SiteApiKeysBody payload) returns ApiKeyEntity|error

Create Api Key

Parameters

payload SiteApiKeysBody -

Return Type

ApiKeyEntity|error - The ApiKeys object.

patchUser

Isolated FunctionRemote Function

function patchUser(UserBody payload) returns UserEntity|error

Update User

Parameters

payload UserBody -

Return Type

UserEntity|error - The Users object.

getUserPublicKeys

Isolated FunctionRemote Function

function getUserPublicKeys(int? userId, string? cursor, int? perPage) returns PublicKeyEntity[]|error

List Public Keys

Parameters

userId int? (default ()) - User ID. Provide a value of 0 to operate the current session's user.

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

Return Type

PublicKeyEntity[]|error - A list of PublicKeys objects.

postUserPublicKeys

Isolated FunctionRemote Function

function postUserPublicKeys(UserPublicKeysBody payload) returns PublicKeyEntity|error

Create Public Key

Parameters

payload UserPublicKeysBody -

Return Type

PublicKeyEntity|error - The PublicKeys object.

getUserGroups

Isolated FunctionRemote Function

function getUserGroups(int? userId, string? cursor, int? perPage, int? groupId) returns GroupUserEntity[]|error

List Group Users

Parameters

userId int? (default ()) - User ID. If provided, will return group_users of this user.

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

groupId int? (default ()) - Group ID. If provided, will return group_users of this group.

Return Type

GroupUserEntity[]|error - A list of GroupUsers objects.

getUserAs2Keys

Isolated FunctionRemote Function

function getUserAs2Keys(int? userId, string? cursor, int? perPage) returns As2KeyEntity[]|error

List As2 Keys

Parameters

userId int? (default ()) - User ID. Provide a value of 0 to operate the current session's user.

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

Return Type

As2KeyEntity[]|error - A list of As2Keys objects.

postUserAs2Keys

Isolated FunctionRemote Function

function postUserAs2Keys(UserAs2KeysBody payload) returns As2KeyEntity|error

Create As2 Key

Parameters

payload UserAs2KeysBody -

Return Type

As2KeyEntity|error - The As2Keys object.

getUserApiKeys

Isolated FunctionRemote Function

function getUserApiKeys(int? userId, string? cursor, int? perPage, record {}? sortBy, record {}? filter, record {}? filterGt, record {}? filterGteq, record {}? filterLike, record {}? filterLt, record {}? filterLteq) returns ApiKeyEntity[]|error

List Api Keys

Parameters

userId int? (default ()) - User ID. Provide a value of 0 to operate the current session's user.

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

sortBy record {}? (default ()) - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are expires_at.

filter record {}? (default ()) - If set, return records where the specifiied field is equal to the supplied value. Valid fields are expires_at.

filterGt record {}? (default ()) - If set, return records where the specifiied field is greater than the supplied value. Valid fields are expires_at.

filterGteq record {}? (default ()) - If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are expires_at.

filterLike record {}? (default ()) - If set, return records where the specifiied field is equal to the supplied value. Valid fields are expires_at.

filterLt record {}? (default ()) - If set, return records where the specifiied field is less than the supplied value. Valid fields are expires_at.

filterLteq record {}? (default ()) - If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are expires_at.

Return Type

ApiKeyEntity[]|error - A list of ApiKeys objects.

postUserApiKeys

Isolated FunctionRemote Function

function postUserApiKeys(UserApiKeysBody payload) returns ApiKeyEntity|error

Create Api Key

Parameters

payload UserApiKeysBody -

Return Type

ApiKeyEntity|error - The ApiKeys object.

postUsersIdUnlock

Isolated FunctionRemote Function

function postUsersIdUnlock(int id) returns Response|error

Unlock user who has been locked out due to failed logins.

Parameters

id int - User ID.

Return Type

Response|error - No body.

postUsersIdResendWelcomeEmail

Isolated FunctionRemote Function

function postUsersIdResendWelcomeEmail(int id) returns Response|error

Resend user welcome email

Parameters

id int - User ID.

Return Type

Response|error - No body.

postUsersId2faReset

Isolated FunctionRemote Function

function postUsersId2faReset(int id) returns Response|error

Trigger 2FA Reset process for user who has lost access to their existing 2FA methods.

Parameters

id int - User ID.

Return Type

Response|error - No body.

getUsersId

Isolated FunctionRemote Function

function getUsersId(int id) returns UserEntity|error

Show User

Parameters

id int - User ID.

Return Type

UserEntity|error - The Users object.

deleteUsersId

Isolated FunctionRemote Function

function deleteUsersId(int id) returns Response|error

Delete User

Parameters

id int - User ID.

Return Type

Response|error - No body.

patchUsersId

Isolated FunctionRemote Function

function patchUsersId(int id, UsersIdBody payload) returns UserEntity|error

Update User

Parameters

id int - User ID.

payload UsersIdBody -

Return Type

UserEntity|error - The Users object.

getUsers

Isolated FunctionRemote Function

function getUsers(string? cursor, int? perPage, record {}? sortBy, record {}? filter, record {}? filterGt, record {}? filterGteq, record {}? filterLike, record {}? filterLt, record {}? filterLteq, string? ids, string? qUsername, string? qEmail, string? qNotes, string? qAdmin, string? qAllowedIps, string? qPasswordValidityDays, string? qSslRequired, string? search) returns UserEntity[]|error

List Users

Parameters

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

sortBy record {}? (default ()) - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are authenticate_until, email, last_desktop_login_at, last_login_at, username, company, name, site_admin, receive_admin_alerts, password_validity_days, ssl_required or not_site_admin.

filter record {}? (default ()) - If set, return records where the specifiied field is equal to the supplied value. Valid fields are username, email, company, site_admin, password_validity_days, ssl_required, last_login_at, authenticate_until or not_site_admin.

filterGt record {}? (default ()) - If set, return records where the specifiied field is greater than the supplied value. Valid fields are username, email, company, site_admin, password_validity_days, ssl_required, last_login_at, authenticate_until or not_site_admin.

filterGteq record {}? (default ()) - If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are username, email, company, site_admin, password_validity_days, ssl_required, last_login_at, authenticate_until or not_site_admin.

filterLike record {}? (default ()) - If set, return records where the specifiied field is equal to the supplied value. Valid fields are username, email, company, site_admin, password_validity_days, ssl_required, last_login_at, authenticate_until or not_site_admin.

filterLt record {}? (default ()) - If set, return records where the specifiied field is less than the supplied value. Valid fields are username, email, company, site_admin, password_validity_days, ssl_required, last_login_at, authenticate_until or not_site_admin.

filterLteq record {}? (default ()) - If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are username, email, company, site_admin, password_validity_days, ssl_required, last_login_at, authenticate_until or not_site_admin.

ids string? (default ()) - comma-separated list of User IDs

qUsername string? (default ()) - List users matching username.

qEmail string? (default ()) - List users matching email.

qNotes string? (default ()) - List users matching notes field.

qAdmin string? (default ()) - If true, list only admin users.

qAllowedIps string? (default ()) - If set, list only users with overridden allowed IP setting.

qPasswordValidityDays string? (default ()) - If set, list only users with overridden password validity days setting.

qSslRequired string? (default ()) - If set, list only users with overridden SSL required setting.

search string? (default ()) - Searches for partial matches of name, username, or email.

Return Type

UserEntity[]|error - A list of Users objects.

postUsers

Isolated FunctionRemote Function

function postUsers(UsersBody payload) returns UserEntity|error

Create User

Parameters

payload UsersBody -

Return Type

UserEntity|error - The Users object.

getUsersUserIdCipherUses

Isolated FunctionRemote Function

function getUsersUserIdCipherUses(int userId, string? cursor, int? perPage) returns UserCipherUseEntity[]|error

List User Cipher Uses

Parameters

userId int - User ID. Provide a value of 0 to operate the current session's user.

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

Return Type

UserCipherUseEntity[]|error - A list of UserCipherUses objects.

getUsersUserIdPublicKeys

Isolated FunctionRemote Function

function getUsersUserIdPublicKeys(int userId, string? cursor, int? perPage) returns PublicKeyEntity[]|error

List Public Keys

Parameters

userId int - User ID. Provide a value of 0 to operate the current session's user.

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

Return Type

PublicKeyEntity[]|error - A list of PublicKeys objects.

postUsersUserIdPublicKeys

Isolated FunctionRemote Function

function postUsersUserIdPublicKeys(int userId, UserIdPublicKeysBody payload) returns PublicKeyEntity|error

Create Public Key

Parameters

userId int - User ID. Provide a value of 0 to operate the current session's user.

payload UserIdPublicKeysBody -

Return Type

PublicKeyEntity|error - The PublicKeys object.

getUsersUserIdPermissions

Isolated FunctionRemote Function

function getUsersUserIdPermissions(string userId, string? cursor, int? perPage, record {}? sortBy, record {}? filter, record {}? filterGt, record {}? filterGteq, record {}? filterLike, record {}? filterLt, record {}? filterLteq, string? groupId, boolean? includeGroups) returns PermissionEntity[]|error

List Permissions

Parameters

userId string - DEPRECATED: User ID. If provided, will scope permissions to this user. Use filter[user_id] instead.

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

sortBy record {}? (default ()) - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are group_id, path, user_id or permission.

filter record {}? (default ()) - If set, return records where the specifiied field is equal to the supplied value. Valid fields are group_id, user_id or path.

filterGt record {}? (default ()) - If set, return records where the specifiied field is greater than the supplied value. Valid fields are group_id, user_id or path.

filterGteq record {}? (default ()) - If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are group_id, user_id or path.

filterLike record {}? (default ()) - If set, return records where the specifiied field is equal to the supplied value. Valid fields are group_id, user_id or path.

filterLt record {}? (default ()) - If set, return records where the specifiied field is less than the supplied value. Valid fields are group_id, user_id or path.

filterLteq record {}? (default ()) - If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are group_id, user_id or path.

groupId string? (default ()) - DEPRECATED: Group ID. If provided, will scope permissions to this group. Use filter[group_id] instead.

includeGroups boolean? (default ()) - If searching by user or group, also include user's permissions that are inherited from its groups?

Return Type

PermissionEntity[]|error - A list of Permissions objects.

getUsersUserIdGroups

Isolated FunctionRemote Function

function getUsersUserIdGroups(int userId, string? cursor, int? perPage, int? groupId) returns GroupUserEntity[]|error

List Group Users

Parameters

userId int - User ID. If provided, will return group_users of this user.

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

groupId int? (default ()) - Group ID. If provided, will return group_users of this group.

Return Type

GroupUserEntity[]|error - A list of GroupUsers objects.

getUsersUserIdAs2Keys

Isolated FunctionRemote Function

function getUsersUserIdAs2Keys(int userId, string? cursor, int? perPage) returns As2KeyEntity[]|error

List As2 Keys

Parameters

userId int - User ID. Provide a value of 0 to operate the current session's user.

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

Return Type

As2KeyEntity[]|error - A list of As2Keys objects.

postUsersUserIdAs2Keys

Isolated FunctionRemote Function

function postUsersUserIdAs2Keys(int userId, UserIdAs2KeysBody payload) returns As2KeyEntity|error

Create As2 Key

Parameters

userId int - User ID. Provide a value of 0 to operate the current session's user.

payload UserIdAs2KeysBody -

Return Type

As2KeyEntity|error - The As2Keys object.

getUsersUserIdApiKeys

Isolated FunctionRemote Function

function getUsersUserIdApiKeys(int userId, string? cursor, int? perPage, record {}? sortBy, record {}? filter, record {}? filterGt, record {}? filterGteq, record {}? filterLike, record {}? filterLt, record {}? filterLteq) returns ApiKeyEntity[]|error

List Api Keys

Parameters

userId int - User ID. Provide a value of 0 to operate the current session's user.

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

sortBy record {}? (default ()) - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are expires_at.

filter record {}? (default ()) - If set, return records where the specifiied field is equal to the supplied value. Valid fields are expires_at.

filterGt record {}? (default ()) - If set, return records where the specifiied field is greater than the supplied value. Valid fields are expires_at.

filterGteq record {}? (default ()) - If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are expires_at.

filterLike record {}? (default ()) - If set, return records where the specifiied field is equal to the supplied value. Valid fields are expires_at.

filterLt record {}? (default ()) - If set, return records where the specifiied field is less than the supplied value. Valid fields are expires_at.

filterLteq record {}? (default ()) - If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are expires_at.

Return Type

ApiKeyEntity[]|error - A list of ApiKeys objects.

postUsersUserIdApiKeys

Isolated FunctionRemote Function

function postUsersUserIdApiKeys(int userId, UserIdApiKeysBody payload) returns ApiKeyEntity|error

Create Api Key

Parameters

userId int - User ID. Provide a value of 0 to operate the current session's user.

payload UserIdApiKeysBody -

Return Type

ApiKeyEntity|error - The ApiKeys object.

getApps

Isolated FunctionRemote Function

function getApps(string? cursor, int? perPage, record {}? sortBy, record {}? filter, record {}? filterGt, record {}? filterGteq, record {}? filterLike, record {}? filterLt, record {}? filterLteq) returns AppEntity[]|error

List Apps

Parameters

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

sortBy record {}? (default ()) - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are name and app_type.

filter record {}? (default ()) - If set, return records where the specifiied field is equal to the supplied value. Valid fields are name and app_type.

filterGt record {}? (default ()) - If set, return records where the specifiied field is greater than the supplied value. Valid fields are name and app_type.

filterGteq record {}? (default ()) - If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are name and app_type.

filterLike record {}? (default ()) - If set, return records where the specifiied field is equal to the supplied value. Valid fields are name and app_type.

filterLt record {}? (default ()) - If set, return records where the specifiied field is less than the supplied value. Valid fields are name and app_type.

filterLteq record {}? (default ()) - If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are name and app_type.

Return Type

AppEntity[]|error - A list of Apps objects.

getAs2KeysId

Isolated FunctionRemote Function

function getAs2KeysId(int id) returns As2KeyEntity|error

Show As2 Key

Parameters

id int - As2 Key ID.

Return Type

As2KeyEntity|error - The As2Keys object.

deleteAs2KeysId

Isolated FunctionRemote Function

function deleteAs2KeysId(int id) returns Response|error

Delete As2 Key

Parameters

id int - As2 Key ID.

Return Type

Response|error - No body.

patchAs2KeysId

Isolated FunctionRemote Function

function patchAs2KeysId(int id, As2KeysIdBody payload) returns As2KeyEntity|error

Update As2 Key

Parameters

id int - As2 Key ID.

payload As2KeysIdBody -

Return Type

As2KeyEntity|error - The As2Keys object.

getAs2Keys

Isolated FunctionRemote Function

function getAs2Keys(int? userId, string? cursor, int? perPage) returns As2KeyEntity[]|error

List As2 Keys

Parameters

userId int? (default ()) - User ID. Provide a value of 0 to operate the current session's user.

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

Return Type

As2KeyEntity[]|error - A list of As2Keys objects.

postAs2Keys

Isolated FunctionRemote Function

function postAs2Keys(As2KeysBody payload) returns As2KeyEntity|error

Create As2 Key

Parameters

payload As2KeysBody -

Return Type

As2KeyEntity|error - The As2Keys object.

getAutomationsId

Isolated FunctionRemote Function

function getAutomationsId(int id) returns AutomationEntity|error

Show Automation

Parameters

id int - Automation ID.

Return Type

AutomationEntity|error - The Automations object.

deleteAutomationsId

Isolated FunctionRemote Function

function deleteAutomationsId(int id) returns Response|error

Delete Automation

Parameters

id int - Automation ID.

Return Type

Response|error - No body.

patchAutomationsId

Isolated FunctionRemote Function

function patchAutomationsId(int id, AutomationsIdBody payload) returns AutomationEntity|error

Update Automation

Parameters

id int - Automation ID.

payload AutomationsIdBody -

Return Type

AutomationEntity|error - The Automations object.

getAutomations

Isolated FunctionRemote Function

function getAutomations(string? cursor, int? perPage, record {}? sortBy, record {}? filter, record {}? filterGt, record {}? filterGteq, record {}? filterLike, record {}? filterLt, record {}? filterLteq, string? automation) returns AutomationEntity[]|error

List Automations

Parameters

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

sortBy record {}? (default ()) - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are automation.

filter record {}? (default ()) - If set, return records where the specifiied field is equal to the supplied value. Valid fields are automation.

filterGt record {}? (default ()) - If set, return records where the specifiied field is greater than the supplied value. Valid fields are automation.

filterGteq record {}? (default ()) - If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are automation.

filterLike record {}? (default ()) - If set, return records where the specifiied field is equal to the supplied value. Valid fields are automation.

filterLt record {}? (default ()) - If set, return records where the specifiied field is less than the supplied value. Valid fields are automation.

filterLteq record {}? (default ()) - If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are automation.

automation string? (default ()) - DEPRECATED: Type of automation to filter by. Use filter[automation] instead.

Return Type

AutomationEntity[]|error - A list of Automations objects.

postAutomations

Isolated FunctionRemote Function

function postAutomations(AutomationsBody payload) returns AutomationEntity|error

Create Automation

Parameters

payload AutomationsBody -

Return Type

AutomationEntity|error - The Automations object.

getBandwidthSnapshots

Isolated FunctionRemote Function

function getBandwidthSnapshots(string? cursor, int? perPage, record {}? sortBy, record {}? filter, record {}? filterGt, record {}? filterGteq, record {}? filterLike, record {}? filterLt, record {}? filterLteq) returns BandwidthSnapshotEntity[]|error

List Bandwidth Snapshots

Parameters

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

sortBy record {}? (default ()) - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are logged_at.

filter record {}? (default ()) - If set, return records where the specifiied field is equal to the supplied value. Valid fields are logged_at.

filterGt record {}? (default ()) - If set, return records where the specifiied field is greater than the supplied value. Valid fields are logged_at.

filterGteq record {}? (default ()) - If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are logged_at.

filterLike record {}? (default ()) - If set, return records where the specifiied field is equal to the supplied value. Valid fields are logged_at.

filterLt record {}? (default ()) - If set, return records where the specifiied field is less than the supplied value. Valid fields are logged_at.

filterLteq record {}? (default ()) - If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are logged_at.

Return Type

BandwidthSnapshotEntity[]|error - A list of BandwidthSnapshots objects.

postBehaviorsWebhookTest

Isolated FunctionRemote Function

function postBehaviorsWebhookTest(WebhookTestBody payload) returns StatusEntity|error

Test webhook.

Parameters

payload WebhookTestBody -

Return Type

StatusEntity|error - The Behaviors object.

getBehaviorsId

Isolated FunctionRemote Function

function getBehaviorsId(int id) returns BehaviorEntity|error

Show Behavior

Parameters

id int - Behavior ID.

Return Type

BehaviorEntity|error - The Behaviors object.

deleteBehaviorsId

Isolated FunctionRemote Function

function deleteBehaviorsId(int id) returns Response|error

Delete Behavior

Parameters

id int - Behavior ID.

Return Type

Response|error - No body.

patchBehaviorsId

Isolated FunctionRemote Function

function patchBehaviorsId(int id, BehaviorsIdBody payload) returns BehaviorEntity|error

Update Behavior

Parameters

id int - Behavior ID.

payload BehaviorsIdBody -

Return Type

BehaviorEntity|error - The Behaviors object.

getBehaviors

Isolated FunctionRemote Function

function getBehaviors(string? cursor, int? perPage, record {}? sortBy, record {}? filter, record {}? filterGt, record {}? filterGteq, record {}? filterLike, record {}? filterLt, record {}? filterLteq, string? behavior) returns BehaviorEntity[]|error

List Behaviors

Parameters

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

sortBy record {}? (default ()) - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are behavior.

filter record {}? (default ()) - If set, return records where the specifiied field is equal to the supplied value. Valid fields are behavior.

filterGt record {}? (default ()) - If set, return records where the specifiied field is greater than the supplied value. Valid fields are behavior.

filterGteq record {}? (default ()) - If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are behavior.

filterLike record {}? (default ()) - If set, return records where the specifiied field is equal to the supplied value. Valid fields are behavior.

filterLt record {}? (default ()) - If set, return records where the specifiied field is less than the supplied value. Valid fields are behavior.

filterLteq record {}? (default ()) - If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are behavior.

behavior string? (default ()) - If set, only shows folder behaviors matching this behavior type.

Return Type

BehaviorEntity[]|error - A list of Behaviors objects.

postBehaviors

Isolated FunctionRemote Function

function postBehaviors(BehaviorsBody payload) returns BehaviorEntity|error

Create Behavior

Parameters

payload BehaviorsBody -

Return Type

BehaviorEntity|error - The Behaviors object.

behaviorListForPath

Isolated FunctionRemote Function

function behaviorListForPath(string operationPath, string? cursor, int? perPage, record {}? sortBy, record {}? filter, record {}? filterGt, record {}? filterGteq, record {}? filterLike, record {}? filterLt, record {}? filterLteq, string? recursive, string? behavior) returns BehaviorEntity[]|error

List Behaviors by path

Parameters

operationPath string - Path to operate on.

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

sortBy record {}? (default ()) - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are behavior.

filter record {}? (default ()) - If set, return records where the specifiied field is equal to the supplied value. Valid fields are behavior.

filterGt record {}? (default ()) - If set, return records where the specifiied field is greater than the supplied value. Valid fields are behavior.

filterGteq record {}? (default ()) - If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are behavior.

filterLike record {}? (default ()) - If set, return records where the specifiied field is equal to the supplied value. Valid fields are behavior.

filterLt record {}? (default ()) - If set, return records where the specifiied field is less than the supplied value. Valid fields are behavior.

filterLteq record {}? (default ()) - If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are behavior.

recursive string? (default ()) - Show behaviors above this path?

behavior string? (default ()) - DEPRECATED: If set only shows folder behaviors matching this behavior type. Use filter[behavior] instead.

Return Type

BehaviorEntity[]|error - A list of Behaviors objects.

getBundlesId

Isolated FunctionRemote Function

function getBundlesId(int id) returns BundleEntity|error

Show Bundle

Parameters

id int - Bundle ID.

Return Type

BundleEntity|error - The Bundles object.

deleteBundlesId

Isolated FunctionRemote Function

function deleteBundlesId(int id) returns Response|error

Delete Bundle

Parameters

id int - Bundle ID.

Return Type

Response|error - No body.

patchBundlesId

Isolated FunctionRemote Function

function patchBundlesId(int id, BundlesIdBody payload) returns BundleEntity|error

Update Bundle

Parameters

id int - Bundle ID.

payload BundlesIdBody -

Return Type

BundleEntity|error - The Bundles object.

getBundles

Isolated FunctionRemote Function

function getBundles(int? userId, string? cursor, int? perPage, record {}? sortBy, record {}? filter, record {}? filterGt, record {}? filterGteq, record {}? filterLike, record {}? filterLt, record {}? filterLteq) returns BundleEntity[]|error

List Bundles

Parameters

userId int? (default ()) - User ID. Provide a value of 0 to operate the current session's user.

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

sortBy record {}? (default ()) - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are created_at and code.

filter record {}? (default ()) - If set, return records where the specifiied field is equal to the supplied value. Valid fields are created_at.

filterGt record {}? (default ()) - If set, return records where the specifiied field is greater than the supplied value. Valid fields are created_at.

filterGteq record {}? (default ()) - If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are created_at.

filterLike record {}? (default ()) - If set, return records where the specifiied field is equal to the supplied value. Valid fields are created_at.

filterLt record {}? (default ()) - If set, return records where the specifiied field is less than the supplied value. Valid fields are created_at.

filterLteq record {}? (default ()) - If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are created_at.

Return Type

BundleEntity[]|error - A list of Bundles objects.

postBundles

Isolated FunctionRemote Function

function postBundles(BundlesBody payload) returns BundleEntity|error

Create Bundle

Parameters

payload BundlesBody -

Return Type

BundleEntity|error - The Bundles object.

postBundlesIdShare

Isolated FunctionRemote Function

function postBundlesIdShare(int id, IdShareBody payload) returns Response|error

Send email(s) with a link to bundle

Parameters

id int - Bundle ID.

payload IdShareBody -

Return Type

Response|error - No body.

getBundleDownloads

Isolated FunctionRemote Function

function getBundleDownloads(string? cursor, int? perPage, record {}? sortBy, record {}? filter, record {}? filterGt, record {}? filterGteq, record {}? filterLike, record {}? filterLt, record {}? filterLteq, int? bundleId, int? bundleRegistrationId) returns BundleDownloadEntity[]|error

List Bundle Downloads

Parameters

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

sortBy record {}? (default ()) - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are created_at.

filter record {}? (default ()) - If set, return records where the specifiied field is equal to the supplied value. Valid fields are created_at.

filterGt record {}? (default ()) - If set, return records where the specifiied field is greater than the supplied value. Valid fields are created_at.

filterGteq record {}? (default ()) - If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are created_at.

filterLike record {}? (default ()) - If set, return records where the specifiied field is equal to the supplied value. Valid fields are created_at.

filterLt record {}? (default ()) - If set, return records where the specifiied field is less than the supplied value. Valid fields are created_at.

filterLteq record {}? (default ()) - If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are created_at.

bundleId int? (default ()) - Bundle ID

bundleRegistrationId int? (default ()) - BundleRegistration ID

Return Type

BundleDownloadEntity[]|error - A list of BundleDownloads objects.

getBundleRecipients

Isolated FunctionRemote Function

function getBundleRecipients(int bundleId, int? userId, string? cursor, int? perPage, record {}? sortBy, record {}? filter, record {}? filterGt, record {}? filterGteq, record {}? filterLike, record {}? filterLt, record {}? filterLteq) returns BundleRecipientEntity[]|error

List Bundle Recipients

Parameters

bundleId int - List recipients for the bundle with this ID.

userId int? (default ()) - User ID. Provide a value of 0 to operate the current session's user.

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

sortBy record {}? (default ()) - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are has_registrations.

filter record {}? (default ()) - If set, return records where the specifiied field is equal to the supplied value. Valid fields are has_registrations.

filterGt record {}? (default ()) - If set, return records where the specifiied field is greater than the supplied value. Valid fields are has_registrations.

filterGteq record {}? (default ()) - If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are has_registrations.

filterLike record {}? (default ()) - If set, return records where the specifiied field is equal to the supplied value. Valid fields are has_registrations.

filterLt record {}? (default ()) - If set, return records where the specifiied field is less than the supplied value. Valid fields are has_registrations.

filterLteq record {}? (default ()) - If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are has_registrations.

Return Type

BundleRecipientEntity[]|error - A list of BundleRecipients objects.

postBundleRecipients

Isolated FunctionRemote Function

function postBundleRecipients(BundleRecipientsBody payload) returns BundleRecipientEntity|error

Create Bundle Recipient

Parameters

payload BundleRecipientsBody -

Return Type

BundleRecipientEntity|error - The BundleRecipients object.

getBundleRegistrations

Isolated FunctionRemote Function

function getBundleRegistrations(int? userId, string? cursor, int? perPage, int? bundleId) returns BundleRegistrationEntity[]|error

List Bundle Registrations

Parameters

userId int? (default ()) - User ID. Provide a value of 0 to operate the current session's user.

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

bundleId int? (default ()) - ID of the associated Bundle

Return Type

BundleRegistrationEntity[]|error - A list of BundleRegistrations objects.

getClickwraps

Isolated FunctionRemote Function

function getClickwraps(string? cursor, int? perPage) returns ClickwrapEntity[]|error

List Clickwraps

Parameters

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

Return Type

ClickwrapEntity[]|error - A list of Clickwraps objects.

postClickwraps

Isolated FunctionRemote Function

function postClickwraps(ClickwrapsBody payload) returns ClickwrapEntity|error

Create Clickwrap

Parameters

payload ClickwrapsBody -

Return Type

ClickwrapEntity|error - The Clickwraps object.

getClickwrapsId

Isolated FunctionRemote Function

function getClickwrapsId(int id) returns ClickwrapEntity|error

Show Clickwrap

Parameters

id int - Clickwrap ID.

Return Type

ClickwrapEntity|error - The Clickwraps object.

deleteClickwrapsId

Isolated FunctionRemote Function

function deleteClickwrapsId(int id) returns Response|error

Delete Clickwrap

Parameters

id int - Clickwrap ID.

Return Type

Response|error - No body.

patchClickwrapsId

Isolated FunctionRemote Function

function patchClickwrapsId(int id, ClickwrapsIdBody payload) returns ClickwrapEntity|error

Update Clickwrap

Parameters

id int - Clickwrap ID.

payload ClickwrapsIdBody -

Return Type

ClickwrapEntity|error - The Clickwraps object.

getDnsRecords

Isolated FunctionRemote Function

function getDnsRecords(string? cursor, int? perPage) returns DnsRecordEntity[]|error

Show site DNS configuration.

Parameters

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

Return Type

DnsRecordEntity[]|error - A list of DnsRecords objects.

getExternalEvents

Isolated FunctionRemote Function

function getExternalEvents(string? cursor, int? perPage, record {}? sortBy, record {}? filter, record {}? filterGt, record {}? filterGteq, record {}? filterLike, record {}? filterLt, record {}? filterLteq) returns ExternalEventEntity[]|error

List External Events

Parameters

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

sortBy record {}? (default ()) - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are remote_server_type, event_type, created_at, status, site_id or folder_behavior_id.

filter record {}? (default ()) - If set, return records where the specifiied field is equal to the supplied value. Valid fields are created_at, event_type, remote_server_type, status or folder_behavior_id.

filterGt record {}? (default ()) - If set, return records where the specifiied field is greater than the supplied value. Valid fields are created_at, event_type, remote_server_type, status or folder_behavior_id.

filterGteq record {}? (default ()) - If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are created_at, event_type, remote_server_type, status or folder_behavior_id.

filterLike record {}? (default ()) - If set, return records where the specifiied field is equal to the supplied value. Valid fields are created_at, event_type, remote_server_type, status or folder_behavior_id.

filterLt record {}? (default ()) - If set, return records where the specifiied field is less than the supplied value. Valid fields are created_at, event_type, remote_server_type, status or folder_behavior_id.

filterLteq record {}? (default ()) - If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are created_at, event_type, remote_server_type, status or folder_behavior_id.

Return Type

ExternalEventEntity[]|error - A list of ExternalEvents objects.

postExternalEvents

Isolated FunctionRemote Function

function postExternalEvents(ExternalEventsBody payload) returns ExternalEventEntity|error

Create External Event

Parameters

payload ExternalEventsBody -

Return Type

ExternalEventEntity|error - The ExternalEvents object.

getExternalEventsId

Isolated FunctionRemote Function

function getExternalEventsId(int id) returns ExternalEventEntity|error

Show External Event

Parameters

id int - External Event ID.

Return Type

ExternalEventEntity|error - The ExternalEvents object.

fileDownload

Isolated FunctionRemote Function

function fileDownload(string filePath, string? action, string? previewSize, boolean? withPreviews, boolean? withPriorityColor) returns FileEntity|error

Download file

Parameters

filePath string - Path to operate on.

action string? (default ()) - Can be blank, redirect or stat. If set to stat, we will return file information but without a download URL, and without logging a download. If set to redirect we will serve a 302 redirect directly to the file. This is used for integrations with Zapier, and is not recommended for most integrations.

previewSize string? (default ()) - Request a preview size. Can be small (default), large, xlarge, or pdf.

withPreviews boolean? (default ()) - Include file preview information?

withPriorityColor boolean? (default ()) - Include file priority color information?

Return Type

FileEntity|error - The Files object.

postFilesPath

Isolated FunctionRemote Function

function postFilesPath(string filePath, FilesFilepathBody payload) returns FileEntity|error

Upload file

Parameters

filePath string - Path to operate on.

payload FilesFilepathBody -

Return Type

FileEntity|error - The Files object.

deleteFilesPath

Isolated FunctionRemote Function

function deleteFilesPath(string filePath, boolean? recursive) returns Response|error

Delete file/folder

Parameters

filePath string - Path to operate on.

recursive boolean? (default ()) - If true, will recursively delete folers. Otherwise, will error on non-empty folders.

Return Type

Response|error - No body.

patchFilesPath

Isolated FunctionRemote Function

function patchFilesPath(string filePath, FilesFilepathBody3 payload) returns FileEntity|error

Update file/folder metadata

Parameters

filePath string - Path to operate on.

payload FilesFilepathBody3 -

Return Type

FileEntity|error - The Files object.

fileActionMetadata

Isolated FunctionRemote Function

function fileActionMetadata(string filePath, string? previewSize, boolean? withPreviews, boolean? withPriorityColor) returns FileEntity|error

Return metadata for file/folder

Parameters

filePath string - Path to operate on.

previewSize string? (default ()) - Request a preview size. Can be small (default), large, xlarge, or pdf.

withPreviews boolean? (default ()) - Include file preview information?

withPriorityColor boolean? (default ()) - Include file priority color information?

Return Type

FileEntity|error - The FileActions object.

fileActionCopy

Isolated FunctionRemote Function

function fileActionCopy(string filePath, CopyFilepathBody payload) returns FileActionEntity|error

Copy file/folder

Parameters

filePath string - Path to operate on.

payload CopyFilepathBody -

Return Type

FileActionEntity|error - The FileActions object.

fileActionMove

Isolated FunctionRemote Function

function fileActionMove(string filePath, MoveFilepathBody payload) returns FileActionEntity|error

Move file/folder

Parameters

filePath string - Path to operate on.

payload MoveFilepathBody -

Return Type

FileActionEntity|error - The FileActions object.

fileActionBeginUpload

Isolated FunctionRemote Function

function fileActionBeginUpload(string filePath, BeginUploadFilepathBody payload) returns FileUploadPartEntity[]|error

Begin file upload

Parameters

filePath string - Path to operate on.

payload BeginUploadFilepathBody -

Return Type

FileUploadPartEntity[]|error - The FileActions object.

deleteFileCommentsId

Isolated FunctionRemote Function

function deleteFileCommentsId(int id) returns Response|error

Delete File Comment

Parameters

id int - File Comment ID.

Return Type

Response|error - No body.

patchFileCommentsId

Isolated FunctionRemote Function

function patchFileCommentsId(int id, FileCommentsIdBody payload) returns FileCommentEntity|error

Update File Comment

Parameters

id int - File Comment ID.

payload FileCommentsIdBody -

Return Type

FileCommentEntity|error - The FileComments object.

postFileComments

Isolated FunctionRemote Function

function postFileComments(FileCommentsBody payload) returns FileCommentEntity|error

Create File Comment

Parameters

payload FileCommentsBody -

Return Type

FileCommentEntity|error - The FileComments object.

fileCommentListForPath

Isolated FunctionRemote Function

function fileCommentListForPath(string filePath, string? cursor, int? perPage) returns FileCommentEntity[]|error

List File Comments by path

Parameters

filePath string - Path to operate on.

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

Return Type

FileCommentEntity[]|error - A list of FileComments objects.

deleteFileCommentReactionsId

Isolated FunctionRemote Function

function deleteFileCommentReactionsId(int id) returns Response|error

Delete File Comment Reaction

Parameters

id int - File Comment Reaction ID.

Return Type

Response|error - No body.

postFileCommentReactions

Isolated FunctionRemote Function

function postFileCommentReactions(FileCommentReactionsBody payload) returns FileCommentReactionEntity|error

Create File Comment Reaction

Parameters

payload FileCommentReactionsBody -

Return Type

FileCommentReactionEntity|error - The FileCommentReactions object.

getFileMigrationsId

Isolated FunctionRemote Function

function getFileMigrationsId(int id) returns FileMigrationEntity|error

Show File Migration

Parameters

id int - File Migration ID.

Return Type

FileMigrationEntity|error - The FileMigrations object.

folderListForPath

Isolated FunctionRemote Function

function folderListForPath(string folderPath, string? cursor, int? perPage, string? filter, string? previewSize, string? search, boolean? searchAll, boolean? withPreviews, boolean? withPriorityColor) returns FileEntity[]|error

List Folders by path

Parameters

folderPath string - Path to operate on.

cursor string? (default ()) - Send cursor to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

filter string? (default ()) - If specified, will filter folders/files list by this string. Wildcards of * and ? are acceptable here.

previewSize string? (default ()) - Request a preview size. Can be small (default), large, xlarge, or pdf.

search string? (default ()) - If search_all is true, provide the search string here. Otherwise, this parameter acts like an alias of filter.

searchAll boolean? (default ()) - Search entire site?

withPreviews boolean? (default ()) - Include file previews?

withPriorityColor boolean? (default ()) - Include file priority color information?

Return Type

FileEntity[]|error - A list of Folders objects.

postFoldersPath

Isolated FunctionRemote Function

function postFoldersPath(string folderPath) returns FileEntity|error

Create folder

Parameters

folderPath string - Path to operate on.

Return Type

FileEntity|error - The Folders object.

getFormFieldSets

Isolated FunctionRemote Function

function getFormFieldSets(int? userId, string? cursor, int? perPage) returns FormFieldSetEntity[]|error

List Form Field Sets

Parameters

userId int? (default ()) - User ID. Provide a value of 0 to operate the current session's user.

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

Return Type

FormFieldSetEntity[]|error - A list of FormFieldSets objects.

postFormFieldSets

Isolated FunctionRemote Function

function postFormFieldSets(PostFormFieldSets payload) returns FormFieldSetEntity|error

Create Form Field Set

Parameters

payload PostFormFieldSets -

Return Type

FormFieldSetEntity|error - The FormFieldSets object.

getFormFieldSetsId

Isolated FunctionRemote Function

function getFormFieldSetsId(int id) returns FormFieldSetEntity|error

Show Form Field Set

Parameters

id int - Form Field Set ID.

Return Type

FormFieldSetEntity|error - The FormFieldSets object.

deleteFormFieldSetsId

Isolated FunctionRemote Function

function deleteFormFieldSetsId(int id) returns Response|error

Delete Form Field Set

Parameters

id int - Form Field Set ID.

Return Type

Response|error - No body.

patchFormFieldSetsId

Isolated FunctionRemote Function

function patchFormFieldSetsId(int id, PatchFormFieldSets payload) returns FormFieldSetEntity|error

Update Form Field Set

Parameters

id int - Form Field Set ID.

payload PatchFormFieldSets -

Return Type

FormFieldSetEntity|error - The FormFieldSets object.

getGroupsGroupIdUsers

Isolated FunctionRemote Function

function getGroupsGroupIdUsers(int groupId, int? userId, string? cursor, int? perPage) returns GroupUserEntity[]|error

List Group Users

Parameters

groupId int - Group ID. If provided, will return group_users of this group.

userId int? (default ()) - User ID. If provided, will return group_users of this user.

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

Return Type

GroupUserEntity[]|error - A list of GroupUsers objects.

postGroupsGroupIdUsers

Isolated FunctionRemote Function

function postGroupsGroupIdUsers(int groupId, GroupIdUsersBody payload) returns UserEntity|error

Create User

Parameters

groupId int - Group ID to associate this user with.

payload GroupIdUsersBody -

Return Type

UserEntity|error - The Users object.

getGroupsGroupIdPermissions

Isolated FunctionRemote Function

function getGroupsGroupIdPermissions(string groupId, string? cursor, int? perPage, record {}? sortBy, record {}? filter, record {}? filterGt, record {}? filterGteq, record {}? filterLike, record {}? filterLt, record {}? filterLteq, string? userId, boolean? includeGroups) returns PermissionEntity[]|error

List Permissions

Parameters

groupId string - DEPRECATED: Group ID. If provided, will scope permissions to this group. Use filter[group_id] instead.

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

sortBy record {}? (default ()) - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are group_id, path, user_id or permission.

filter record {}? (default ()) - If set, return records where the specifiied field is equal to the supplied value. Valid fields are group_id, user_id or path.

filterGt record {}? (default ()) - If set, return records where the specifiied field is greater than the supplied value. Valid fields are group_id, user_id or path.

filterGteq record {}? (default ()) - If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are group_id, user_id or path.

filterLike record {}? (default ()) - If set, return records where the specifiied field is equal to the supplied value. Valid fields are group_id, user_id or path.

filterLt record {}? (default ()) - If set, return records where the specifiied field is less than the supplied value. Valid fields are group_id, user_id or path.

filterLteq record {}? (default ()) - If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are group_id, user_id or path.

userId string? (default ()) - DEPRECATED: User ID. If provided, will scope permissions to this user. Use filter[user_id] instead.

includeGroups boolean? (default ()) - If searching by user or group, also include user's permissions that are inherited from its groups?

Return Type

PermissionEntity[]|error - A list of Permissions objects.

deleteGroupsGroupIdMembershipsUserId

Isolated FunctionRemote Function

function deleteGroupsGroupIdMembershipsUserId(int groupId, int userId) returns Response|error

Delete Group User

Parameters

groupId int - Group ID from which to remove user.

userId int - User ID to remove from group.

Return Type

Response|error - No body.

patchGroupsGroupIdMembershipsUserId

Isolated FunctionRemote Function

function patchGroupsGroupIdMembershipsUserId(int groupId, int userId, MembershipsUserIdBody payload) returns GroupUserEntity|error

Update Group User

Parameters

groupId int - Group ID to add user to.

userId int - User ID to add to group.

payload MembershipsUserIdBody -

Return Type

GroupUserEntity|error - The GroupUsers object.

getGroupsId

Isolated FunctionRemote Function

function getGroupsId(int id) returns GroupEntity|error

Show Group

Parameters

id int - Group ID.

Return Type

GroupEntity|error - The Groups object.

deleteGroupsId

Isolated FunctionRemote Function

function deleteGroupsId(int id) returns Response|error

Delete Group

Parameters

id int - Group ID.

Return Type

Response|error - No body.

patchGroupsId

Isolated FunctionRemote Function

function patchGroupsId(int id, GroupsIdBody payload) returns GroupEntity|error

Update Group

Parameters

id int - Group ID.

payload GroupsIdBody -

Return Type

GroupEntity|error - The Groups object.

getGroups

Isolated FunctionRemote Function

function getGroups(string? cursor, int? perPage, record {}? sortBy, record {}? filter, record {}? filterGt, record {}? filterGteq, record {}? filterLike, record {}? filterLt, record {}? filterLteq, string? ids) returns GroupEntity[]|error

List Groups

Parameters

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

sortBy record {}? (default ()) - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are name.

filter record {}? (default ()) - If set, return records where the specifiied field is equal to the supplied value. Valid fields are name.

filterGt record {}? (default ()) - If set, return records where the specifiied field is greater than the supplied value. Valid fields are name.

filterGteq record {}? (default ()) - If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are name.

filterLike record {}? (default ()) - If set, return records where the specifiied field is equal to the supplied value. Valid fields are name.

filterLt record {}? (default ()) - If set, return records where the specifiied field is less than the supplied value. Valid fields are name.

filterLteq record {}? (default ()) - If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are name.

ids string? (default ()) - Comma-separated list of group ids to include in results.

Return Type

GroupEntity[]|error - A list of Groups objects.

postGroups

Isolated FunctionRemote Function

function postGroups(GroupsBody payload) returns GroupEntity|error

Create Group

Parameters

payload GroupsBody -

Return Type

GroupEntity|error - The Groups object.

deleteGroupUsersId

Isolated FunctionRemote Function

function deleteGroupUsersId(int id, int groupId, int userId) returns Response|error

Delete Group User

Parameters

id int - Group User ID.

groupId int - Group ID from which to remove user.

userId int - User ID to remove from group.

Return Type

Response|error - No body.

patchGroupUsersId

Isolated FunctionRemote Function

function patchGroupUsersId(int id, GroupUsersIdBody payload) returns GroupUserEntity|error

Update Group User

Parameters

id int - Group User ID.

payload GroupUsersIdBody -

Return Type

GroupUserEntity|error - The GroupUsers object.

getGroupUsers

Isolated FunctionRemote Function

function getGroupUsers(int? userId, string? cursor, int? perPage, int? groupId) returns GroupUserEntity[]|error

List Group Users

Parameters

userId int? (default ()) - User ID. If provided, will return group_users of this user.

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

groupId int? (default ()) - Group ID. If provided, will return group_users of this group.

Return Type

GroupUserEntity[]|error - A list of GroupUsers objects.

postGroupUsers

Isolated FunctionRemote Function

function postGroupUsers(GroupUsersBody payload) returns GroupUserEntity|error

Create Group User

Parameters

payload GroupUsersBody -

Return Type

GroupUserEntity|error - The GroupUsers object.

historyListForFile

Isolated FunctionRemote Function

function historyListForFile(string filePath, string? startAt, string? endAt, string? display, string? cursor, int? perPage, record {}? sortBy) returns ActionEntity[]|error

List history for specific file.

Parameters

filePath string - Path to operate on.

startAt string? (default ()) - Leave blank or set to a date/time to filter earlier entries.

endAt string? (default ()) - Leave blank or set to a date/time to filter later entries.

display string? (default ()) - Display format. Leave blank or set to full or parent.

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

sortBy record {}? (default ()) - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are user_id and created_at.

Return Type

ActionEntity[]|error - A list of History objects.

historyListForFolder

Isolated FunctionRemote Function

function historyListForFolder(string folderPath, string? startAt, string? endAt, string? display, string? cursor, int? perPage, record {}? sortBy) returns ActionEntity[]|error

List history for specific folder.

Parameters

folderPath string - Path to operate on.

startAt string? (default ()) - Leave blank or set to a date/time to filter earlier entries.

endAt string? (default ()) - Leave blank or set to a date/time to filter later entries.

display string? (default ()) - Display format. Leave blank or set to full or parent.

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

sortBy record {}? (default ()) - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are user_id and created_at.

Return Type

ActionEntity[]|error - A list of History objects.

historyListForUser

Isolated FunctionRemote Function

function historyListForUser(int userId, string? startAt, string? endAt, string? display, string? cursor, int? perPage, record {}? sortBy) returns ActionEntity[]|error

List history for specific user.

Parameters

userId int - User ID.

startAt string? (default ()) - Leave blank or set to a date/time to filter earlier entries.

endAt string? (default ()) - Leave blank or set to a date/time to filter later entries.

display string? (default ()) - Display format. Leave blank or set to full or parent.

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

sortBy record {}? (default ()) - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are user_id and created_at.

Return Type

ActionEntity[]|error - A list of History objects.

historyListLogins

Isolated FunctionRemote Function

function historyListLogins(string? startAt, string? endAt, string? display, string? cursor, int? perPage, record {}? sortBy) returns ActionEntity[]|error

List site login history.

Parameters

startAt string? (default ()) - Leave blank or set to a date/time to filter earlier entries.

endAt string? (default ()) - Leave blank or set to a date/time to filter later entries.

display string? (default ()) - Display format. Leave blank or set to full or parent.

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

sortBy record {}? (default ()) - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are user_id and created_at.

Return Type

ActionEntity[]|error - A list of History objects.

historyList

Isolated FunctionRemote Function

function historyList(string? startAt, string? endAt, string? display, string? cursor, int? perPage, record {}? sortBy, record {}? filter, record {}? filterGt, record {}? filterGteq, record {}? filterLike, record {}? filterLt, record {}? filterLteq) returns ActionEntity[]|error

List site full action history.

Parameters

startAt string? (default ()) - Leave blank or set to a date/time to filter earlier entries.

endAt string? (default ()) - Leave blank or set to a date/time to filter later entries.

display string? (default ()) - Display format. Leave blank or set to full or parent.

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

sortBy record {}? (default ()) - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are path, folder, user_id or created_at.

filter record {}? (default ()) - If set, return records where the specifiied field is equal to the supplied value. Valid fields are user_id, folder or path.

filterGt record {}? (default ()) - If set, return records where the specifiied field is greater than the supplied value. Valid fields are user_id, folder or path.

filterGteq record {}? (default ()) - If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are user_id, folder or path.

filterLike record {}? (default ()) - If set, return records where the specifiied field is equal to the supplied value. Valid fields are user_id, folder or path.

filterLt record {}? (default ()) - If set, return records where the specifiied field is less than the supplied value. Valid fields are user_id, folder or path.

filterLteq record {}? (default ()) - If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are user_id, folder or path.

Return Type

ActionEntity[]|error - A list of History objects.

postHistoryExports

Isolated FunctionRemote Function

function postHistoryExports(HistoryExportsBody payload) returns HistoryExportEntity|error

Create History Export

Parameters

payload HistoryExportsBody -

Return Type

HistoryExportEntity|error - The HistoryExports object.

getHistoryExportsId

Isolated FunctionRemote Function

function getHistoryExportsId(int id) returns HistoryExportEntity|error

Show History Export

Parameters

id int - History Export ID.

Return Type

HistoryExportEntity|error - The HistoryExports object.

getHistoryExportResults

Isolated FunctionRemote Function

function getHistoryExportResults(int historyExportId, int? userId, string? cursor, int? perPage) returns HistoryExportResultEntity[]|error

List History Export Results

Parameters

historyExportId int - ID of the associated history export.

userId int? (default ()) - User ID. Provide a value of 0 to operate the current session's user.

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

Return Type

HistoryExportResultEntity[]|error - A list of HistoryExportResults objects.

getInboxRecipients

Isolated FunctionRemote Function

function getInboxRecipients(int inboxId, int? userId, string? cursor, int? perPage, record {}? sortBy, record {}? filter, record {}? filterGt, record {}? filterGteq, record {}? filterLike, record {}? filterLt, record {}? filterLteq) returns InboxRecipientEntity[]|error

List Inbox Recipients

Parameters

inboxId int - List recipients for the inbox with this ID.

userId int? (default ()) - User ID. Provide a value of 0 to operate the current session's user.

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

sortBy record {}? (default ()) - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are has_registrations.

filter record {}? (default ()) - If set, return records where the specifiied field is equal to the supplied value. Valid fields are has_registrations.

filterGt record {}? (default ()) - If set, return records where the specifiied field is greater than the supplied value. Valid fields are has_registrations.

filterGteq record {}? (default ()) - If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are has_registrations.

filterLike record {}? (default ()) - If set, return records where the specifiied field is equal to the supplied value. Valid fields are has_registrations.

filterLt record {}? (default ()) - If set, return records where the specifiied field is less than the supplied value. Valid fields are has_registrations.

filterLteq record {}? (default ()) - If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are has_registrations.

Return Type

InboxRecipientEntity[]|error - A list of InboxRecipients objects.

postInboxRecipients

Isolated FunctionRemote Function

function postInboxRecipients(InboxRecipientsBody payload) returns InboxRecipientEntity|error

Create Inbox Recipient

Parameters

payload InboxRecipientsBody -

Return Type

InboxRecipientEntity|error - The InboxRecipients object.

getInboxRegistrations

Isolated FunctionRemote Function

function getInboxRegistrations(int folderBehaviorId, string? cursor, int? perPage) returns InboxRegistrationEntity[]|error

List Inbox Registrations

Parameters

folderBehaviorId int - ID of the associated Inbox.

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

Return Type

InboxRegistrationEntity[]|error - A list of InboxRegistrations objects.

getInboxUploads

Isolated FunctionRemote Function

function getInboxUploads(string? cursor, int? perPage, record {}? sortBy, record {}? filter, record {}? filterGt, record {}? filterGteq, record {}? filterLike, record {}? filterLt, record {}? filterLteq, int? inboxRegistrationId, int? inboxId) returns InboxUploadEntity[]|error

List Inbox Uploads

Parameters

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

sortBy record {}? (default ()) - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are created_at.

filter record {}? (default ()) - If set, return records where the specifiied field is equal to the supplied value. Valid fields are created_at.

filterGt record {}? (default ()) - If set, return records where the specifiied field is greater than the supplied value. Valid fields are created_at.

filterGteq record {}? (default ()) - If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are created_at.

filterLike record {}? (default ()) - If set, return records where the specifiied field is equal to the supplied value. Valid fields are created_at.

filterLt record {}? (default ()) - If set, return records where the specifiied field is less than the supplied value. Valid fields are created_at.

filterLteq record {}? (default ()) - If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are created_at.

inboxRegistrationId int? (default ()) - InboxRegistration ID

inboxId int? (default ()) - Inbox ID

Return Type

InboxUploadEntity[]|error - A list of InboxUploads objects.

getInvoicesId

Isolated FunctionRemote Function

function getInvoicesId(int id) returns AccountLineItemEntity|error

Show Invoice

Parameters

id int - Invoice ID.

Return Type

AccountLineItemEntity|error - The Invoices object.

getInvoices

Isolated FunctionRemote Function

function getInvoices(string? cursor, int? perPage) returns AccountLineItemEntity[]|error

List Invoices

Parameters

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

Return Type

AccountLineItemEntity[]|error - A list of Invoices objects.

getIpAddressesReserved

Isolated FunctionRemote Function

function getIpAddressesReserved(string? cursor, int? perPage) returns PublicIpAddressEntity[]|error

List all possible public IP addresses

Parameters

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

Return Type

PublicIpAddressEntity[]|error - A list of IpAddresses objects.

getIpAddresses

Isolated FunctionRemote Function

function getIpAddresses(string? cursor, int? perPage) returns IpAddressEntity[]|error

List IP Addresses associated with the current site

Parameters

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

Return Type

IpAddressEntity[]|error - A list of IpAddresses objects.

lockListForPath

Isolated FunctionRemote Function

function lockListForPath(string lockPath, string? cursor, int? perPage, boolean? includeChildren) returns LockEntity[]|error

List Locks by path

Parameters

lockPath string - Path to operate on.

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

includeChildren boolean? (default ()) - Include locks from children objects?

Return Type

LockEntity[]|error - A list of Locks objects.

postLocksPath

Isolated FunctionRemote Function

function postLocksPath(string lockPath, LocksLockpathBody payload) returns LockEntity|error

Create Lock

Parameters

lockPath string - Path

payload LocksLockpathBody -

Return Type

LockEntity|error - The Locks object.

deleteLocksPath

Isolated FunctionRemote Function

function deleteLocksPath(string lockPath, string token) returns Response|error

Delete Lock

Parameters

lockPath string - Path

token string - Lock token

Return Type

Response|error - No body.

getMessagesId

Isolated FunctionRemote Function

function getMessagesId(int id) returns MessageEntity|error

Show Message

Parameters

id int - Message ID.

Return Type

MessageEntity|error - The Messages object.

deleteMessagesId

Isolated FunctionRemote Function

function deleteMessagesId(int id) returns Response|error

Delete Message

Parameters

id int - Message ID.

Return Type

Response|error - No body.

patchMessagesId

Isolated FunctionRemote Function

function patchMessagesId(int id, MessagesIdBody payload) returns MessageEntity|error

Update Message

Parameters

id int - Message ID.

payload MessagesIdBody -

Return Type

MessageEntity|error - The Messages object.

getMessages

Isolated FunctionRemote Function

function getMessages(int projectId, int? userId, string? cursor, int? perPage) returns MessageEntity[]|error

List Messages

Parameters

projectId int - Project for which to return messages.

userId int? (default ()) - User ID. Provide a value of 0 to operate the current session's user.

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

Return Type

MessageEntity[]|error - A list of Messages objects.

postMessages

Isolated FunctionRemote Function

function postMessages(MessagesBody payload) returns MessageEntity|error

Create Message

Parameters

payload MessagesBody -

Return Type

MessageEntity|error - The Messages object.

getMessageCommentsId

Isolated FunctionRemote Function

function getMessageCommentsId(int id) returns MessageCommentEntity|error

Show Message Comment

Parameters

id int - Message Comment ID.

Return Type

MessageCommentEntity|error - The MessageComments object.

deleteMessageCommentsId

Isolated FunctionRemote Function

function deleteMessageCommentsId(int id) returns Response|error

Delete Message Comment

Parameters

id int - Message Comment ID.

Return Type

Response|error - No body.

patchMessageCommentsId

Isolated FunctionRemote Function

function patchMessageCommentsId(int id, MessageCommentsIdBody payload) returns MessageCommentEntity|error

Update Message Comment

Parameters

id int - Message Comment ID.

payload MessageCommentsIdBody -

Return Type

MessageCommentEntity|error - The MessageComments object.

getMessageComments

Isolated FunctionRemote Function

function getMessageComments(int messageId, int? userId, string? cursor, int? perPage) returns MessageCommentEntity[]|error

List Message Comments

Parameters

messageId int - Message comment to return comments for.

userId int? (default ()) - User ID. Provide a value of 0 to operate the current session's user.

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

Return Type

MessageCommentEntity[]|error - A list of MessageComments objects.

postMessageComments

Isolated FunctionRemote Function

function postMessageComments(MessageCommentsBody payload) returns MessageCommentEntity|error

Create Message Comment

Parameters

payload MessageCommentsBody -

Return Type

MessageCommentEntity|error - The MessageComments object.

getMessageCommentReactionsId

Isolated FunctionRemote Function

function getMessageCommentReactionsId(int id) returns MessageCommentReactionEntity|error

Show Message Comment Reaction

Parameters

id int - Message Comment Reaction ID.

Return Type

MessageCommentReactionEntity|error - The MessageCommentReactions object.

deleteMessageCommentReactionsId

Isolated FunctionRemote Function

function deleteMessageCommentReactionsId(int id) returns Response|error

Delete Message Comment Reaction

Parameters

id int - Message Comment Reaction ID.

Return Type

Response|error - No body.

getMessageCommentReactions

Isolated FunctionRemote Function

function getMessageCommentReactions(int messageCommentId, int? userId, string? cursor, int? perPage) returns MessageCommentReactionEntity[]|error

List Message Comment Reactions

Parameters

messageCommentId int - Message comment to return reactions for.

userId int? (default ()) - User ID. Provide a value of 0 to operate the current session's user.

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

Return Type

MessageCommentReactionEntity[]|error - A list of MessageCommentReactions objects.

postMessageCommentReactions

Isolated FunctionRemote Function

function postMessageCommentReactions(MessageCommentReactionsBody payload) returns MessageCommentReactionEntity|error

Create Message Comment Reaction

Parameters

payload MessageCommentReactionsBody -

Return Type

MessageCommentReactionEntity|error - The MessageCommentReactions object.

getMessageReactionsId

Isolated FunctionRemote Function

function getMessageReactionsId(int id) returns MessageReactionEntity|error

Show Message Reaction

Parameters

id int - Message Reaction ID.

Return Type

MessageReactionEntity|error - The MessageReactions object.

deleteMessageReactionsId

Isolated FunctionRemote Function

function deleteMessageReactionsId(int id) returns Response|error

Delete Message Reaction

Parameters

id int - Message Reaction ID.

Return Type

Response|error - No body.

getMessageReactions

Isolated FunctionRemote Function

function getMessageReactions(int messageId, int? userId, string? cursor, int? perPage) returns MessageReactionEntity[]|error

List Message Reactions

Parameters

messageId int - Message to return reactions for.

userId int? (default ()) - User ID. Provide a value of 0 to operate the current session's user.

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

Return Type

MessageReactionEntity[]|error - A list of MessageReactions objects.

postMessageReactions

Isolated FunctionRemote Function

function postMessageReactions(MessageReactionsBody payload) returns MessageReactionEntity|error

Create Message Reaction

Parameters

payload MessageReactionsBody -

Return Type

MessageReactionEntity|error - The MessageReactions object.

getNotificationsId

Isolated FunctionRemote Function

function getNotificationsId(int id) returns NotificationEntity|error

Show Notification

Parameters

id int - Notification ID.

Return Type

NotificationEntity|error - The Notifications object.

deleteNotificationsId

Isolated FunctionRemote Function

function deleteNotificationsId(int id) returns Response|error

Delete Notification

Parameters

id int - Notification ID.

Return Type

Response|error - No body.

patchNotificationsId

Isolated FunctionRemote Function

function patchNotificationsId(int id, NotificationsIdBody payload) returns NotificationEntity|error

Update Notification

Parameters

id int - Notification ID.

payload NotificationsIdBody -

Return Type

NotificationEntity|error - The Notifications object.

getNotifications

Isolated FunctionRemote Function

function getNotifications(int? userId, string? cursor, int? perPage, record {}? sortBy, record {}? filter, record {}? filterGt, record {}? filterGteq, record {}? filterLike, record {}? filterLt, record {}? filterLteq, int? groupId, string? path, boolean? includeAncestors) returns NotificationEntity[]|error

List Notifications

Parameters

userId int? (default ()) - DEPRECATED: Show notifications for this User ID. Use filter[user_id] instead.

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

sortBy record {}? (default ()) - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are path, user_id or group_id.

filter record {}? (default ()) - If set, return records where the specifiied field is equal to the supplied value. Valid fields are user_id, group_id or path.

filterGt record {}? (default ()) - If set, return records where the specifiied field is greater than the supplied value. Valid fields are user_id, group_id or path.

filterGteq record {}? (default ()) - If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are user_id, group_id or path.

filterLike record {}? (default ()) - If set, return records where the specifiied field is equal to the supplied value. Valid fields are user_id, group_id or path.

filterLt record {}? (default ()) - If set, return records where the specifiied field is less than the supplied value. Valid fields are user_id, group_id or path.

filterLteq record {}? (default ()) - If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are user_id, group_id or path.

groupId int? (default ()) - DEPRECATED: Show notifications for this Group ID. Use filter[group_id] instead.

path string? (default ()) - Show notifications for this Path.

includeAncestors boolean? (default ()) - If include_ancestors is true and path is specified, include notifications for any parent paths. Ignored if path is not specified.

Return Type

NotificationEntity[]|error - A list of Notifications objects.

postNotifications

Isolated FunctionRemote Function

function postNotifications(NotificationsBody payload) returns NotificationEntity|error

Create Notification

Parameters

payload NotificationsBody -

Return Type

NotificationEntity|error - The Notifications object.

getPaymentsId

Isolated FunctionRemote Function

function getPaymentsId(int id) returns AccountLineItemEntity|error

Show Payment

Parameters

id int - Payment ID.

Return Type

AccountLineItemEntity|error - The Payments object.

getPayments

Isolated FunctionRemote Function

function getPayments(string? cursor, int? perPage) returns AccountLineItemEntity[]|error

List Payments

Parameters

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

Return Type

AccountLineItemEntity[]|error - A list of Payments objects.

deletePermissionsId

Isolated FunctionRemote Function

function deletePermissionsId(int id) returns Response|error

Delete Permission

Parameters

id int - Permission ID.

Return Type

Response|error - No body.

getPermissions

Isolated FunctionRemote Function

function getPermissions(string? cursor, int? perPage, record {}? sortBy, record {}? filter, record {}? filterGt, record {}? filterGteq, record {}? filterLike, record {}? filterLt, record {}? filterLteq, string? groupId, string? userId, boolean? includeGroups) returns PermissionEntity[]|error

List Permissions

Parameters

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

sortBy record {}? (default ()) - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are group_id, path, user_id or permission.

filter record {}? (default ()) - If set, return records where the specifiied field is equal to the supplied value. Valid fields are group_id, user_id or path.

filterGt record {}? (default ()) - If set, return records where the specifiied field is greater than the supplied value. Valid fields are group_id, user_id or path.

filterGteq record {}? (default ()) - If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are group_id, user_id or path.

filterLike record {}? (default ()) - If set, return records where the specifiied field is equal to the supplied value. Valid fields are group_id, user_id or path.

filterLt record {}? (default ()) - If set, return records where the specifiied field is less than the supplied value. Valid fields are group_id, user_id or path.

filterLteq record {}? (default ()) - If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are group_id, user_id or path.

groupId string? (default ()) - DEPRECATED: Group ID. If provided, will scope permissions to this group. Use filter[group_id] instead.

userId string? (default ()) - DEPRECATED: User ID. If provided, will scope permissions to this user. Use filter[user_id] instead.

includeGroups boolean? (default ()) - If searching by user or group, also include user's permissions that are inherited from its groups?

Return Type

PermissionEntity[]|error - A list of Permissions objects.

postPermissions

Isolated FunctionRemote Function

function postPermissions(PermissionsBody payload) returns PermissionEntity|error

Create Permission

Parameters

payload PermissionsBody -

Return Type

PermissionEntity|error - The Permissions object.

getProjectsId

Isolated FunctionRemote Function

function getProjectsId(int id) returns ProjectEntity|error

Show Project

Parameters

id int - Project ID.

Return Type

ProjectEntity|error - The Projects object.

deleteProjectsId

Isolated FunctionRemote Function

function deleteProjectsId(int id) returns Response|error

Delete Project

Parameters

id int - Project ID.

Return Type

Response|error - No body.

patchProjectsId

Isolated FunctionRemote Function

function patchProjectsId(int id, ProjectsIdBody payload) returns ProjectEntity|error

Update Project

Parameters

id int - Project ID.

payload ProjectsIdBody -

Return Type

ProjectEntity|error - The Projects object.

getProjects

Isolated FunctionRemote Function

function getProjects(string? cursor, int? perPage) returns ProjectEntity[]|error

List Projects

Parameters

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

Return Type

ProjectEntity[]|error - A list of Projects objects.

postProjects

Isolated FunctionRemote Function

function postProjects(ProjectsBody payload) returns ProjectEntity|error

Create Project

Parameters

payload ProjectsBody -

Return Type

ProjectEntity|error - The Projects object.

getPublicKeysId

Isolated FunctionRemote Function

function getPublicKeysId(int id) returns PublicKeyEntity|error

Show Public Key

Parameters

id int - Public Key ID.

Return Type

PublicKeyEntity|error - The PublicKeys object.

deletePublicKeysId

Isolated FunctionRemote Function

function deletePublicKeysId(int id) returns Response|error

Delete Public Key

Parameters

id int - Public Key ID.

Return Type

Response|error - No body.

patchPublicKeysId

Isolated FunctionRemote Function

function patchPublicKeysId(int id, PublicKeysIdBody payload) returns PublicKeyEntity|error

Update Public Key

Parameters

id int - Public Key ID.

payload PublicKeysIdBody -

Return Type

PublicKeyEntity|error - The PublicKeys object.

getPublicKeys

Isolated FunctionRemote Function

function getPublicKeys(int? userId, string? cursor, int? perPage) returns PublicKeyEntity[]|error

List Public Keys

Parameters

userId int? (default ()) - User ID. Provide a value of 0 to operate the current session's user.

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

Return Type

PublicKeyEntity[]|error - A list of PublicKeys objects.

postPublicKeys

Isolated FunctionRemote Function

function postPublicKeys(PublicKeysBody payload) returns PublicKeyEntity|error

Create Public Key

Parameters

payload PublicKeysBody -

Return Type

PublicKeyEntity|error - The PublicKeys object.

getRemoteServers

Isolated FunctionRemote Function

function getRemoteServers(string? cursor, int? perPage) returns RemoteServerEntity[]|error

List Remote Servers

Parameters

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

Return Type

RemoteServerEntity[]|error - A list of RemoteServers objects.

postRemoteServers

Isolated FunctionRemote Function

function postRemoteServers(RemoteServersBody payload) returns RemoteServerEntity|error

Create Remote Server

Parameters

payload RemoteServersBody -

Return Type

RemoteServerEntity|error - The RemoteServers object.

getRemoteServersId

Isolated FunctionRemote Function

function getRemoteServersId(int id) returns RemoteServerEntity|error

Show Remote Server

Parameters

id int - Remote Server ID.

Return Type

RemoteServerEntity|error - The RemoteServers object.

deleteRemoteServersId

Isolated FunctionRemote Function

function deleteRemoteServersId(int id) returns Response|error

Delete Remote Server

Parameters

id int - Remote Server ID.

Return Type

Response|error - No body.

patchRemoteServersId

Isolated FunctionRemote Function

function patchRemoteServersId(int id, RemoteServersIdBody payload) returns RemoteServerEntity|error

Update Remote Server

Parameters

id int - Remote Server ID.

payload RemoteServersIdBody -

Return Type

RemoteServerEntity|error - The RemoteServers object.

deleteRequestsId

Isolated FunctionRemote Function

function deleteRequestsId(int id) returns Response|error

Delete Request

Parameters

id int - Request ID.

Return Type

Response|error - No body.

getRequests

Isolated FunctionRemote Function

function getRequests(string? cursor, int? perPage, record {}? sortBy, boolean? mine, string? requestPath) returns RequestEntity[]|error

List Requests

Parameters

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

sortBy record {}? (default ()) - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are destination.

mine boolean? (default ()) - Only show requests of the current user? (Defaults to true if current user is not a site admin.)

requestPath string? (default ()) - Path to show requests for. If omitted, shows all paths. Send / to represent the root directory.

Return Type

RequestEntity[]|error - A list of Requests objects.

postRequests

Isolated FunctionRemote Function

function postRequests(RequestsBody payload) returns RequestEntity|error

Create Request

Parameters

payload RequestsBody -

Return Type

RequestEntity|error - The Requests object.

getRequestsFoldersPath

Isolated FunctionRemote Function

function getRequestsFoldersPath(string folderPath, string? cursor, int? perPage, record {}? sortBy, boolean? mine) returns RequestEntity[]|error

List Requests

Parameters

folderPath string - Path to show requests for. If omitted, shows all paths. Send / to represent the root directory.

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

sortBy record {}? (default ()) - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are destination.

mine boolean? (default ()) - Only show requests of the current user? (Defaults to true if current user is not a site admin.)

Return Type

RequestEntity[]|error - A list of Requests objects.

postSessions

Isolated FunctionRemote Function

function postSessions(SessionsBody payload) returns SessionEntity|error

Create user session (log in)

Parameters

payload SessionsBody -

Return Type

SessionEntity|error - The Sessions object.

deleteSessions

Isolated FunctionRemote Function

function deleteSessions() returns Response|error

Delete user session (log out)

Return Type

Response|error - No body.

getSettingsChanges

Isolated FunctionRemote Function

function getSettingsChanges(string? cursor, int? perPage, record {}? sortBy, record {}? filter, record {}? filterGt, record {}? filterGteq, record {}? filterLike, record {}? filterLt, record {}? filterLteq) returns SettingsChangeEntity[]|error

List Settings Changes

Parameters

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

sortBy record {}? (default ()) - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are api_key_id, created_at or user_id.

filter record {}? (default ()) - If set, return records where the specifiied field is equal to the supplied value. Valid fields are api_key_id and user_id.

filterGt record {}? (default ()) - If set, return records where the specifiied field is greater than the supplied value. Valid fields are api_key_id and user_id.

filterGteq record {}? (default ()) - If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are api_key_id and user_id.

filterLike record {}? (default ()) - If set, return records where the specifiied field is equal to the supplied value. Valid fields are api_key_id and user_id.

filterLt record {}? (default ()) - If set, return records where the specifiied field is less than the supplied value. Valid fields are api_key_id and user_id.

filterLteq record {}? (default ()) - If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are api_key_id and user_id.

Return Type

SettingsChangeEntity[]|error - A list of SettingsChanges objects.

getSsoStrategiesId

Isolated FunctionRemote Function

function getSsoStrategiesId(int id) returns SsoStrategyEntity|error

Show Sso Strategy

Parameters

id int - Sso Strategy ID.

Return Type

SsoStrategyEntity|error - The SsoStrategies object.

getSsoStrategies

Isolated FunctionRemote Function

function getSsoStrategies(string? cursor, int? perPage) returns SsoStrategyEntity[]|error

List Sso Strategies

Parameters

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

Return Type

SsoStrategyEntity[]|error - A list of SsoStrategies objects.

getStylesPath

Isolated FunctionRemote Function

function getStylesPath(string stylePath) returns StyleEntity|error

Show Style

Parameters

stylePath string - Style path.

Return Type

StyleEntity|error - The Styles object.

deleteStylesPath

Isolated FunctionRemote Function

function deleteStylesPath(string stylePath) returns Response|error

Delete Style

Parameters

stylePath string - Style path.

Return Type

Response|error - No body.

patchStylesPath

Isolated FunctionRemote Function

function patchStylesPath(string stylePath, StylesStylepathBody payload) returns StyleEntity|error

Update Style

Parameters

stylePath string - Style path.

payload StylesStylepathBody -

Return Type

StyleEntity|error - The Styles object.

getSyncJobs

Isolated FunctionRemote Function

function getSyncJobs(string? cursor, int? perPage) returns SyncJobEntity[]|error

List Sync Jobs

Parameters

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

Return Type

SyncJobEntity[]|error - A list of SyncJobs objects.

getUsageSnapshots

Isolated FunctionRemote Function

function getUsageSnapshots(string? cursor, int? perPage) returns UsageSnapshotEntity[]|error

List Usage Snapshots

Parameters

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

Return Type

UsageSnapshotEntity[]|error - A list of UsageSnapshots objects.

getUsageDailySnapshots

Isolated FunctionRemote Function

function getUsageDailySnapshots(string? cursor, int? perPage, record {}? sortBy, record {}? filter, record {}? filterGt, record {}? filterGteq, record {}? filterLike, record {}? filterLt, record {}? filterLteq) returns UsageDailySnapshotEntity[]|error

List Usage Daily Snapshots

Parameters

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

sortBy record {}? (default ()) - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are date and usage_snapshot_id.

filter record {}? (default ()) - If set, return records where the specifiied field is equal to the supplied value. Valid fields are date and usage_snapshot_id.

filterGt record {}? (default ()) - If set, return records where the specifiied field is greater than the supplied value. Valid fields are date and usage_snapshot_id.

filterGteq record {}? (default ()) - If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are date and usage_snapshot_id.

filterLike record {}? (default ()) - If set, return records where the specifiied field is equal to the supplied value. Valid fields are date and usage_snapshot_id.

filterLt record {}? (default ()) - If set, return records where the specifiied field is less than the supplied value. Valid fields are date and usage_snapshot_id.

filterLteq record {}? (default ()) - If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are date and usage_snapshot_id.

Return Type

UsageDailySnapshotEntity[]|error - A list of UsageDailySnapshots objects.

getUserCipherUses

Isolated FunctionRemote Function

function getUserCipherUses(int? userId, string? cursor, int? perPage) returns UserCipherUseEntity[]|error

List User Cipher Uses

Parameters

userId int? (default ()) - User ID. Provide a value of 0 to operate the current session's user.

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

Return Type

UserCipherUseEntity[]|error - A list of UserCipherUses objects.

getUserRequests

Isolated FunctionRemote Function

function getUserRequests(string? cursor, int? perPage) returns UserRequestEntity[]|error

List User Requests

Parameters

cursor string? (default ()) - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.

perPage int? (default ()) - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

Return Type

UserRequestEntity[]|error - A list of UserRequests objects.

postUserRequests

Isolated FunctionRemote Function

function postUserRequests(UserRequestsBody payload) returns UserRequestEntity|error

Create User Request

Parameters

payload UserRequestsBody -

Return Type

UserRequestEntity|error - The UserRequests object.

getUserRequestsId

Isolated FunctionRemote Function

function getUserRequestsId(int id) returns UserRequestEntity|error

Show User Request

Parameters

id int - User Request ID.

Return Type

UserRequestEntity|error - The UserRequests object.

deleteUserRequestsId

Isolated FunctionRemote Function

function deleteUserRequestsId(int id) returns Response|error

Delete User Request

Parameters

id int - User Request ID.

Return Type

Response|error - No body.

postWebhookTests

Isolated FunctionRemote Function

function postWebhookTests(WebhookTestsBody payload) returns WebhookTestEntity|error

Create Webhook Test

Parameters

payload WebhookTestsBody -

Return Type

WebhookTestEntity|error - The WebhookTests object.

Records

files.com: AccountLineItemEntity

List Payments

Fields

id int? - Line item Id

amount decimal? - Line item amount

balance decimal? - Line item balance

created_at string? - Line item created at

currency string? - Line item currency

download_uri string? - Line item download uri

invoice_line_items InvoiceLineItemEntity? - Associated invoice line items

method string? - Line item payment method

payment_line_items PaymentLineItemEntity? - Associated payment line items

payment_reversed_at string? - Date/time payment was reversed if applicable

payment_type string? - Type of payment if applicable

site_name string? - Site name this line item is for

'type string? - Type of line item, either payment or invoice

updated_at string? - Line item updated at

files.com: ActionEntity

List site full action history.

Fields

id int? - Action ID

path string? - Path

when string? - Action occurrence date/time

destination string? - The destination path for this action, if applicable

display string? - Friendly displayed output

ip string? - IP Address that performed this action

'source string? - The source path for this action, if applicable

targets string[]? - Targets

user_id int? - User ID

username string? - Username

action string? - Type of action

failure_type string? - Failure type. If action was a user login or session failure, why did it fail?

interface string? - Interface on which this action occurred.

files.com: ActionNotificationExportEntity

Show Action Notification Export

Fields

id int? - History Export ID

export_version string? - Version of the underlying records for the export.

start_at string? - Start date/time of export range.

end_at string? - End date/time of export range.

status string? - Status of export. Valid values: building, ready, or failed

query_path string? - Return notifications that were triggered by actions on this specific path.

query_folder string? - Return notifications that were triggered by actions in this folder.

query_message string? - Error message associated with the request, if any.

query_request_method string? - The HTTP request method used by the webhook.

query_request_url string? - The target webhook URL.

query_status string? - The HTTP status returned from the server in response to the webhook request.

query_success boolean? - true if the webhook request succeeded (i.e. returned a 200 or 204 response status). false otherwise.

results_url string? - If status is ready, this will be a URL where all the results can be downloaded at once as a CSV.

files.com: ActionNotificationExportResultEntity

List Action Notification Export Results

Fields

id int? - Notification ID

created_at int? - When the notification was sent.

status int? - HTTP status code returned in the webhook response.

message string? - A message indicating the overall status of the webhook notification.

success boolean? - true if the webhook succeeded by receiving a 200 or 204 response.

request_headers string? - A JSON-encoded string with headers that were sent with the webhook.

request_method string? - The HTTP verb used to perform the webhook.

request_url string? - The webhook request URL.

path string? - The path to the actual file that triggered this notification.

folder string? - The folder associated with the triggering action for this notification.

files.com: ActionNotificationExportsBody

Fields

user_id int? - User ID. Provide a value of 0 to operate the current session's user.

start_at string? - Start date/time of export range.

end_at string? - End date/time of export range.

query_message string? - Error message associated with the request, if any.

query_request_method string? - The HTTP request method used by the webhook.

query_request_url string? - The target webhook URL.

query_status string? - The HTTP status returned from the server in response to the webhook request.

query_success boolean? - true if the webhook request succeeded (i.e. returned a 200 or 204 response status). false otherwise.

query_path string? - Return notifications that were triggered by actions on this specific path.

query_folder string? - Return notifications that were triggered by actions in this folder.

files.com: ActionNotificationExportsBody1

Fields

user_id int? - User ID. Provide a value of 0 to operate the current session's user.

start_at string? - Start date/time of export range.

end_at string? - End date/time of export range.

query_message string? - Error message associated with the request, if any.

query_request_method string? - The HTTP request method used by the webhook.

query_request_url string? - The target webhook URL.

query_status string? - The HTTP status returned from the server in response to the webhook request.

query_success boolean? - true if the webhook request succeeded (i.e. returned a 200 or 204 response status). false otherwise.

query_path string? - Return notifications that were triggered by actions on this specific path.

query_folder string? - Return notifications that were triggered by actions in this folder.

files.com: ActionNotificationExportsBody2

Fields

user_id int? - User ID. Provide a value of 0 to operate the current session's user.

start_at string? - Start date/time of export range.

end_at string? - End date/time of export range.

query_message string? - Error message associated with the request, if any.

query_request_method string? - The HTTP request method used by the webhook.

query_request_url string? - The target webhook URL.

query_status string? - The HTTP status returned from the server in response to the webhook request.

query_success boolean? - true if the webhook request succeeded (i.e. returned a 200 or 204 response status). false otherwise.

query_path string? - Return notifications that were triggered by actions on this specific path.

query_folder string? - Return notifications that were triggered by actions in this folder.

files.com: ApiKeyBody

Fields

expires_at string? - API Key expiration date

name string? - Internal name for the API Key. For your use.

permission_set string? - Permissions for this API Key. Keys with the desktop_app permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges. If you have ideas for permission sets, please let us know.

files.com: ApiKeyBody1

Fields

expires_at string? - API Key expiration date

name string? - Internal name for the API Key. For your use.

permission_set string? - Permissions for this API Key. Keys with the desktop_app permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges. If you have ideas for permission sets, please let us know.

files.com: ApiKeyBody2

Fields

expires_at string? - API Key expiration date

name string? - Internal name for the API Key. For your use.

permission_set string? - Permissions for this API Key. Keys with the desktop_app permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges. If you have ideas for permission sets, please let us know.

files.com: ApiKeyEntity

List Api Keys

Fields

id int? - API Key ID

descriptive_label string? - Unique label that describes this API key. Useful for external systems where you may have API keys from multiple accounts and want a human-readable label for each key.

created_at string? - Time which API Key was created

expires_at string? - API Key expiration date

'key string? - API Key actual key string

last_use_at string? - API Key last used - note this value is only updated once per 3 hour period, so the 'actual' time of last use may be up to 3 hours later than this timestamp.

name string? - Internal name for the API Key. For your use.

path string? - Folder path restriction for this api key.

permission_set string? - Permissions for this API Key. Keys with the desktop_app permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges. If you have ideas for permission sets, please let us know.

platform string? - If this API key represents a Desktop app, what platform was it created on?

user_id int? - User ID for the owner of this API Key. May be blank for Site-wide API Keys.

files.com: ApiKeysBody

Fields

user_id int? - User ID. Provide a value of 0 to operate the current session's user.

name string? - Internal name for the API Key. For your use.

expires_at string? - API Key expiration date

permission_set string? - Permissions for this API Key. Keys with the desktop_app permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges. If you have ideas for permission sets, please let us know.

path string? - Folder path restriction for this api key.

files.com: ApiKeysBody1

Fields

user_id int? - User ID. Provide a value of 0 to operate the current session's user.

name string? - Internal name for the API Key. For your use.

expires_at string? - API Key expiration date

permission_set string? - Permissions for this API Key. Keys with the desktop_app permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges. If you have ideas for permission sets, please let us know.

path string? - Folder path restriction for this api key.

files.com: ApiKeysBody2

Fields

user_id int? - User ID. Provide a value of 0 to operate the current session's user.

name string? - Internal name for the API Key. For your use.

expires_at string? - API Key expiration date

permission_set string? - Permissions for this API Key. Keys with the desktop_app permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges. If you have ideas for permission sets, please let us know.

path string? - Folder path restriction for this api key.

files.com: ApiKeysConfig

Closed record

Provides API key configurations needed when communicating with a remote HTTP endpoint.

Fields

xFilesapiKey string - API Key - supports user-based or site-wide API keys

files.com: ApiKeysIdBody

Fields

name string? - Internal name for the API Key. For your use.

expires_at string? - API Key expiration date

permission_set string? - Permissions for this API Key. Keys with the desktop_app permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges. If you have ideas for permission sets, please let us know.

files.com: ApiKeysIdBody1

Fields

name string? - Internal name for the API Key. For your use.

expires_at string? - API Key expiration date

permission_set string? - Permissions for this API Key. Keys with the desktop_app permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges. If you have ideas for permission sets, please let us know.

files.com: ApiKeysIdBody2

Fields

name string? - Internal name for the API Key. For your use.

expires_at string? - API Key expiration date

permission_set string? - Permissions for this API Key. Keys with the desktop_app permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges. If you have ideas for permission sets, please let us know.

files.com: AppEntity

List Apps

Fields

name string? - Name of the App

extended_description string? - Long form description of the App

short_description string? - Short description of the App

documentation_links string? - Collection of named links to documentation

icon_url string? - App icon

logo_url string? - Full size logo for the App

screenshot_list_urls string? - Screenshots of the App

logo_thumbnail_url string? - Logo thumbnail for the App

sso_strategy_type string? - Associated SSO Strategy type, if any

remote_server_type string? - Associated Remote Server type, if any

folder_behavior_type string? - Associated Folder Behavior type, if any

external_homepage_url string? - Link to external homepage

marketing_youtube_url string? - Marketing video page

tutorial_youtube_url string? - Tutorial video page

app_type string? - The type of the App

featured boolean? - Is featured on the App listing?

files.com: As2KeyEntity

List As2 Keys

Fields

id int? - AS2 Key ID

as2_partnership_name string? - AS2 Partnership Name

created_at string? - AS2 Key created at date/time

fingerprint string? - Public key fingerprint

files.com: As2KeysBody

Fields

user_id int? - User ID. Provide a value of 0 to operate the current session's user.

as2_partnership_name string - AS2 Partnership Name

public_key string - Actual contents of Public key.

files.com: As2KeysBody1

Fields

user_id int? - User ID. Provide a value of 0 to operate the current session's user.

as2_partnership_name string - AS2 Partnership Name

public_key string - Actual contents of Public key.

files.com: As2KeysBody2

Fields

user_id int? - User ID. Provide a value of 0 to operate the current session's user.

as2_partnership_name string - AS2 Partnership Name

public_key string - Actual contents of Public key.

files.com: As2KeysIdBody

Fields

as2_partnership_name string - AS2 Partnership Name

files.com: As2KeysIdBody1

Fields

as2_partnership_name string - AS2 Partnership Name

files.com: As2KeysIdBody2

Fields

as2_partnership_name string - AS2 Partnership Name

files.com: AutoEntity

Auto fields.

Fields

dynamic record {}? - Dynamic properties

files.com: AutomationEntity

List Automations

Fields

id int? - Automation ID

automation string? - Automation type

trigger string? - How this automation is triggered to run. One of: realtime, daily, custom_schedule, webhook, email, or action.

interval string? - If trigger is daily, this specifies how often to run this automation. One of: day, week, week_end, month, month_end, quarter, quarter_end, year, year_end

schedule record {}? - If trigger is custom_schedule, Custom schedule description for when the automation should be run.

'source string? - Source Path

destinations string? - Destination Path

destination_replace_from string? - If set, this string in the destination path will be replaced with the value in destination_replace_to.

destination_replace_to string? - If set, this string will replace the value destination_replace_from in the destination filename. You can use special patterns here.

path string? - Path on which this Automation runs. Supports globs.

user_id int? - User ID of the Automation's creator.

user_ids int[]? - IDs of Users for the Automation (i.e. who to Request File from)

group_ids int[]? - IDs of Groups for the Automation (i.e. who to Request File from)

webhook_url string? - If trigger is webhook, this is the URL of the webhook to trigger the Automation.

trigger_actions string? - If trigger is action, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, copy

trigger_action_path string? - If trigger is action, this is the path to watch for the specified trigger actions.

value record {}? - A Hash of attributes specific to the automation type.

files.com: AutomationsBody

Fields

automation string - Automation type

'source string? - Source Path

destination string? - DEPRECATED: Destination Path. Use destinations instead.

destinations string[]? - A list of String destination paths or Hash of folder_path and optional file_path.

destination_replace_from string? - If set, this string in the destination path will be replaced with the value in destination_replace_to.

destination_replace_to string? - If set, this string will replace the value destination_replace_from in the destination filename. You can use special patterns here.

interval string? - How often to run this automation? One of: day, week, week_end, month, month_end, quarter, quarter_end, year, year_end

path string? - Path on which this Automation runs. Supports globs.

user_ids string? - A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.

group_ids string? - A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.

schedule record {}? - Custom schedule for running this automation.

trigger string? - How this automation is triggered to run. One of: realtime, daily, custom_schedule, webhook, email, or action.

trigger_actions string[]? - If trigger is action, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, copy

trigger_action_path string? - If trigger is action, this is the path to watch for the specified trigger actions.

value record {}? - A Hash of attributes specific to the automation type.

files.com: AutomationsBody1

Fields

automation string - Automation type

'source string? - Source Path

destination string? - DEPRECATED: Destination Path. Use destinations instead.

destinations string[]? - A list of String destination paths or Hash of folder_path and optional file_path.

destination_replace_from string? - If set, this string in the destination path will be replaced with the value in destination_replace_to.

destination_replace_to string? - If set, this string will replace the value destination_replace_from in the destination filename. You can use special patterns here.

interval string? - How often to run this automation? One of: day, week, week_end, month, month_end, quarter, quarter_end, year, year_end

path string? - Path on which this Automation runs. Supports globs.

user_ids string? - A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.

group_ids string? - A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.

schedule record {}? - Custom schedule for running this automation.

trigger string? - How this automation is triggered to run. One of: realtime, daily, custom_schedule, webhook, email, or action.

trigger_actions string[]? - If trigger is action, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, copy

trigger_action_path string? - If trigger is action, this is the path to watch for the specified trigger actions.

value record {}? - A Hash of attributes specific to the automation type.

files.com: AutomationsBody2

Fields

automation string - Automation type

'source string? - Source Path

destination string? - DEPRECATED: Destination Path. Use destinations instead.

destinations string[]? - A list of String destination paths or Hash of folder_path and optional file_path.

destination_replace_from string? - If set, this string in the destination path will be replaced with the value in destination_replace_to.

destination_replace_to string? - If set, this string will replace the value destination_replace_from in the destination filename. You can use special patterns here.

interval string? - How often to run this automation? One of: day, week, week_end, month, month_end, quarter, quarter_end, year, year_end

path string? - Path on which this Automation runs. Supports globs.

user_ids string? - A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.

group_ids string? - A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.

schedule record {}? - Custom schedule for running this automation.

trigger string? - How this automation is triggered to run. One of: realtime, daily, custom_schedule, webhook, email, or action.

trigger_actions string[]? - If trigger is action, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, copy

trigger_action_path string? - If trigger is action, this is the path to watch for the specified trigger actions.

value record {}? - A Hash of attributes specific to the automation type.

files.com: AutomationsIdBody

Fields

automation string - Automation type

'source string? - Source Path

destination string? - DEPRECATED: Destination Path. Use destinations instead.

destinations string[]? - A list of String destination paths or Hash of folder_path and optional file_path.

destination_replace_from string? - If set, this string in the destination path will be replaced with the value in destination_replace_to.

destination_replace_to string? - If set, this string will replace the value destination_replace_from in the destination filename. You can use special patterns here.

interval string? - How often to run this automation? One of: day, week, week_end, month, month_end, quarter, quarter_end, year, year_end

path string? - Path on which this Automation runs. Supports globs.

user_ids string? - A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.

group_ids string? - A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.

schedule record {}? - Custom schedule for running this automation.

trigger string? - How this automation is triggered to run. One of: realtime, daily, custom_schedule, webhook, email, or action.

trigger_actions string[]? - If trigger is action, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, copy

trigger_action_path string? - If trigger is action, this is the path to watch for the specified trigger actions.

value record {}? - A Hash of attributes specific to the automation type.

files.com: AutomationsIdBody1

Fields

automation string - Automation type

'source string? - Source Path

destination string? - DEPRECATED: Destination Path. Use destinations instead.

destinations string[]? - A list of String destination paths or Hash of folder_path and optional file_path.

destination_replace_from string? - If set, this string in the destination path will be replaced with the value in destination_replace_to.

destination_replace_to string? - If set, this string will replace the value destination_replace_from in the destination filename. You can use special patterns here.

interval string? - How often to run this automation? One of: day, week, week_end, month, month_end, quarter, quarter_end, year, year_end

path string? - Path on which this Automation runs. Supports globs.

user_ids string? - A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.

group_ids string? - A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.

schedule record {}? - Custom schedule for running this automation.

trigger string? - How this automation is triggered to run. One of: realtime, daily, custom_schedule, webhook, email, or action.

trigger_actions string[]? - If trigger is action, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, copy

trigger_action_path string? - If trigger is action, this is the path to watch for the specified trigger actions.

value record {}? - A Hash of attributes specific to the automation type.

files.com: AutomationsIdBody2

Fields

automation string - Automation type

'source string? - Source Path

destination string? - DEPRECATED: Destination Path. Use destinations instead.

destinations string[]? - A list of String destination paths or Hash of folder_path and optional file_path.

destination_replace_from string? - If set, this string in the destination path will be replaced with the value in destination_replace_to.

destination_replace_to string? - If set, this string will replace the value destination_replace_from in the destination filename. You can use special patterns here.

interval string? - How often to run this automation? One of: day, week, week_end, month, month_end, quarter, quarter_end, year, year_end

path string? - Path on which this Automation runs. Supports globs.

user_ids string? - A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.

group_ids string? - A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.

schedule record {}? - Custom schedule for running this automation.

trigger string? - How this automation is triggered to run. One of: realtime, daily, custom_schedule, webhook, email, or action.

trigger_actions string[]? - If trigger is action, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, copy

trigger_action_path string? - If trigger is action, this is the path to watch for the specified trigger actions.

value record {}? - A Hash of attributes specific to the automation type.

files.com: BandwidthSnapshotEntity

List Bandwidth Snapshots

Fields

id int? - Site bandwidth ID

bytes_received decimal? - Site bandwidth report bytes received

bytes_sent decimal? - Site bandwidth report bytes sent

sync_bytes_received decimal? - Site sync bandwidth report bytes received

sync_bytes_sent decimal? - Site sync bandwidth report bytes sent

requests_get decimal? - Site bandwidth report get requests

requests_put decimal? - Site bandwidth report put requests

requests_other decimal? - Site bandwidth report other requests

logged_at string? - Time the site bandwidth report was logged

created_at string? - Site bandwidth report created at date/time

updated_at string? - The last time this site bandwidth report was updated

files.com: BeginUploadFilepathBody

Fields

mkdir_parents boolean? - Create parent directories if they do not exist?

part int? - Part if uploading a part.

parts int? - How many parts to fetch?

ref string? -

restart int? - File byte offset to restart from.

with_rename boolean? - Allow file rename instead of overwrite?

files.com: BeginUploadFilepathBody1

Fields

mkdir_parents boolean? - Create parent directories if they do not exist?

part int? - Part if uploading a part.

parts int? - How many parts to fetch?

ref string? -

restart int? - File byte offset to restart from.

with_rename boolean? - Allow file rename instead of overwrite?

files.com: BeginUploadFilepathBody2

Fields

mkdir_parents boolean? - Create parent directories if they do not exist?

part int? - Part if uploading a part.

parts int? - How many parts to fetch?

ref string? -

restart int? - File byte offset to restart from.

with_rename boolean? - Allow file rename instead of overwrite?

files.com: BehaviorEntity

List Behaviors

Fields

id int? - Folder behavior ID

path string? - Folder path

attachment_url string? - URL for attached file

behavior string? - Behavior type.

value record {}? - Settings for this behavior. See the section above for an example value to provide here. Formatting is different for each Behavior type. May be sent as nested JSON or a single JSON-encoded string. If using XML encoding for the API call, this data must be sent as a JSON-encoded string.

files.com: BehaviorsBody

Fields

value string? - The value of the folder behavior. Can be a integer, array, or hash depending on the type of folder behavior. See The Behavior Types section for example values for each type of behavior.

attachment_file string? - Certain behaviors may require a file, for instance, the "watermark" behavior requires a watermark image

path string - Folder behaviors path.

behavior string - Behavior type.

files.com: BehaviorsBody1

Fields

value string? - The value of the folder behavior. Can be a integer, array, or hash depending on the type of folder behavior. See The Behavior Types section for example values for each type of behavior.

attachment_file string? - Certain behaviors may require a file, for instance, the "watermark" behavior requires a watermark image

path string - Folder behaviors path.

behavior string - Behavior type.

files.com: BehaviorsBody2

Fields

value string? - The value of the folder behavior. Can be a integer, array, or hash depending on the type of folder behavior. See The Behavior Types section for example values for each type of behavior.

attachment_file string? - Certain behaviors may require a file, for instance, the "watermark" behavior requires a watermark image

path string - Folder behaviors path.

behavior string - Behavior type.

files.com: BehaviorsIdBody

Fields

value string? - The value of the folder behavior. Can be a integer, array, or hash depending on the type of folder behavior. See The Behavior Types section for example values for each type of behavior.

attachment_file string? - Certain behaviors may require a file, for instance, the "watermark" behavior requires a watermark image

behavior string? - Behavior type.

path string? - Folder behaviors path.

files.com: BehaviorsIdBody1

Fields

value string? - The value of the folder behavior. Can be a integer, array, or hash depending on the type of folder behavior. See The Behavior Types section for example values for each type of behavior.

attachment_file string? - Certain behaviors may require a file, for instance, the "watermark" behavior requires a watermark image

behavior string? - Behavior type.

path string? - Folder behaviors path.

files.com: BehaviorsIdBody2

Fields

value string? - The value of the folder behavior. Can be a integer, array, or hash depending on the type of folder behavior. See The Behavior Types section for example values for each type of behavior.

attachment_file string? - Certain behaviors may require a file, for instance, the "watermark" behavior requires a watermark image

behavior string? - Behavior type.

path string? - Folder behaviors path.

files.com: BundleDownloadEntity

List Bundle Downloads

Fields

bundle_registration BundleRegistrationEntity? - List Bundle Registrations

download_method string? - Download method (file or full_zip)

path string? - Download path

created_at string? - Download date/time

files.com: BundleEntity

Create Bundle

Fields

code string? - Bundle code. This code forms the end part of the Public URL.

url string? - Public URL of Share Link

description string? - Public description

password_protected boolean? - Is this bundle password protected?

preview_only boolean? - Restrict users to previewing files only?

require_registration boolean? - Show a registration page that captures the downloader's name and email address?

require_share_recipient boolean? - Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?

clickwrap_body string? - Legal text that must be agreed to prior to accessing Bundle.

form_field_set FormFieldSetEntity? - Create Form Field Set

id int? - Bundle ID

created_at string? - Bundle created at date/time

expires_at string? - Bundle expiration date/time

max_uses int? - Maximum number of times bundle can be accessed

note string? - Bundle internal note

user_id int? - Bundle creator user ID

username string? - Bundle creator username

clickwrap_id int? - ID of the clickwrap to use with this bundle.

inbox_id int? - ID of the associated inbox, if available.

has_inbox boolean? - Does this bundle have an associated inbox?

paths string[]? - A list of paths in this bundle

files.com: BundleRecipientEntity

List Bundle Recipients

Fields

company string? - The recipient's company.

name string? - The recipient's name.

note string? - A note sent to the recipient with the bundle.

recipient string? - The recipient's email address.

sent_at string? - When the Bundle was shared with this recipient.

files.com: BundleRecipientsBody

Fields

user_id int? - User ID. Provide a value of 0 to operate the current session's user.

bundle_id int - Bundle to share.

recipient string - Email addresses to share this bundle with.

name string? - Name of recipient.

company string? - Company of recipient.

note string? - Note to include in email.

share_after_create boolean? - Set to true to share the link with the recipient upon creation.

files.com: BundleRecipientsBody1

Fields

user_id int? - User ID. Provide a value of 0 to operate the current session's user.

bundle_id int - Bundle to share.

recipient string - Email addresses to share this bundle with.

name string? - Name of recipient.

company string? - Company of recipient.

note string? - Note to include in email.

share_after_create boolean? - Set to true to share the link with the recipient upon creation.

files.com: BundleRecipientsBody2

Fields

user_id int? - User ID. Provide a value of 0 to operate the current session's user.

bundle_id int - Bundle to share.

recipient string - Email addresses to share this bundle with.

name string? - Name of recipient.

company string? - Company of recipient.

note string? - Note to include in email.

share_after_create boolean? - Set to true to share the link with the recipient upon creation.

files.com: BundleRegistrationEntity

List Bundle Registrations

Fields

code string? - Registration cookie code

name string? - Registrant name

company string? - Registrant company name

email string? - Registrant email address

ip string? - Registrant IP Address

inbox_code string? - InboxRegistration cookie code, if there is an associated InboxRegistration

clickwrap_body string? - Clickwrap text that was shown to the registrant

form_field_set_id int? - Id of associated form field set

form_field_data string? - Data for form field set with form field ids as keys and user data as values

files.com: BundlesBody

Fields

user_id int? - User ID. Provide a value of 0 to operate the current session's user.

paths string[] - A list of paths to include in this bundle.

password string? - Password for this bundle.

form_field_set_id int? - Id of Form Field Set to use with this bundle

expires_at string? - Bundle expiration date/time

max_uses int? - Maximum number of times bundle can be accessed

description string? - Public description

note string? - Bundle internal note

code string? - Bundle code. This code forms the end part of the Public URL.

preview_only boolean? - Restrict users to previewing files only?

require_registration boolean? - Show a registration page that captures the downloader's name and email address?

clickwrap_id int? - ID of the clickwrap to use with this bundle.

inbox_id int? - ID of the associated inbox, if available.

require_share_recipient boolean? - Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?

files.com: BundlesBody1

Fields

user_id int? - User ID. Provide a value of 0 to operate the current session's user.

paths string[] - A list of paths to include in this bundle.

password string? - Password for this bundle.

form_field_set_id int? - Id of Form Field Set to use with this bundle

expires_at string? - Bundle expiration date/time

max_uses int? - Maximum number of times bundle can be accessed

description string? - Public description

note string? - Bundle internal note

code string? - Bundle code. This code forms the end part of the Public URL.

preview_only boolean? - Restrict users to previewing files only?

require_registration boolean? - Show a registration page that captures the downloader's name and email address?

clickwrap_id int? - ID of the clickwrap to use with this bundle.

inbox_id int? - ID of the associated inbox, if available.

require_share_recipient boolean? - Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?

files.com: BundlesBody2

Fields

user_id int? - User ID. Provide a value of 0 to operate the current session's user.

paths string[] - A list of paths to include in this bundle.

password string? - Password for this bundle.

form_field_set_id int? - Id of Form Field Set to use with this bundle

expires_at string? - Bundle expiration date/time

max_uses int? - Maximum number of times bundle can be accessed

description string? - Public description

note string? - Bundle internal note

code string? - Bundle code. This code forms the end part of the Public URL.

preview_only boolean? - Restrict users to previewing files only?

require_registration boolean? - Show a registration page that captures the downloader's name and email address?

clickwrap_id int? - ID of the clickwrap to use with this bundle.

inbox_id int? - ID of the associated inbox, if available.

require_share_recipient boolean? - Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?

files.com: BundlesIdBody

Fields

paths string[]? - A list of paths to include in this bundle.

password string? - Password for this bundle.

form_field_set_id int? - Id of Form Field Set to use with this bundle

clickwrap_id int? - ID of the clickwrap to use with this bundle.

code string? - Bundle code. This code forms the end part of the Public URL.

description string? - Public description

expires_at string? - Bundle expiration date/time

inbox_id int? - ID of the associated inbox, if available.

max_uses int? - Maximum number of times bundle can be accessed

note string? - Bundle internal note

preview_only boolean? - Restrict users to previewing files only?

require_registration boolean? - Show a registration page that captures the downloader's name and email address?

require_share_recipient boolean? - Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?

files.com: BundlesIdBody1

Fields

paths string[]? - A list of paths to include in this bundle.

password string? - Password for this bundle.

form_field_set_id int? - Id of Form Field Set to use with this bundle

clickwrap_id int? - ID of the clickwrap to use with this bundle.

code string? - Bundle code. This code forms the end part of the Public URL.

description string? - Public description

expires_at string? - Bundle expiration date/time

inbox_id int? - ID of the associated inbox, if available.

max_uses int? - Maximum number of times bundle can be accessed

note string? - Bundle internal note

preview_only boolean? - Restrict users to previewing files only?

require_registration boolean? - Show a registration page that captures the downloader's name and email address?

require_share_recipient boolean? - Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?

files.com: BundlesIdBody2

Fields

paths string[]? - A list of paths to include in this bundle.

password string? - Password for this bundle.

form_field_set_id int? - Id of Form Field Set to use with this bundle

clickwrap_id int? - ID of the clickwrap to use with this bundle.

code string? - Bundle code. This code forms the end part of the Public URL.

description string? - Public description

expires_at string? - Bundle expiration date/time

inbox_id int? - ID of the associated inbox, if available.

max_uses int? - Maximum number of times bundle can be accessed

note string? - Bundle internal note

preview_only boolean? - Restrict users to previewing files only?

require_registration boolean? - Show a registration page that captures the downloader's name and email address?

require_share_recipient boolean? - Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?

files.com: ClickwrapEntity

Create Clickwrap

Fields

id int? - Clickwrap ID

name string? - Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)

body string? - Body text of Clickwrap (supports Markdown formatting).

use_with_users string? - Use this Clickwrap for User Registrations? Note: This only applies to User Registrations where the User is invited to your Files.com site using an E-Mail invitation process where they then set their own password.

use_with_bundles string? - Use this Clickwrap for Bundles?

use_with_inboxes string? - Use this Clickwrap for Inboxes?

files.com: ClickwrapsBody

Fields

name string? - Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)

body string? - Body text of Clickwrap (supports Markdown formatting).

use_with_bundles string? - Use this Clickwrap for Bundles?

use_with_inboxes string? - Use this Clickwrap for Inboxes?

use_with_users string? - Use this Clickwrap for User Registrations? Note: This only applies to User Registrations where the User is invited to your Files.com site using an E-Mail invitation process where they then set their own password.

files.com: ClickwrapsBody1

Fields

name string? - Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)

body string? - Body text of Clickwrap (supports Markdown formatting).

use_with_bundles string? - Use this Clickwrap for Bundles?

use_with_inboxes string? - Use this Clickwrap for Inboxes?

use_with_users string? - Use this Clickwrap for User Registrations? Note: This only applies to User Registrations where the User is invited to your Files.com site using an E-Mail invitation process where they then set their own password.

files.com: ClickwrapsBody2

Fields

name string? - Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)

body string? - Body text of Clickwrap (supports Markdown formatting).

use_with_bundles string? - Use this Clickwrap for Bundles?

use_with_inboxes string? - Use this Clickwrap for Inboxes?

use_with_users string? - Use this Clickwrap for User Registrations? Note: This only applies to User Registrations where the User is invited to your Files.com site using an E-Mail invitation process where they then set their own password.

files.com: ClickwrapsIdBody

Fields

name string? - Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)

body string? - Body text of Clickwrap (supports Markdown formatting).

use_with_bundles string? - Use this Clickwrap for Bundles?

use_with_inboxes string? - Use this Clickwrap for Inboxes?

use_with_users string? - Use this Clickwrap for User Registrations? Note: This only applies to User Registrations where the User is invited to your Files.com site using an E-Mail invitation process where they then set their own password.

files.com: ClickwrapsIdBody1

Fields

name string? - Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)

body string? - Body text of Clickwrap (supports Markdown formatting).

use_with_bundles string? - Use this Clickwrap for Bundles?

use_with_inboxes string? - Use this Clickwrap for Inboxes?

use_with_users string? - Use this Clickwrap for User Registrations? Note: This only applies to User Registrations where the User is invited to your Files.com site using an E-Mail invitation process where they then set their own password.

files.com: ClickwrapsIdBody2

Fields

name string? - Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)

body string? - Body text of Clickwrap (supports Markdown formatting).

use_with_bundles string? - Use this Clickwrap for Bundles?

use_with_inboxes string? - Use this Clickwrap for Inboxes?

use_with_users string? - Use this Clickwrap for User Registrations? Note: This only applies to User Registrations where the User is invited to your Files.com site using an E-Mail invitation process where they then set their own password.

files.com: ClientHttp1Settings

Closed record

Provides settings related to HTTP/1.x protocol.

Fields

keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests

chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request

proxy ProxyConfig? - Proxy server related options

files.com: ConnectionConfig

Closed record

Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.

Fields

httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client

http1Settings ClientHttp1Settings? - Configurations related to HTTP/1.x protocol

http2Settings ClientHttp2Settings? - Configurations related to HTTP/2 protocol

timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection

forwarded string(default "disable") - The choice of setting forwarded/x-forwarded header

poolConfig PoolConfiguration? - Configurations associated with request pooling

cache CacheConfig? - HTTP caching related configurations

compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (accept-encoding) header

circuitBreaker CircuitBreakerConfig? - Configurations associated with the behaviour of the Circuit Breaker

retryConfig RetryConfig? - Configurations associated with retrying

responseLimits ResponseLimitConfigs? - Configurations associated with inbound response size limits

secureSocket ClientSecureSocket? - SSL/TLS-related options

proxy ProxyConfig? - Proxy server related options

validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default

files.com: CopyFilepathBody

Fields

destination string - Copy destination path.

structure boolean? - Copy structure only?

files.com: CopyFilepathBody1

Fields

destination string - Copy destination path.

structure boolean? - Copy structure only?

files.com: CopyFilepathBody2

Fields

destination string - Copy destination path.

structure boolean? - Copy structure only?

files.com: DnsRecordEntity

Show site DNS configuration.

Fields

id string? - Unique label for DNS record; used by Zapier and other integrations.

domain string? - DNS record domain name

rrtype string? - DNS record type

value string? - DNS record value

files.com: ErrorsEntity

Error fields.

Fields

fields string[]? - A list of fields where errors occur

messages string[]? - A list of error messages

files.com: ExternalEventEntity

List External Events

Fields

id int? - Event ID

event_type string? - Type of event being recorded.

status string? - Status of event.

body string? - Event body

created_at string? - External event create date/time

body_url string? - Link to log file.

folder_behavior_id int? - Folder Behavior ID

successful_files int? - For sync events, the number of files handled successfully.

errored_files int? - For sync events, the number of files that encountered errors.

bytes_synced int? - For sync events, the total number of bytes synced.

remote_server_type string? - Associated Remote Server type, if any

files.com: ExternalEventsBody

Fields

status string - Status of event.

body string - Event body

files.com: ExternalEventsBody1

Fields

status string - Status of event.

body string - Event body

files.com: ExternalEventsBody2

Fields

status string - Status of event.

body string - Event body

files.com: FileActionEntity

Move file/folder

Fields

status string? - Status of file operation. Possible values: completed, enqueued.

file_migration_id int? - If status is enqueued, this is the id of the FileMigration to check for status updates.

files.com: FileCommentEntity

List File Comments by path

Fields

id int? - File Comment ID

body string? - Comment body.

reactions FileCommentReactionEntity? - Create File Comment Reaction

files.com: FileCommentReactionEntity

Create File Comment Reaction

Fields

id int? - Reaction ID

emoji string? - Emoji used in the reaction.

files.com: FileCommentReactionsBody

Fields

user_id int? - User ID. Provide a value of 0 to operate the current session's user.

file_comment_id int - ID of file comment to attach reaction to.

emoji string - Emoji to react with.

files.com: FileCommentReactionsBody1

Fields

user_id int? - User ID. Provide a value of 0 to operate the current session's user.

file_comment_id int - ID of file comment to attach reaction to.

emoji string - Emoji to react with.

files.com: FileCommentReactionsBody2

Fields

user_id int? - User ID. Provide a value of 0 to operate the current session's user.

file_comment_id int - ID of file comment to attach reaction to.

emoji string - Emoji to react with.

files.com: FileCommentsBody

Fields

body string - Comment body.

path string - File path.

files.com: FileCommentsBody1

Fields

body string - Comment body.

path string - File path.

files.com: FileCommentsBody2

Fields

body string - Comment body.

path string - File path.

files.com: FileCommentsIdBody

Fields

body string - Comment body.

files.com: FileCommentsIdBody1

Fields

body string - Comment body.

files.com: FileCommentsIdBody2

Fields

body string - Comment body.

files.com: FileEntity

List Folders by path

Fields

path string? - File/Folder path

display_name string? - File/Folder display name

'type string? - Type: directory or file.

size int? - File/Folder size

mtime string? - File last modified date/time, according to the server. This is the timestamp of the last Files.com operation of the file, regardless of what modified timestamp was sent.

provided_mtime string? - File last modified date/time, according to the client who set it. Files.com allows desktop, FTP, SFTP, and WebDAV clients to set modified at times. This allows Desktop<->Cloud syncing to preserve modified at times.

crc32 string? - File CRC32 checksum. This is sometimes delayed, so if you get a blank response, wait and try again.

md5 string? - File MD5 checksum. This is sometimes delayed, so if you get a blank response, wait and try again.

mime_type string? - MIME Type. This is determined by the filename extension and is not stored separately internally.

region string? - Region location

permissions string? - A short string representing the current user's permissions. Can be r,w,p, or any combination

subfolders_locked boolean? - Are subfolders locked and unable to be modified?

download_uri string? - Link to download file. Provided only in response to a download request.

priority_color string? - Bookmark/priority color of file/folder

preview_id int? - File preview ID

preview PreviewEntity? - File preview

files.com: FileMigrationEntity

Show File Migration

Fields

id int? - File migration ID

path string? - Source path

dest_path string? - Destination path

files_moved int? - Number of files processed

files_total int? - Total number of files to process

operation string? - The type of operation

region string? - Region

status string? - Status

log_url string? - Link to download the log file for this migration.

files.com: FilesFilepathBody

Fields

action string? - The action to perform. Can be append, attachment, end, upload, put, or may not exist

'etags\[etag\] string[] - etag identifier.

'etags\[part\] int[] - Part number.

length int? - Length of file.

mkdir_parents boolean? - Create parent directories if they do not exist?

part int? - Part if uploading a part.

parts int? - How many parts to fetch?

provided_mtime string? - User provided modification time.

ref string? -

restart int? - File byte offset to restart from.

size int? - Size of file.

structure string? - If copying folder, copy just the structure?

with_rename boolean? - Allow file rename instead of overwrite?

files.com: FilesFilepathBody1

Fields

action string? - The action to perform. Can be append, attachment, end, upload, put, or may not exist

'etags\[etag\] string[] - etag identifier.

'etags\[part\] int[] - Part number.

length int? - Length of file.

mkdir_parents boolean? - Create parent directories if they do not exist?

part int? - Part if uploading a part.

parts int? - How many parts to fetch?

provided_mtime string? - User provided modification time.

ref string? -

restart int? - File byte offset to restart from.

size int? - Size of file.

structure string? - If copying folder, copy just the structure?

with_rename boolean? - Allow file rename instead of overwrite?

files.com: FilesFilepathBody2

Fields

action string? - The action to perform. Can be append, attachment, end, upload, put, or may not exist

'etags\[etag\] string[] - etag identifier.

'etags\[part\] int[] - Part number.

length int? - Length of file.

mkdir_parents boolean? - Create parent directories if they do not exist?

part int? - Part if uploading a part.

parts int? - How many parts to fetch?

provided_mtime string? - User provided modification time.

ref string? -

restart int? - File byte offset to restart from.

size int? - Size of file.

structure string? - If copying folder, copy just the structure?

with_rename boolean? - Allow file rename instead of overwrite?

files.com: FilesFilepathBody3

Fields

provided_mtime string? - Modified time of file.

priority_color string? - Priority/Bookmark color of file.

files.com: FilesFilepathBody4

Fields

provided_mtime string? - Modified time of file.

priority_color string? - Priority/Bookmark color of file.

files.com: FilesFilepathBody5

Fields

provided_mtime string? - Modified time of file.

priority_color string? - Priority/Bookmark color of file.

files.com: FileUploadPartEntity

Begin file upload

Fields

send record {}? - Content-Type and File to send

action string? - Type of upload

ask_about_overwrites boolean? - If true, this file exists and you may wish to ask the user for overwrite confirmation

available_parts int? - Number of parts in the upload

expires string? - Date/time of when this Upload part expires and the URL cannot be used any more

headers record {}? - Additional upload headers to provide as part of the upload

http_method string? - HTTP Method to use for uploading the part, usually PUT

next_partsize int? - Size in bytes for this part

parallel_parts boolean? - If true, multiple parts may be uploaded in parallel. If false, be sure to only upload one part at a time, in order.

parameters record {}? - Additional HTTP parameters to send with the upload

part_number int? - Number of this upload part

partsize int? - Size in bytes for the next upload part

path string? - New file path

ref string? - Reference name for this upload part

upload_uri string? - URI to upload this part to

files.com: FormFieldEntity

Form fields

Fields

id int? - Form field id

label string? - Label to be displayed

required boolean? - Is this a required field?

help_text string? - Help text to be displayed

field_type string? - Type of Field

options_for_select string? - Options to display for radio and dropdown

default_option string? - Default option for radio and dropdown

form_field_set_id int? - Form field set id

files.com: FormFieldSetEntity

Create Form Field Set

Fields

id int? - Form field set id

title string? - Title to be displayed

form_layout int? - Layout of the form

form_fields FormFieldEntity? - Form fields

skip_name boolean? - Any associated InboxRegistrations or BundleRegistrations can be saved without providing name

skip_email boolean? - Any associated InboxRegistrations or BundleRegistrations can be saved without providing email

skip_company boolean? - Any associated InboxRegistrations or BundleRegistrations can be saved without providing company

files.com: GroupEntity

List Groups

Fields

id int? - Group ID

name string? - Group name

admin_ids string? - List of user IDs who are group administrators (separated by commas)

notes string? - Notes about this group

user_ids int[]? - List of user IDs who belong to this group (separated by commas)

usernames string[]? - List of usernames who belong to this group (separated by commas)

files.com: GroupIdUsersBody

Fields

avatar_file string? - An image file for your user avatar.

avatar_delete boolean? - If true, the avatar will be deleted.

change_password string? - Used for changing a password on an existing user.

change_password_confirmation string? - Optional, but if provided, we will ensure that it matches the value sent in change_password.

email string? - User's email.

grant_permission string? - Permission to grant on the user root. Can be blank or full, read, write, list, or history.

group_ids string? - A list of group ids to associate this user with. Comma delimited.

imported_password_hash string? - Pre-calculated hash of the user's password.

password string? - User password.

password_confirmation string? - Optional, but if provided, we will ensure that it matches the value sent in password.

announcements_read boolean? - Signifies that the user has read all the announcements in the UI.

allowed_ips string? - A list of allowed IPs if applicable. Newline delimited

attachments_permission boolean? - DEPRECATED: Can the user create Bundles (aka Share Links)? Use the bundle permission instead.

authenticate_until string? - Scheduled Date/Time at which user will be deactivated

authentication_method string? - How is this user authenticated?

billing_permission boolean? - Allow this user to perform operations on the account, payments, and invoices?

bypass_inactive_disable boolean? - Exempt this user from being disabled based on inactivity?

bypass_site_allowed_ips boolean? - Allow this user to skip site-wide IP blacklists?

dav_permission boolean? - Can the user connect with WebDAV?

disabled boolean? - Is user disabled? Disabled users cannot log in, and do not count for billing purposes. Users can be automatically disabled after an inactivity period via a Site setting.

ftp_permission boolean? - Can the user access with FTP/FTPS?

header_text string? - Text to display to the user in the header of the UI

language string? - Preferred language

notification_daily_send_time int? - Hour of the day at which daily notifications should be sent. Can be in range 0 to 23

name string? - User's full name

company string? - User's company

notes string? - Any internal notes on the user

office_integration_enabled boolean? - Enable integration with Office for the web?

password_validity_days int? - Number of days to allow user to use the same password

receive_admin_alerts boolean? - Should the user receive admin alerts such a certificate expiration notifications and overages?

require_password_change boolean? - Is a password change required upon next user login?

restapi_permission boolean? - Can this user access the REST API?

self_managed boolean? - Does this user manage it's own credentials or is it a shared/bot user?

sftp_permission boolean? - Can the user access with SFTP?

site_admin boolean? - Is the user an administrator for this site?

skip_welcome_screen boolean? - Skip Welcome page in the UI?

ssl_required string? - SSL required setting

sso_strategy_id int? - SSO (Single Sign On) strategy ID for the user, if applicable.

subscribe_to_newsletter boolean? - Is the user subscribed to the newsletter?

require_2fa string? - 2FA required setting

time_zone string? - User time zone

user_root string? - Root folder for FTP (and optionally SFTP if the appropriate site-wide setting is set.) Note that this is not used for API, Desktop, or Web interface.

username string? - User's username

files.com: GroupIdUsersBody1

Fields

avatar_file string? - An image file for your user avatar.

avatar_delete boolean? - If true, the avatar will be deleted.

change_password string? - Used for changing a password on an existing user.

change_password_confirmation string? - Optional, but if provided, we will ensure that it matches the value sent in change_password.

email string? - User's email.

grant_permission string? - Permission to grant on the user root. Can be blank or full, read, write, list, or history.

group_ids string? - A list of group ids to associate this user with. Comma delimited.

imported_password_hash string? - Pre-calculated hash of the user's password.

password string? - User password.

password_confirmation string? - Optional, but if provided, we will ensure that it matches the value sent in password.

announcements_read boolean? - Signifies that the user has read all the announcements in the UI.

allowed_ips string? - A list of allowed IPs if applicable. Newline delimited

attachments_permission boolean? - DEPRECATED: Can the user create Bundles (aka Share Links)? Use the bundle permission instead.

authenticate_until string? - Scheduled Date/Time at which user will be deactivated

authentication_method string? - How is this user authenticated?

billing_permission boolean? - Allow this user to perform operations on the account, payments, and invoices?

bypass_inactive_disable boolean? - Exempt this user from being disabled based on inactivity?

bypass_site_allowed_ips boolean? - Allow this user to skip site-wide IP blacklists?

dav_permission boolean? - Can the user connect with WebDAV?

disabled boolean? - Is user disabled? Disabled users cannot log in, and do not count for billing purposes. Users can be automatically disabled after an inactivity period via a Site setting.

ftp_permission boolean? - Can the user access with FTP/FTPS?

header_text string? - Text to display to the user in the header of the UI

language string? - Preferred language

notification_daily_send_time int? - Hour of the day at which daily notifications should be sent. Can be in range 0 to 23

name string? - User's full name

company string? - User's company

notes string? - Any internal notes on the user

office_integration_enabled boolean? - Enable integration with Office for the web?

password_validity_days int? - Number of days to allow user to use the same password

receive_admin_alerts boolean? - Should the user receive admin alerts such a certificate expiration notifications and overages?

require_password_change boolean? - Is a password change required upon next user login?

restapi_permission boolean? - Can this user access the REST API?

self_managed boolean? - Does this user manage it's own credentials or is it a shared/bot user?

sftp_permission boolean? - Can the user access with SFTP?

site_admin boolean? - Is the user an administrator for this site?

skip_welcome_screen boolean? - Skip Welcome page in the UI?

ssl_required string? - SSL required setting

sso_strategy_id int? - SSO (Single Sign On) strategy ID for the user, if applicable.

subscribe_to_newsletter boolean? - Is the user subscribed to the newsletter?

require_2fa string? - 2FA required setting

time_zone string? - User time zone

user_root string? - Root folder for FTP (and optionally SFTP if the appropriate site-wide setting is set.) Note that this is not used for API, Desktop, or Web interface.

username string? - User's username

files.com: GroupIdUsersBody2

Fields

avatar_file string? - An image file for your user avatar.

avatar_delete boolean? - If true, the avatar will be deleted.

change_password string? - Used for changing a password on an existing user.

change_password_confirmation string? - Optional, but if provided, we will ensure that it matches the value sent in change_password.

email string? - User's email.

grant_permission string? - Permission to grant on the user root. Can be blank or full, read, write, list, or history.

group_ids string? - A list of group ids to associate this user with. Comma delimited.

imported_password_hash string? - Pre-calculated hash of the user's password.

password string? - User password.

password_confirmation string? - Optional, but if provided, we will ensure that it matches the value sent in password.

announcements_read boolean? - Signifies that the user has read all the announcements in the UI.

allowed_ips string? - A list of allowed IPs if applicable. Newline delimited

attachments_permission boolean? - DEPRECATED: Can the user create Bundles (aka Share Links)? Use the bundle permission instead.

authenticate_until string? - Scheduled Date/Time at which user will be deactivated

authentication_method string? - How is this user authenticated?

billing_permission boolean? - Allow this user to perform operations on the account, payments, and invoices?

bypass_inactive_disable boolean? - Exempt this user from being disabled based on inactivity?

bypass_site_allowed_ips boolean? - Allow this user to skip site-wide IP blacklists?

dav_permission boolean? - Can the user connect with WebDAV?

disabled boolean? - Is user disabled? Disabled users cannot log in, and do not count for billing purposes. Users can be automatically disabled after an inactivity period via a Site setting.

ftp_permission boolean? - Can the user access with FTP/FTPS?

header_text string? - Text to display to the user in the header of the UI

language string? - Preferred language

notification_daily_send_time int? - Hour of the day at which daily notifications should be sent. Can be in range 0 to 23

name string? - User's full name

company string? - User's company

notes string? - Any internal notes on the user

office_integration_enabled boolean? - Enable integration with Office for the web?

password_validity_days int? - Number of days to allow user to use the same password

receive_admin_alerts boolean? - Should the user receive admin alerts such a certificate expiration notifications and overages?

require_password_change boolean? - Is a password change required upon next user login?

restapi_permission boolean? - Can this user access the REST API?

self_managed boolean? - Does this user manage it's own credentials or is it a shared/bot user?

sftp_permission boolean? - Can the user access with SFTP?

site_admin boolean? - Is the user an administrator for this site?

skip_welcome_screen boolean? - Skip Welcome page in the UI?

ssl_required string? - SSL required setting

sso_strategy_id int? - SSO (Single Sign On) strategy ID for the user, if applicable.

subscribe_to_newsletter boolean? - Is the user subscribed to the newsletter?

require_2fa string? - 2FA required setting

time_zone string? - User time zone

user_root string? - Root folder for FTP (and optionally SFTP if the appropriate site-wide setting is set.) Note that this is not used for API, Desktop, or Web interface.

username string? - User's username

files.com: GroupsBody

Fields

name string? - Group name.

notes string? - Group notes.

user_ids string? - A list of user ids. If sent as a string, should be comma-delimited.

admin_ids string? - A list of group admin user ids. If sent as a string, should be comma-delimited.

files.com: GroupsBody1

Fields

name string? - Group name.

notes string? - Group notes.

user_ids string? - A list of user ids. If sent as a string, should be comma-delimited.

admin_ids string? - A list of group admin user ids. If sent as a string, should be comma-delimited.

files.com: GroupsBody2

Fields

name string? - Group name.

notes string? - Group notes.

user_ids string? - A list of user ids. If sent as a string, should be comma-delimited.

admin_ids string? - A list of group admin user ids. If sent as a string, should be comma-delimited.

files.com: GroupsIdBody

Fields

name string? - Group name.

notes string? - Group notes.

user_ids string? - A list of user ids. If sent as a string, should be comma-delimited.

admin_ids string? - A list of group admin user ids. If sent as a string, should be comma-delimited.

files.com: GroupsIdBody1

Fields

name string? - Group name.

notes string? - Group notes.

user_ids string? - A list of user ids. If sent as a string, should be comma-delimited.

admin_ids string? - A list of group admin user ids. If sent as a string, should be comma-delimited.

files.com: GroupsIdBody2

Fields

name string? - Group name.

notes string? - Group notes.

user_ids string? - A list of user ids. If sent as a string, should be comma-delimited.

admin_ids string? - A list of group admin user ids. If sent as a string, should be comma-delimited.

files.com: GroupUserEntity

Create Group User

Fields

group_name string? - Group name

group_id int? - Group ID

user_id int? - User ID

admin boolean? - Is this user an administrator of this group?

usernames string[]? - A list of usernames for users in this group

files.com: GroupUsersBody

Fields

group_id int - Group ID to add user to.

user_id int - User ID to add to group.

admin boolean? - Is the user a group administrator?

files.com: GroupUsersBody1

Fields

group_id int - Group ID to add user to.

user_id int - User ID to add to group.

admin boolean? - Is the user a group administrator?

files.com: GroupUsersBody2

Fields

group_id int - Group ID to add user to.

user_id int - User ID to add to group.

admin boolean? - Is the user a group administrator?

files.com: GroupUsersIdBody

Fields

group_id int - Group ID to add user to.

user_id int - User ID to add to group.

admin boolean? - Is the user a group administrator?

files.com: GroupUsersIdBody1

Fields

group_id int - Group ID to add user to.

user_id int - User ID to add to group.

admin boolean? - Is the user a group administrator?

files.com: GroupUsersIdBody2

Fields

group_id int - Group ID to add user to.

user_id int - User ID to add to group.

admin boolean? - Is the user a group administrator?

files.com: HistoryExportEntity

Show History Export

Fields

id int? - History Export ID

history_version string? - Version of the history for the export.

start_at string? - Start date/time of export range.

end_at string? - End date/time of export range.

status string? - Status of export. Will be: building, ready, or failed

query_action string? - Filter results by this this action type. Valid values: create, read, update, destroy, move, login, failedlogin, copy, user_create, user_update, user_destroy, group_create, group_update, group_destroy, permission_create, permission_destroy, api_key_create, api_key_update, api_key_destroy

query_interface string? - Filter results by this this interface type. Valid values: web, ftp, robot, jsapi, webdesktopapi, sftp, dav, desktop, restapi, scim, office, mobile

query_user_id string? - Return results that are actions performed by the user indiciated by this User ID

query_file_id string? - Return results that are file actions related to the file indicated by this File ID

query_parent_id string? - Return results that are file actions inside the parent folder specified by this folder ID

query_path string? - Return results that are file actions related to this path.

query_folder string? - Return results that are file actions related to files or folders inside this folder path.

query_src string? - Return results that are file moves originating from this path.

query_destination string? - Return results that are file moves with this path as destination.

query_ip string? - Filter results by this IP address.

query_username string? - Filter results by this username.

query_failure_type string? - If searching for Histories about login failures, this parameter restricts results to failures of this specific type. Valid values: expired_trial, account_overdue, locked_out, ip_mismatch, password_mismatch, site_mismatch, username_not_found, none, no_ftp_permission, no_web_permission, no_directory, errno_enoent, no_sftp_permission, no_dav_permission, no_restapi_permission, key_mismatch, region_mismatch, expired_access, desktop_ip_mismatch, desktop_api_key_not_used_quickly_enough, disabled, country_mismatch

query_target_id string? - If searching for Histories about specific objects (such as Users, or API Keys), this paremeter restricts results to objects that match this ID.

query_target_name string? - If searching for Histories about Users, Groups or other objects with names, this parameter restricts results to objects with this name/username.

query_target_permission string? - If searching for Histories about Permisisons, this parameter restricts results to permissions of this level.

query_target_user_id string? - If searching for Histories about API keys, this parameter restricts results to API keys created by/for this user ID.

query_target_username string? - If searching for Histories about API keys, this parameter restricts results to API keys created by/for this username.

query_target_platform string? - If searching for Histories about API keys, this parameter restricts results to API keys associated with this platform.

query_target_permission_set string? - If searching for Histories about API keys, this parameter restricts results to API keys with this permission set.

results_url string? - If status is ready, this will be a URL where all the results can be downloaded at once as a CSV.

files.com: HistoryExportResultEntity

List History Export Results

Fields

id int? - Action ID

created_at int? - When the action happened

user_id int? - User ID

file_id int? - File ID related to the action

parent_id int? - ID of the parent folder

path string? - Path of the related action

folder string? - Folder in which the action occurred

src string? - File move originated from this path

destination string? - File moved to this destination folder

ip string? - Client IP that performed the action

username string? - Username of the user that performed the action

action string? - What action was taken. Valid values: create, read, update, destroy, move, login, failedlogin, copy, user_create, user_update, user_destroy, group_create, group_update, group_destroy, permission_create, permission_destroy, api_key_create, api_key_update, api_key_destroy

failure_type string? - The type of login failure, if applicable. Valid values: expired_trial, account_overdue, locked_out, ip_mismatch, password_mismatch, site_mismatch, username_not_found, none, no_ftp_permission, no_web_permission, no_directory, errno_enoent, no_sftp_permission, no_dav_permission, no_restapi_permission, key_mismatch, region_mismatch, expired_access, desktop_ip_mismatch, desktop_api_key_not_used_quickly_enough, disabled, country_mismatch

interface string? - Inteface through which the action was taken. Valid values: web, ftp, robot, jsapi, webdesktopapi, sftp, dav, desktop, restapi, scim, office, mobile

target_id int? - ID of the object (such as Users, or API Keys) on which the action was taken

target_name string? - Name of the User, Group or other object with a name related to this action

target_permission string? - Permission level of the action

target_recursive boolean? - Whether or not the action was recursive

target_expires_at int? - If searching for Histories about API keys, this is when the API key will expire

target_permission_set string? - If searching for Histories about API keys, this represents the permission set of the associated API key

target_platform string? - If searching for Histories about API keys, this is the platform on which the action was taken

target_username string? - If searching for Histories about API keys, this is the username on which the action was taken

target_user_id int? - If searching for Histories about API keys, this is the User ID on which the action was taken

files.com: HistoryExportsBody

Fields

user_id int? - User ID. Provide a value of 0 to operate the current session's user.

start_at string? - Start date/time of export range.

end_at string? - End date/time of export range.

query_action string? - Filter results by this this action type. Valid values: create, read, update, destroy, move, login, failedlogin, copy, user_create, user_update, user_destroy, group_create, group_update, group_destroy, permission_create, permission_destroy, api_key_create, api_key_update, api_key_destroy

query_interface string? - Filter results by this this interface type. Valid values: web, ftp, robot, jsapi, webdesktopapi, sftp, dav, desktop, restapi, scim, office, mobile

query_user_id string? - Return results that are actions performed by the user indiciated by this User ID

query_file_id string? - Return results that are file actions related to the file indicated by this File ID

query_parent_id string? - Return results that are file actions inside the parent folder specified by this folder ID

query_path string? - Return results that are file actions related to this path.

query_folder string? - Return results that are file actions related to files or folders inside this folder path.

query_src string? - Return results that are file moves originating from this path.

query_destination string? - Return results that are file moves with this path as destination.

query_ip string? - Filter results by this IP address.

query_username string? - Filter results by this username.

query_failure_type string? - If searching for Histories about login failures, this parameter restricts results to failures of this specific type. Valid values: expired_trial, account_overdue, locked_out, ip_mismatch, password_mismatch, site_mismatch, username_not_found, none, no_ftp_permission, no_web_permission, no_directory, errno_enoent, no_sftp_permission, no_dav_permission, no_restapi_permission, key_mismatch, region_mismatch, expired_access, desktop_ip_mismatch, desktop_api_key_not_used_quickly_enough, disabled, country_mismatch

query_target_id string? - If searching for Histories about specific objects (such as Users, or API Keys), this paremeter restricts results to objects that match this ID.

query_target_name string? - If searching for Histories about Users, Groups or other objects with names, this parameter restricts results to objects with this name/username.

query_target_permission string? - If searching for Histories about Permisisons, this parameter restricts results to permissions of this level.

query_target_user_id string? - If searching for Histories about API keys, this parameter restricts results to API keys created by/for this user ID.

query_target_username string? - If searching for Histories about API keys, this parameter restricts results to API keys created by/for this username.

query_target_platform string? - If searching for Histories about API keys, this parameter restricts results to API keys associated with this platform.

query_target_permission_set string? - If searching for Histories about API keys, this parameter restricts results to API keys with this permission set.

files.com: HistoryExportsBody1

Fields

user_id int? - User ID. Provide a value of 0 to operate the current session's user.

start_at string? - Start date/time of export range.

end_at string? - End date/time of export range.

query_action string? - Filter results by this this action type. Valid values: create, read, update, destroy, move, login, failedlogin, copy, user_create, user_update, user_destroy, group_create, group_update, group_destroy, permission_create, permission_destroy, api_key_create, api_key_update, api_key_destroy

query_interface string? - Filter results by this this interface type. Valid values: web, ftp, robot, jsapi, webdesktopapi, sftp, dav, desktop, restapi, scim, office, mobile

query_user_id string? - Return results that are actions performed by the user indiciated by this User ID

query_file_id string? - Return results that are file actions related to the file indicated by this File ID

query_parent_id string? - Return results that are file actions inside the parent folder specified by this folder ID

query_path string? - Return results that are file actions related to this path.

query_folder string? - Return results that are file actions related to files or folders inside this folder path.

query_src string? - Return results that are file moves originating from this path.

query_destination string? - Return results that are file moves with this path as destination.

query_ip string? - Filter results by this IP address.

query_username string? - Filter results by this username.

query_failure_type string? - If searching for Histories about login failures, this parameter restricts results to failures of this specific type. Valid values: expired_trial, account_overdue, locked_out, ip_mismatch, password_mismatch, site_mismatch, username_not_found, none, no_ftp_permission, no_web_permission, no_directory, errno_enoent, no_sftp_permission, no_dav_permission, no_restapi_permission, key_mismatch, region_mismatch, expired_access, desktop_ip_mismatch, desktop_api_key_not_used_quickly_enough, disabled, country_mismatch

query_target_id string? - If searching for Histories about specific objects (such as Users, or API Keys), this paremeter restricts results to objects that match this ID.

query_target_name string? - If searching for Histories about Users, Groups or other objects with names, this parameter restricts results to objects with this name/username.

query_target_permission string? - If searching for Histories about Permisisons, this parameter restricts results to permissions of this level.

query_target_user_id string? - If searching for Histories about API keys, this parameter restricts results to API keys created by/for this user ID.

query_target_username string? - If searching for Histories about API keys, this parameter restricts results to API keys created by/for this username.

query_target_platform string? - If searching for Histories about API keys, this parameter restricts results to API keys associated with this platform.

query_target_permission_set string? - If searching for Histories about API keys, this parameter restricts results to API keys with this permission set.

files.com: HistoryExportsBody2

Fields

user_id int? - User ID. Provide a value of 0 to operate the current session's user.

start_at string? - Start date/time of export range.

end_at string? - End date/time of export range.

query_action string? - Filter results by this this action type. Valid values: create, read, update, destroy, move, login, failedlogin, copy, user_create, user_update, user_destroy, group_create, group_update, group_destroy, permission_create, permission_destroy, api_key_create, api_key_update, api_key_destroy

query_interface string? - Filter results by this this interface type. Valid values: web, ftp, robot, jsapi, webdesktopapi, sftp, dav, desktop, restapi, scim, office, mobile

query_user_id string? - Return results that are actions performed by the user indiciated by this User ID

query_file_id string? - Return results that are file actions related to the file indicated by this File ID

query_parent_id string? - Return results that are file actions inside the parent folder specified by this folder ID

query_path string? - Return results that are file actions related to this path.

query_folder string? - Return results that are file actions related to files or folders inside this folder path.

query_src string? - Return results that are file moves originating from this path.

query_destination string? - Return results that are file moves with this path as destination.

query_ip string? - Filter results by this IP address.

query_username string? - Filter results by this username.

query_failure_type string? - If searching for Histories about login failures, this parameter restricts results to failures of this specific type. Valid values: expired_trial, account_overdue, locked_out, ip_mismatch, password_mismatch, site_mismatch, username_not_found, none, no_ftp_permission, no_web_permission, no_directory, errno_enoent, no_sftp_permission, no_dav_permission, no_restapi_permission, key_mismatch, region_mismatch, expired_access, desktop_ip_mismatch, desktop_api_key_not_used_quickly_enough, disabled, country_mismatch

query_target_id string? - If searching for Histories about specific objects (such as Users, or API Keys), this paremeter restricts results to objects that match this ID.

query_target_name string? - If searching for Histories about Users, Groups or other objects with names, this parameter restricts results to objects with this name/username.

query_target_permission string? - If searching for Histories about Permisisons, this parameter restricts results to permissions of this level.

query_target_user_id string? - If searching for Histories about API keys, this parameter restricts results to API keys created by/for this user ID.

query_target_username string? - If searching for Histories about API keys, this parameter restricts results to API keys created by/for this username.

query_target_platform string? - If searching for Histories about API keys, this parameter restricts results to API keys associated with this platform.

query_target_permission_set string? - If searching for Histories about API keys, this parameter restricts results to API keys with this permission set.

files.com: IdShareBody

Fields

to string[]? - A list of email addresses to share this bundle with. Required unless recipients is used.

note string? - Note to include in email.

recipients record {}[]? - A list of recipients to share this bundle with. Required unless to is used.

files.com: IdShareBody1

Fields

to string[]? - A list of email addresses to share this bundle with. Required unless recipients is used.

note string? - Note to include in email.

recipients record {}[]? - A list of recipients to share this bundle with. Required unless to is used.

files.com: IdShareBody2

Fields

to string[]? - A list of email addresses to share this bundle with. Required unless recipients is used.

note string? - Note to include in email.

recipients record {}[]? - A list of recipients to share this bundle with. Required unless to is used.

files.com: ImageEntity

Image entity

Fields

name string? - Image name

uri string? - Image URI

files.com: InboxRecipientEntity

List Inbox Recipients

Fields

company string? - The recipient's company.

name string? - The recipient's name.

note string? - A note sent to the recipient with the inbox.

recipient string? - The recipient's email address.

sent_at string? - When the Inbox was shared with this recipient.

files.com: InboxRecipientsBody

Fields

user_id int? - User ID. Provide a value of 0 to operate the current session's user.

inbox_id int - Inbox to share.

recipient string - Email address to share this inbox with.

name string? - Name of recipient.

company string? - Company of recipient.

note string? - Note to include in email.

share_after_create boolean? - Set to true to share the link with the recipient upon creation.

files.com: InboxRecipientsBody1

Fields

user_id int? - User ID. Provide a value of 0 to operate the current session's user.

inbox_id int - Inbox to share.

recipient string - Email address to share this inbox with.

name string? - Name of recipient.

company string? - Company of recipient.

note string? - Note to include in email.

share_after_create boolean? - Set to true to share the link with the recipient upon creation.

files.com: InboxRecipientsBody2

Fields

user_id int? - User ID. Provide a value of 0 to operate the current session's user.

inbox_id int - Inbox to share.

recipient string - Email address to share this inbox with.

name string? - Name of recipient.

company string? - Company of recipient.

note string? - Note to include in email.

share_after_create boolean? - Set to true to share the link with the recipient upon creation.

files.com: InboxRegistrationEntity

List Inbox Registrations

Fields

code string? - Registration cookie code

name string? - Registrant name

company string? - Registrant company name

email string? - Registrant email address

clickwrap_body string? - Clickwrap text that was shown to the registrant

form_field_set_id int? - Id of associated form field set

form_field_data string? - Data for form field set with form field ids as keys and user data as values

files.com: InboxUploadEntity

List Inbox Uploads

Fields

inbox_registration InboxRegistrationEntity? - List Inbox Registrations

path string? - Upload path

created_at string? - Upload date/time

files.com: InvoiceLineItemEntity

Associated invoice line items

Fields

amount decimal? - Invoice line item amount

created_at string? - Invoice line item created at date/time

description string? - Invoice line item description

'type string? - Invoice line item type

service_end_at string? - Invoice line item service end date/time

service_start_at string? - Invoice line item service start date/time

updated_at string? - Invoice line item updated date/time

plan string? - Plan name

site string? - Site name

files.com: IpAddressEntity

List IP Addresses associated with the current site

Fields

id string? - Unique label for list; used by Zapier and other integrations.

associated_with string? - The object that this public IP address list is associated with.

group_id int? - Group ID

ip_addresses string[]? - A list of IP addresses.

files.com: LockEntity

List Locks by path

Fields

path string? - Path

timeout int? - Lock timeout in seconds

depth string? - DEPRECATED: Lock depth

recursive boolean? - Does lock apply to subfolders?

owner string? - Owner of the lock. This can be any arbitrary string.

scope string? - DEPRECATED: Lock scope

exclusive boolean? - Is lock exclusive?

token string? - Lock token. Use to release lock.

'type string? - DEPRECATED: Lock type

allow_access_by_any_user boolean? - Can lock be modified by users other than its creator?

user_id int? - Lock creator user ID

username string? - Lock creator username

files.com: LocksLockpathBody

Fields

allow_access_by_any_user boolean? - Allow lock to be updated by any user?

exclusive boolean? - Is lock exclusive?

recursive string? - Does lock apply to subfolders?

timeout int? - Lock timeout length

files.com: LocksLockpathBody1

Fields

allow_access_by_any_user boolean? - Allow lock to be updated by any user?

exclusive boolean? - Is lock exclusive?

recursive string? - Does lock apply to subfolders?

timeout int? - Lock timeout length

files.com: LocksLockpathBody2

Fields

allow_access_by_any_user boolean? - Allow lock to be updated by any user?

exclusive boolean? - Is lock exclusive?

recursive string? - Does lock apply to subfolders?

timeout int? - Lock timeout length

files.com: MembershipsUserIdBody

Fields

admin boolean? - Is the user a group administrator?

files.com: MembershipsUserIdBody1

Fields

admin boolean? - Is the user a group administrator?

files.com: MembershipsUserIdBody2

Fields

admin boolean? - Is the user a group administrator?

files.com: MessageCommentEntity

List Message Comments

Fields

id int? - Message Comment ID

body string? - Comment body.

reactions MessageCommentReactionEntity? - List Message Comment Reactions

files.com: MessageCommentReactionEntity

List Message Comment Reactions

Fields

id int? - Reaction ID

emoji string? - Emoji used in the reaction.

files.com: MessageCommentReactionsBody

Fields

user_id int? - User ID. Provide a value of 0 to operate the current session's user.

emoji string - Emoji to react with.

files.com: MessageCommentReactionsBody1

Fields

user_id int? - User ID. Provide a value of 0 to operate the current session's user.

emoji string - Emoji to react with.

files.com: MessageCommentReactionsBody2

Fields

user_id int? - User ID. Provide a value of 0 to operate the current session's user.

emoji string - Emoji to react with.

files.com: MessageCommentsBody

Fields

user_id

clients

records

ballerinax/files.com Ballerina library

Overview

Prerequisites

Quickstart

Step 1: Import connector

Step 2: Create a new connector instance

Step 3: Invoke connector operation

Clients

files.com: Client

Constructor

postActionNotificationExports

Parameters

Return Type

getActionNotificationExportsId

Parameters

Return Type

getActionNotificationExportResults

Parameters

Return Type

postActionWebhookFailuresIdRetry

Parameters

Return Type

apiKeyFindCurrent

Return Type

apiKeyDeleteCurrent

Return Type

apiKeyUpdateCurrent

Parameters

Return Type

getApiKeysId

Parameters

Return Type

deleteApiKeysId

Parameters

Return Type

patchApiKeysId

Parameters

Return Type

getApiKeys

Parameters

Return Type

postApiKeys

Parameters

Return Type

getSiteUsage

Return Type

getSite

Return Type

patchSite

Parameters

Return Type

getSiteIpAddresses

Parameters

Return Type

getSiteDnsRecords

Parameters

Return Type

postSiteTestWebhook

Parameters

Return Type

getSiteApiKeys

Parameters

Return Type

postSiteApiKeys

Parameters

Return Type

patchUser

Parameters

Return Type

getUserPublicKeys

Parameters

Return Type

postUserPublicKeys

Parameters

Return Type

getUserGroups

Parameters

Return Type