@datafire/files v3.0.0

@datafire/files

Client library for Files.com

Installation and Usage

npm install --save @datafire/files

let files = require('@datafire/files').create({
  api_key: ""
});

.then(data => {
  console.log(data);
});

Description

Actions

DeleteCurrent

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

files.DeleteCurrent(null, context)

Input

This action has no parameters

Output

Output schema unknown

FindCurrent

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

files.FindCurrent(null, context)

Input

This action has no parameters

Output

• output ApiKeyEntity

UpdateCurrent

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

files.UpdateCurrent({}, context)

Input

• input object
  • name string: Internal name for key. For your reference only.
  • permission_set string: Leave blank, or set to desktop_app to restrict the key to only desktop app functions.
  • expires_at string: Have the key expire at this date/time.

Output

• output ApiKeyEntity

getApiKeys

List Api Keys

files.getApiKeys({}, context)

Input

• input object
  • user_id integer: User ID. Provide a value of 0 to operate the current session's user.
  • page integer: Current page number.
  • per_page integer: Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
  • action string: Deprecated: If set to count returns a count of matching records rather than the records themselves.

Output

• output array
  • items ApiKeyEntity

postApiKeys

Create Api Key

files.postApiKeys({}, context)

Input

• input object
  • user_id integer: User ID. Provide a value of 0 to operate the current session's user.
  • name string: Internal name for key. For your reference only.
  • permission_set string: Leave blank, or set to 'desktop_app' to restrict the key to only desktop app functions.
  • expires_at string: Have the key expire at this date/time.

Output

• output ApiKeyEntity

deleteApiKeysId

Delete Api Key

files.deleteApiKeysId({
  "id": 0
}, context)

Input

• input object
  • id required integer: Api Key ID.

Output

Output schema unknown

getApiKeysId

Show Api Key

files.getApiKeysId({
  "id": 0
}, context)

Input

• input object
  • id required integer: Api Key ID.

Output

• output ApiKeyEntity

patchApiKeysId

Update Api Key

files.patchApiKeysId({
  "id": 0
}, context)

Input

• input object
  • id required integer: Api Key ID.
  • name string: Internal name for key. For your reference only.
  • permission_set string: Leave blank, or set to 'desktop_app' to restrict the key to only desktop app functions.
  • expires_at string: Have the key expire at this date/time.

Output

• output ApiKeyEntity

getAs2Keys

List As2 Keys

files.getAs2Keys({}, context)

Input

• input object
  • user_id integer: User ID. Provide a value of 0 to operate the current session's user.
  • page integer: Current page number.
  • per_page integer: Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
  • action string: Deprecated: If set to count returns a count of matching records rather than the records themselves.

Output

• output array
  • items As2KeyEntity

postAs2Keys

Create As2 Key

files.postAs2Keys({
  "as2_partnership_name": "",
  "public_key": ""
}, context)

Input

• input object
  • user_id integer: User ID. Provide a value of 0 to operate the current session's user.
  • as2_partnership_name required string: AS2 Partnership Name
  • public_key required string: Actual contents of Public key.

Output

• output As2KeyEntity

deleteAs2KeysId

Delete As2 Key

files.deleteAs2KeysId({
  "id": 0
}, context)

Input

• input object
  • id required integer: As2 Key ID.

Output

Output schema unknown

getAs2KeysId

Show As2 Key

files.getAs2KeysId({
  "id": 0
}, context)

Input

• input object
  • id required integer: As2 Key ID.

Output

• output As2KeyEntity

patchAs2KeysId

Update As2 Key

files.patchAs2KeysId({
  "id": 0,
  "as2_partnership_name": ""
}, context)

Input

• input object
  • id required integer: As2 Key ID.
  • as2_partnership_name required string: AS2 Partnership Name

Output

• output As2KeyEntity

getAutomations

List Automations

files.getAutomations({}, context)

Input

• input object
  • page integer: Current page number.
  • per_page integer: Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
  • action string: Deprecated: If set to count returns a count of matching records rather than the records themselves.
  • automation string: Type of automation to filter by.

Output

• output array
  • items AutomationEntity

postAutomations

Create Automation

files.postAutomations({
  "automation": ""
}, context)

Input

• input object
  • automation required string: Type of automation. One of: create_folder, request_file, request_move
  • source string: Source Path
  • destination 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.
  • 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.

Output

• output AutomationEntity

deleteAutomationsId

Delete Automation

files.deleteAutomationsId({
  "id": 0
}, context)

Input

• input object
  • id required integer: Automation ID.

Output

Output schema unknown

getAutomationsId

Show Automation

files.getAutomationsId({
  "id": 0
}, context)

Input

• input object
  • id required integer: Automation ID.

Output

• output AutomationEntity

patchAutomationsId

Update Automation

files.patchAutomationsId({
  "id": 0,
  "automation": ""
}, context)

Input

• input object
  • id required integer: Automation ID.
  • automation required string: Type of automation. One of: create_folder, request_file, request_move
  • source string: Source Path
  • destination 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.
  • 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.

Output

• output AutomationEntity

getBehaviors

List Behaviors

files.getBehaviors({}, context)

Input

• input object
  • page integer: Current page number.
  • per_page integer: Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
  • action string: Deprecated: If set to count returns a count of matching records rather than the records themselves.
  • behavior string: If set, only shows folder behaviors matching this behavior type.

Output

• output array
  • items BehaviorEntity

postBehaviors

Create Behavior

files.postBehaviors({
  "path": "",
  "behavior": ""
}, context)

Input

• input object
  • value string: The value of the folder behavior. Can be a integer, array, or hash depending on the type of folder behavior.
  • attachment_file string, object: Certain behaviors may require a file, for instance, the "watermark" behavior requires a watermark image
    • content string
    • encoding string (values: ascii, utf8, utf16le, base64, binary, hex)
    • contentType string
    • filename string
  • path required string: Folder behaviors path.
  • behavior required string: Behavior type.

Output

• output BehaviorEntity

behaviors.folders._path.get

List Behaviors by path

files.behaviors.folders._path.get({
  "path": ""
}, context)

Input

• input object
  • page integer: Current page number.
  • per_page integer: Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
  • action string: Deprecated: If set to count returns a count of matching records rather than the records themselves.
  • path required string: Path to operate on.
  • recursive string: Show behaviors above this path?
  • behavior string: If set only shows folder behaviors matching this behavior type.

Output

• output array
  • items BehaviorEntity

postBehaviorsWebhookTest

Test webhook.

files.postBehaviorsWebhookTest({
  "url": ""
}, context)

Input

• input object
  • url required string: URL for testing the webhook.
  • method string: HTTP method(GET or POST).
  • encoding string: HTTP encoding method. Can be JSON, XML, or RAW (form data).

Output

• output StatusEntity

deleteBehaviorsId

Delete Behavior

files.deleteBehaviorsId({
  "id": 0
}, context)

Input

• input object
  • id required integer: Behavior ID.

Output

Output schema unknown

getBehaviorsId

Show Behavior

files.getBehaviorsId({
  "id": 0
}, context)

Input

• input object
  • id required integer: Behavior ID.

Output

• output BehaviorEntity

patchBehaviorsId

Update Behavior

files.patchBehaviorsId({
  "id": 0
}, context)

Input

• input object
  • id required integer: Behavior ID.
  • value string: The value of the folder behavior. Can be a integer, array, or hash depending on the type of folder behavior.
  • attachment_file string, object: Certain behaviors may require a file, for instance, the "watermark" behavior requires a watermark image
    • content string
    • encoding string (values: ascii, utf8, utf16le, base64, binary, hex)
    • contentType string
    • filename string

Output

• output BehaviorEntity

getBundles

List Bundles

files.getBundles({}, context)

Input

• input object
  • user_id integer: User ID. Provide a value of 0 to operate the current session's user.
  • page integer: Current page number.
  • per_page integer: Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
  • action string: Deprecated: If set to count returns a count of matching records rather than the records themselves.

Output

• output array
  • items BundleEntity

postBundles

Create Bundle

files.postBundles({
  "paths": []
}, context)

Input

• input object
  • user_id integer: User ID. Provide a value of 0 to operate the current session's user.
  • paths required array: A list of paths to include in this bundle.
  • password string: Password for this bundle.
  • expires_at string: Bundle expiration date/time
  • description string: Public description
  • note string: Bundle internal note
  • code string: Bundle code. This code forms the end part of the Public URL.

Output

• output BundleEntity

deleteBundlesId

Delete Bundle

files.deleteBundlesId({
  "id": 0
}, context)

Input

• input object
  • id required integer: Bundle ID.

Output

Output schema unknown

getBundlesId

Show Bundle

files.getBundlesId({
  "id": 0
}, context)

Input

• input object
  • id required integer: Bundle ID.

Output

• output BundleEntity

patchBundlesId

Update Bundle

files.patchBundlesId({
  "id": 0
}, context)

Input

• input object
  • id required integer: Bundle ID.
  • password string: Password for this bundle.
  • expires_at string: Bundle expiration date/time
  • description string: Public description
  • note string: Bundle internal note
  • code string: Bundle code. This code forms the end part of the Public URL.

Output

• output BundleEntity

postBundlesIdShare

Send email(s) with a link to bundle

files.postBundlesIdShare({
  "id": 0,
  "to": []
}, context)

Input

• input object
  • id required integer: Bundle ID.
  • to required array: A list of email addresses to share this bundle with.
  • note string: Note to include in email.

Output

Output schema unknown

getDnsRecords

Show site DNS configuration.

files.getDnsRecords({}, context)

Input

• input object
  • page integer: Current page number.
  • per_page integer: Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
  • action string: Deprecated: If set to count returns a count of matching records rather than the records themselves.

Output

• output array
  • items DnsRecordEntity

BeginUpload

Begin file upload

files.BeginUpload({
  "path": ""
}, context)

Input

• input object
  • path required string: Path to operate on.
  • mkdir_parents boolean: Create parent directories if they do not exist?
  • part integer: Part if uploading a part.
  • parts integer: How many parts to fetch?
  • ref string
  • restart integer: File byte offset to restart from.
  • with_rename boolean: Allow file rename instead of overwrite?

Output

• output FilePartUploadEntity

Copy

Copy file/folder

files.Copy({
  "path": "",
  "destination": ""
}, context)

Input

• input object
  • path required string: Path to operate on.
  • destination required string: Copy destination path.

Output

Output schema unknown

Move

Move file/folder

files.Move({
  "path": "",
  "destination": ""
}, context)

Input

• input object
  • path required string: Path to operate on.
  • destination required string: Move destination path.

Output

Output schema unknown

postFileCommentReactions

Create File Comment Reaction

files.postFileCommentReactions({
  "file_comment_id": 0,
  "emoji": ""
}, context)

Input

• input object
  • user_id integer: User ID. Provide a value of 0 to operate the current session's user.
  • file_comment_id required integer: ID of file comment to attach reaction to.
  • emoji required string: Emoji to react with.

Output

• output FileCommentReactionEntity

deleteFileCommentReactionsId

Delete File Comment Reaction

files.deleteFileCommentReactionsId({
  "id": 0
}, context)

Input

• input object
  • id required integer: File Comment Reaction ID.

Output

Output schema unknown

postFileComments

Create File Comment

files.postFileComments({
  "body": "",
  "path": ""
}, context)

Input

• input object
  • body required string: Comment body.
  • path required string: File path.

Output

• output FileCommentEntity

file_comments.files._path.get

List File Comments by path

files.file_comments.files._path.get({
  "path": ""
}, context)

Input

• input object
  • page integer: Current page number.
  • per_page integer: Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
  • action string: Deprecated: If set to count returns a count of matching records rather than the records themselves.
  • path required string: Path to operate on.

Output

• output array
  • items FileCommentEntity

deleteFileCommentsId

Delete File Comment

files.deleteFileCommentsId({
  "id": 0
}, context)

Input

• input object
  • id required integer: File Comment ID.

Output

Output schema unknown

patchFileCommentsId

Update File Comment

files.patchFileCommentsId({
  "id": 0,
  "body": ""
}, context)

Input

• input object
  • id required integer: File Comment ID.
  • body required string: Comment body.

Output

• output FileCommentEntity

files._path.delete

Delete file/folder

files.files._path.delete({
  "path": ""
}, context)

Input

• input object
  • path required string: Path to operate on.
  • recursive boolean: If true, will recursively delete folers. Otherwise, will error on non-empty folders. For legacy reasons, this parameter may also be provided as the HTTP header Depth: Infinity

Output

Output schema unknown

Download

Download file

files.Download({
  "path": ""
}, context)

Input

• input object
  • path required string: Path to operate on.
  • action string: 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.
  • id integer: If provided, lookup the file by id instead of path.
  • with_previews boolean: Include file preview information?
  • with_priority_color boolean: Include file priority color information?

Output

• output FileEntity

files._path.patch

Update file/folder metadata

files.files._path.patch({
  "path": ""
}, context)

Input

• input object
  • path required string: Path to operate on.
  • provided_mtime string: Modified time of file.
  • priority_color string: Priority/Bookmark color of file.

Output

• output FileEntity

files._path.post

Upload file

files.files._path.post({
  "path": "",
  "etags[etag]": [],
  "etags[part]": []
}, context)

Input

• input object
  • path required string: Path to operate on.
  • action string: The action to perform. Can be append, attachment, end, upload, put, or may not exist
  • etagsetag required array: etag identifier.
  • etagspart required array: Part number.
  • length integer: Length of file.
  • mkdir_parents boolean: Create parent directories if they do not exist?
  • part integer: Part if uploading a part.
  • parts integer: How many parts to fetch?
  • provided_mtime string: User provided modification time.
  • ref string
  • restart integer: File byte offset to restart from.
  • size integer: Size of file.
  • structure string: If copying folder, copy just the structure?
  • with_rename boolean: Allow file rename instead of overwrite?

Output

• output FileEntity

folders._path.get

List Folders by path

files.folders._path.get({
  "path": ""
}, context)

Input

• input object
  • page integer: Current page number.
  • per_page integer: Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
  • action string: Action to take. Can be count, count_nrs (non recursive), size, permissions, or blank.
  • path required string: Path to operate on.
  • cursor string: 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.
  • filter string: If specified, will to filter folders/files list by this string. Wildcards of * and ? are acceptable here.
  • preview_size string: Request a preview size. Can be small (default), large, xlarge, or pdf.
  • search string: If search_all is true, provide the search string here. Otherwise, this parameter acts like an alias of filter.
  • search_all boolean: Search entire site?
  • with_priority_color boolean: Include file priority color information?

Output

• output array
  • items FileEntity

folders._path.post

Create folder

files.folders._path.post({
  "path": ""
}, context)

Input

• input object
  • path required string: Path to operate on.

Output

• output FileEntity

getGroupUsers

List Group Users

files.getGroupUsers({}, context)

Input

• input object
  • user_id integer: User ID. If provided, will return groups of which this user is a member.
  • page integer: Current page number.
  • per_page integer: Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
  • action string: Deprecated: If set to count returns a count of matching records rather than the records themselves.
  • group_id integer: Group ID. If provided, will return members of this group.

Output

• output array
  • items GroupUserEntity

deleteGroupUsersId

Delete Group User

files.deleteGroupUsersId({
  "id": 0
}, context)

Input

• input object
  • id required integer: Group User ID.

Output

Output schema unknown

patchGroupUsersId

Update Group User

files.patchGroupUsersId({
  "id": 0,
  "group_id": 0,
  "user_id": 0
}, context)

Input

• input object
  • id required integer: Group User ID.
  • group_id required integer: Group ID to add user to.
  • user_id required integer: User ID to add to group.
  • admin boolean: Is the user a group administrator?

Output

• output GroupUserEntity

getGroups

List Groups

files.getGroups({}, context)

Input

• input object
  • page integer: Current page number.
  • per_page integer: Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
  • action string: Deprecated: If set to count returns a count of matching records rather than the records themselves.
  • ids string: Comma-separated list of group ids to include in results.

Output

• output array
  • items GroupEntity

postGroups

Create Group

files.postGroups({}, context)

Input

• input object
  • 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.

Output

• output GroupEntity

deleteGroupsGroupIdMembershipsUserId

Delete Group User

files.deleteGroupsGroupIdMembershipsUserId({
  "group_id": 0,
  "user_id": 0
}, context)

Input

• input object
  • group_id required integer
  • user_id required integer

Output

Output schema unknown

patchGroupsGroupIdMembershipsUserId

Update Group User

files.patchGroupsGroupIdMembershipsUserId({
  "group_id": 0,
  "user_id": 0
}, context)

Input

• input object
  • group_id required integer: Group ID to add user to.
  • user_id required integer: User ID to add to group.
  • admin boolean: Is the user a group administrator?

Output

• output GroupUserEntity

getGroupsGroupIdPermissions

List Permissions

files.getGroupsGroupIdPermissions({
  "group_id": ""
}, context)

Input

• input object
  • page integer: Current page number.
  • per_page integer: Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
  • action string: Deprecated: If set to count returns a count of matching records rather than the records themselves.
  • path string: Permission path. If provided, will scope permissions to this path.
  • group_id required string: Group ID. If provided, will scope permissions to this group.
  • user_id string: User ID. If provided, will scope permissions to this user.
  • include_groups boolean: If searching by user or group, also include user's permissions that are inherited from its groups?

Output

• output array
  • items PermissionEntity

getGroupsGroupIdUsers

List Group Users

files.getGroupsGroupIdUsers({
  "group_id": 0
}, context)

Input

• input object
  • user_id integer: User ID. If provided, will return groups of which this user is a member.
  • page integer: Current page number.
  • per_page integer: Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
  • action string: Deprecated: If set to count returns a count of matching records rather than the records themselves.
  • group_id required integer: Group ID. If provided, will return members of this group.

Output

• output array
  • items GroupUserEntity

postGroupsGroupIdUsers

Create User

files.postGroupsGroupIdUsers({
  "group_id": 0
}, context)

Input

• input object
  • avatar_file string, object: An image file for your user avatar.
    • content string
    • encoding string (values: ascii, utf8, utf16le, base64, binary, hex)
    • contentType string
    • filename string
  • 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, preview, or history.
  • group_id required integer: Group ID to associate this user with.
  • group_ids string: A list of group ids to associate this user with. Comma delimited.
  • 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: Can the user create Bundles (aka Share Links)? This field will be aliased or renamed in the future to bundles_permission.
  • authenticate_until string: Scheduled Date/Time at which user will be deactivated
  • authentication_method string (values: password, ldap, sso, none): 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?
  • language string: Preferred language
  • notification_daily_send_time integer: Hour of the day at which daily notifications should be sent. Can be in range 0 to 23
  • name string: User's full name
  • notes string: Any internal notes on the user
  • password_validity_days integer: 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 (values: use_system_setting, always_require, never_require): SSL required setting
  • sso_strategy_id integer: SSO (Single Sign On) strategy ID for the user, if applicable.
  • subscribe_to_newsletter boolean: Is the user subscribed to the newsletter?
  • 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

Output

• output UserEntity

deleteGroupsId

Delete Group

files.deleteGroupsId({
  "id": 0
}, context)

Input

• input object
  • id required integer: Group ID.

Output

Output schema unknown

getGroupsId

Show Group

files.getGroupsId({
  "id": 0
}, context)

Input

• input object
  • id required integer: Group ID.

Output

• output GroupEntity

patchGroupsId

Update Group

files.patchGroupsId({
  "id": 0
}, context)

Input

• input object
  • id required integer: Group ID.
  • 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.

Output

• output GroupEntity

List

List site full action history.

files.List({}, context)

Input

• input object
  • start_at string: Leave blank or set to a date/time to filter earlier entries.
  • end_at string: Leave blank or set to a date/time to filter later entries.
  • display string: Display format. Leave blank or set to full or parent.
  • page integer: Current page number.
  • per_page integer: Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
  • action string: Deprecated: If set to count returns a count of matching records rather than the records themselves.

Output

• output array
  • items ActionEntity

ListForFile

List history for specific file.

files.ListForFile({
  "path": ""
}, context)

Input

• input object
  • start_at string: Leave blank or set to a date/time to filter earlier entries.
  • end_at string: Leave blank or set to a date/time to filter later entries.
  • display string: Display format. Leave blank or set to full or parent.
  • page integer: Current page number.
  • per_page integer: Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
  • action string: Deprecated: If set to count returns a count of matching records rather than the records themselves.
  • path required string: Path to operate on.

Output

• output array
  • items ActionEntity

ListForFolder

List history for specific folder.

files.ListForFolder({
  "path": ""
}, context)

Input

• input object
  • start_at string: Leave blank or set to a date/time to filter earlier entries.
  • end_at string: Leave blank or set to a date/time to filter later entries.
  • display string: Display format. Leave blank or set to full or parent.
  • page integer: Current page number.
  • per_page integer: Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
  • action string: Deprecated: If set to count returns a count of matching records rather than the records themselves.
  • path required string: Path to operate on.

Output

• output array
  • items ActionEntity

ListLogins

List site login history.

files.ListLogins({}, context)

Input

• input object
  • start_at string: Leave blank or set to a date/time to filter earlier entries.
  • end_at string: Leave blank or set to a date/time to filter later entries.
  • display string: Display format. Leave blank or set to full or parent.
  • page integer: Current page number.
  • per_page integer: Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
  • action string: Deprecated: If set to count returns a count of matching records rather than the records themselves.

Output

• output array
  • items ActionEntity

ListForUser

List history for specific user.

files.ListForUser({
  "user_id": 0
}, context)

Input

• input object
  • start_at string: Leave blank or set to a date/time to filter earlier entries.
  • end_at string: Leave blank or set to a date/time to filter later entries.
  • display string: Display format. Leave blank or set to full or parent.
  • page integer: Current page number.
  • per_page integer: Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
  • action string: Deprecated: If set to count returns a count of matching records rather than the records themselves.
  • user_id required integer: User ID.

Output

• output array
  • items ActionEntity

getHistoryExports

List History Exports

files.getHistoryExports({}, context)

Input

• input object
  • user_id integer: User ID. Provide a value of 0 to operate the current session's user.
  • page integer: Current page number.
  • per_page integer: Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
  • action string: Deprecated: If set to count returns a count of matching records rather than the records themselves.

Output

• output array
  • items HistoryExportEntity

postHistoryExports

Create History Export

files.postHistoryExports({}, context)

Input

• input object
  • user_id integer: 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
  • query_user_id integer: Return results that are actions performed by the user indiciated by this User ID
  • query_file_id integer: Return results that are file actions related to the file indicated by this File ID
  • query_parent_id integer: 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
  • query_target_id integer: 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 integer: 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.

Output

• output HistoryExportEntity

deleteHistoryExportsId

Delete History Export

files.deleteHistoryExportsId({
  "id": 0
}, context)

Input

• input object
  • id required integer: History Export ID.

Output

Output schema unknown

getHistoryExportsId

Show History Export

files.getHistoryExportsId({
  "id": 0
}, context)

Input

• input object
  • id required integer: History Export ID.

Output

• output HistoryExportEntity

getInvoices

List Invoices

files.getInvoices({}, context)

Input

• input object
  • page integer: Current page number.
  • per_page integer: Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
  • action string: Deprecated: If set to count returns a count of matching records rather than the records themselves.

Output

• output array
  • items AccountLineItemEntity

getInvoicesId

Show Invoice

files.getInvoicesId({
  "id": 0
}, context)

Input

• input object
  • id required integer: Invoice ID.

Output

• output AccountLineItemEntity

getIpAddresses

List Ip Addresses

files.getIpAddresses({}, context)

Input

• input object
  • page integer: Current page number.
  • per_page integer: Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
  • action string: Deprecated: If set to count returns a count of matching records rather than the records themselves.

Output

• output array
  • items IpAddressEntity

locks._path.delete

Delete Lock

files.locks._path.delete({
  "path": "",
  "token": ""
}, context)

Input

• input object
  • path required string: Path
  • token required string: Lock token

Output

Output schema unknown

locks._path.get

List Locks by path

files.locks._path.get({
  "path": ""
}, context)

Input

• input object
  • page integer: Current page number.
  • per_page integer: Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
  • action string: Deprecated: If set to count returns a count of matching records rather than the records themselves.
  • path required string: Path to operate on.
  • include_children boolean: Include locks from children objects?

Output

• output array
  • items LockEntity

locks._path.post

Create Lock

files.locks._path.post({
  "path": ""
}, context)

Input

• input object
  • path required string: Path
  • timeout integer: Lock timeout length

Output

• output LockEntity

getMessageCommentReactions

List Message Comment Reactions

files.getMessageCommentReactions({
  "message_comment_id": 0
}, context)

Input

• input object
  • user_id integer: User ID. Provide a value of 0 to operate the current session's user.
  • page integer: Current page number.
  • per_page integer: Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
  • action string: Deprecated: If set to count returns a count of matching records rather than the records themselves.
  • message_comment_id required integer: Message comment to return reactions for.

Output

• output array
  • items MessageCommentReactionEntity

postMessageCommentReactions

Create Message Comment Reaction

files.postMessageCommentReactions({
  "emoji": ""
}, context)

Input

• input object
  • user_id integer: User ID. Provide a value of 0 to operate the current session's user.
  • emoji required string: Emoji to react with.

Output

• output MessageCommentReactionEntity

deleteMessageCommentReactionsId

Delete Message Comment Reaction

files.deleteMessageCommentReactionsId({
  "id": 0
}, context)

Input

• input object
  • id required integer: Message Comment Reaction ID.

Output

Output schema unknown

getMessageCommentReactionsId

Show Message Comment Reaction

files.getMessageCommentReactionsId({
  "id": 0
}, context)

Input

• input object
  • id required integer: Message Comment Reaction ID.

Output

• output MessageCommentReactionEntity

getMessageComments

List Message Comments

files.getMessageComments({
  "message_id": 0
}, context)

Input

• input object
  • user_id integer: User ID. Provide a value of 0 to operate the current session's user.
  • page integer: Current page number.
  • per_page integer: Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
  • action string: Deprecated: If set to count returns a count of matching records rather than the records themselves.
  • message_id required integer: Message comment to return comments for.

Output

• output array
  • items MessageCommentEntity

postMessageComments

Create Message Comment

files.postMessageComments({
  "body": ""
}, context)

Input

• input object
  • user_id integer: User ID. Provide a value of 0 to operate the current session's user.
  • body required string: Comment body.

Output

• output MessageCommentEntity

deleteMessageCommentsId

Delete Message Comment

files.deleteMessageCommentsId({
  "id": 0
}, context)

Input

• input object
  • id required integer: Message Comment ID.

Output

Output schema unknown

getMessageCommentsId

Show Message Comment

files.getMessageCommentsId({
  "id": 0
}, context)

Input

• input object
  • id required integer: Message Comment ID.

Output

• output MessageCommentEntity

patchMessageCommentsId

Update Message Comment

files.patchMessageCommentsId({
  "id": 0,
  "body": ""
}, context)

Input

• input object
  • id required integer: Message Comment ID.
  • body required string: Comment body.

Output

• output MessageCommentEntity

getMessageReactions

List Message Reactions

files.getMessageReactions({
  "message_id": 0
}, context)

Input

• input object
  • user_id integer: User ID. Provide a value of 0 to operate the current session's user.
  • page integer: Current page number.
  • per_page integer: Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
  • action string: Deprecated: If set to count returns a count of matching records rather than the records themselves.
  • message_id required integer: Message to return reactions for.

Output

• output array
  • items MessageReactionEntity

postMessageReactions

Create Message Reaction

files.postMessageReactions({
  "emoji": ""
}, context)

Input

• input object
  • user_id integer: User ID. Provide a value of 0 to operate the current session's user.
  • emoji required string: Emoji to react with.

Output

• output MessageReactionEntity

deleteMessageReactionsId

Delete Message Reaction

files.deleteMessageReactionsId({
  "id": 0
}, context)

Input

• input object
  • id required integer: Message Reaction ID.

Output

Output schema unknown

getMessageReactionsId

Show Message Reaction

files.getMessageReactionsId({
  "id": 0
}, context)

Input

• input object
  • id required integer: Message Reaction ID.

Output

• output MessageReactionEntity

getMessages

List Messages

files.getMessages({
  "project_id": 0
}, context)

Input

• input object
  • user_id integer: User ID. Provide a value of 0 to operate the current session's user.
  • page integer: Current page number.
  • per_page integer: Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
  • action string: Deprecated: If set to count returns a count of matching records rather than the records themselves.
  • project_id required integer: Project to return messages for.

Output

• output array
  • items MessageEntity

postMessages

Create Message

files.postMessages({
  "project_id": 0,
  "subject": "",
  "body": ""
}, context)

Input

• input object
  • user_id integer: User ID. Provide a value of 0 to operate the current session's user.
  • project_id required integer: Project to attach the message to.
  • subject required string: Message subject.
  • body required string: Message body.

Output

• output MessageEntity

deleteMessagesId

Delete Message

files.deleteMessagesId({
  "id": 0
}, context)

Input

• input object
  • id required integer: Message ID.

Output

Output schema unknown

getMessagesId

Show Message

files.getMessagesId({
  "id": 0
}, context)

Input

• input object
  • id required integer: Message ID.

Output

• output MessageEntity

patchMessagesId

Update Message

files.patchMessagesId({
  "id": 0,
  "project_id": 0,
  "subject": "",
  "body": ""
}, context)

Input

• input object
  • id required integer: Message ID.
  • project_id required integer: Project to attach the message to.
  • subject required string: Message subject.
  • body required string: Message body.

Output

• output MessageEntity

getNotifications

List Notifications

files.getNotifications({}, context)

Input

• input object
  • user_id integer: Show notifications for this User ID.
  • page integer: Current page number.
  • per_page integer: Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
  • action string: Deprecated: If set to count returns a count of matching records rather than the records themselves.
  • group_id integer: Show notifications for this Group ID.

Output

• output array
  • items NotificationEntity

postNotifications

Create Notification

files.postNotifications({}, context)

Input

• input object
  • user_id integer: The id of the user to notify. Provide user_id, username or group_id.
  • notify_on_copy boolean: If true, copying or moving resources into this path will trigger a notification, in addition to just uploads.
  • notify_user_actions boolean: If true actions initiated by the user will still result in a notification
  • send_interval string: The time interval that notifications are aggregated by. Can be five_minutes, fifteen_minutes, hourly, or daily.
  • group_id integer: The ID of the group to notify. Provide user_id, username or group_id.
  • path string: Path
  • username string: The username of the user to notify. Provide user_id, username or group_id.

Output

• output NotificationEntity

deleteNotificationsId

Delete Notification

files.deleteNotificationsId({
  "id": 0
}, context)

Input

• input object
  • id required integer: Notification ID.

Output

Output schema unknown

getNotificationsId

Show Notification

files.getNotificationsId({
  "id": 0
}, context)

Input

• input object
  • id required integer: Notification ID.

Output

• output NotificationEntity

patchNotificationsId

Update Notification

files.patchNotificationsId({
  "id": 0
}, context)

Input

• input object
  • id required integer: Notification ID.
  • notify_on_copy boolean: If true, copying or moving resources into this path will trigger a notification, in addition to just uploads.
  • notify_user_actions boolean: If true actions initiated by the user will still result in a notification
  • send_interval string: The time interval that notifications are aggregated by. Can be five_minutes, fifteen_minutes, hourly, or daily.

Output

• output NotificationEntity

getPayments

List Payments

files.getPayments({}, context)

Input

• input object
  • page integer: Current page number.
  • per_page integer: Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
  • action string: Deprecated: If set to count returns a count of matching records rather than the records themselves.

Output

• output array
  • items AccountLineItemEntity

getPaymentsId

Show Payment

files.getPaymentsId({
  "id": 0
}, context)

Input

• input object
  • id required integer: Payment ID.

Output

• output AccountLineItemEntity

getPermissions

List Permissions

files.getPermissions({}, context)

Input

• input object
  • page integer: Current page number.
  • per_page integer: Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
  • action string: Deprecated: If set to count returns a count of matching records rather than the records themselves.
  • path string: Permission path. If provided, will scope permissions to this path.
  • group_id string: Group ID. If provided, will scope permissions to this group.
  • user_id string: User ID. If provided, will scope permissions to this user.
  • include_groups boolean: If searching by user or group, also include user's permissions that are inherited from its groups?

Output

• output array
  • items PermissionEntity

postPermissions

Create Permission

files.postPermissions({}, context)

Input

• input object
  • group_id integer: Group ID
  • path string: Folder path
  • permission string: Permission type. Can be admin, full, readonly, writeonly, previewonly, or history
  • recursive boolean: Apply to subfolders recursively?
  • user_id integer: User ID. Provide username or user_id
  • username string: User username. Provide username or user_id

Output

• output PermissionEntity

deletePermissionsId

Delete Permission

files.deletePermissionsId({
  "id": 0
}, context)

Input

• input object
  • id required integer: Permission ID.

Output

Output schema unknown

getProjects

List Projects

files.getProjects({}, context)

Input

• input object
  • page integer: Current page number.
  • per_page integer: Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
  • action string: Deprecated: If set to count returns a count of matching records rather than the records themselves.

Output

• output array
  • items ProjectEntity

postProjects

Create Project

files.postProjects({
  "global_access": ""
}, context)

Input

• input object
  • global_access required string: Global permissions. Can be: none, anyone_with_read, anyone_with_full.

Output

• output ProjectEntity

deleteProjectsId

Delete Project

files.deleteProjectsId({
  "id": 0
}, context)

Input

• input object
  • id required integer: Project ID.

Output

Output schema unknown

getProjectsId

Show Project

files.getProjectsId({
  "id": 0
}, context)

Input

• input object
  • id required integer: Project ID.

Output

• output ProjectEntity

patchProjectsId

Update Project

files.patchProjectsId({
  "id": 0,
  "global_access": ""
}, context)

Input

• input object
  • id required integer: Project ID.
  • global_access required string: Global permissions. Can be: none, anyone_with_read, anyone_with_full.

Output

• output ProjectEntity

getPublicKeys

List Public Keys

files.getPublicKeys({}, context)

Input

• input object
  • user_id integer: User ID. Provide a value of 0 to operate the current session's user.
  • page integer: Current page number.
  • per_page integer: Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
  • action string: Deprecated: If set to count returns a count of matching records rather than the records themselves.

Output

• output array
  • items PublicKeyEntity

postPublicKeys

Create Public Key

files.postPublicKeys({
  "title": "",
  "public_key": ""
}, context)

Input

• input object
  • user_id integer: User ID. Provide a value of 0 to operate the current session's user.
  • title required string: Internal reference for key.
  • public_key required string: Actual contents of SSH key.

Output

• output PublicKeyEntity

deletePublicKeysId

Delete Public Key

files.deletePublicKeysId({
  "id": 0
}, context)

Input

• input object
  • id required integer: Public Key ID.

Output

Output schema unknown

getPublicKeysId

Show Public Key

files.getPublicKeysId({
  "id": 0
}, context)

Input

• input object
  • id required integer: Public Key ID.

Output

• output PublicKeyEntity

patchPublicKeysId

Update Public Key

files.patchPublicKeysId({
  "id": 0,
  "title": ""
}, context)

Input

• input object
  • id required integer: Public Key ID.
  • title required string: Internal reference for key.

Output

• output PublicKeyEntity

getRemoteServers

List Remote Servers

files.getRemoteServers({}, context)

Input

• input object
  • page integer: Current page number.
  • per_page integer: Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
  • action string: Deprecated: If set to count returns a count of matching records rather than the records themselves.

Output

• output array
  • items RemoteServerEntity

postRemoteServers

Create Remote Server

files.postRemoteServers({}, context)

Input

• input object
  • aws_access_key string: AWS Access Key.
  • aws_secret_key string: AWS secret key.
  • password string: Password if needed.
  • private_key string: Private key if needed.
  • google_cloud_storage_credentials_json string: A JSON file that contains the private key. To generate see https://cloud.google.com/storage/docs/json_api/v1/how-tos/authorizing#APIKey
  • wasabi_access_key string: Wasabi access key.
  • wasabi_secret_key string: Wasabi secret key.
  • backblaze_b2_key_id string: Backblaze B2 Cloud Storage keyID.
  • backblaze_b2_application_key string: Backblaze B2 Cloud Storage applicationKey.
  • hostname string: Hostname or IP address
  • name string: Internal name for your reference
  • max_connections integer: Max number of parallel connections. Ignored for S3 connections (we will parallelize these as much as possible).
  • port integer: Port for remote server. Not needed for S3.
  • s3_bucket string: S3 bucket name
  • s3_region string: S3 region
  • server_certificate string (values: require_match, allow_any): Remote server certificate
  • server_host_key string: Remote server SSH Host Key. If provided, we will require that the server host key matches the provided key. Uses OpenSSH format similar to what would go into ~/.ssh/known_hosts
  • server_type string (values: ftp, sftp, s3, google_cloud_storage, webdav, wasabi, backblaze_b2): Remote server type.
  • ssl string (values: if_available, require, require_implicit, never): Should we require SSL?
  • username string: Remote server username. Not needed for S3 buckets.
  • google_cloud_storage_bucket string: Google Cloud Storage bucket name
  • google_cloud_storage_project_id string: Google Cloud Project ID
  • backblaze_b2_bucket string: Backblaze B2 Cloud Storage Bucket name
  • backblaze_b2_s3_endpoint string: Backblaze B2 Cloud Storage S3 Endpoint
  • wasabi_bucket string: Wasabi region
  • wasabi_region string: Wasabi Bucket name

Output

• output RemoteServerEntity

deleteRemoteServersId

Delete Remote Server

files.deleteRemoteServersId({
  "id": 0
}, context)

Input

• input object
  • id required integer: Remote Server ID.

Output

Output schema unknown

getRemoteServersId

Show Remote Server

files.getRemoteServersId({
  "id": 0
}, context)

Input

• input object
  • id required integer: Remote Server ID.

Output

• output RemoteServerEntity

patchRemoteServersId

Update Remote Server

files.patchRemoteServersId({
  "id": 0
}, context)

Input

• input object
  • id required integer: Remote Server ID.
  • aws_access_key string: AWS Access Key.
  • aws_secret_key string: AWS secret key.
  • password string: Password if needed.
  • private_key string: Private key if needed.
  • google_cloud_storage_credentials_json string: A JSON file that contains the private key. To generate see https://cloud.google.com/storage/docs/json_api/v1/how-tos/authorizing#APIKey
  • wasabi_access_key string: Wasabi access key.
  • wasabi_secret_key string: Wasabi secret key.
  • backblaze_b2_key_id string: Backblaze B2 Cloud Storage keyID.
  • backblaze_b2_application_key string: Backblaze B2 Cloud Storage applicationKey.
  • hostname string: Hostname or IP address
  • name string: Internal name for your reference
  • max_connections integer: Max number of parallel connections. Ignored for S3 connections (we will parallelize these as much as possible).
  • port integer: Port for remote server. Not needed for S3.
  • s3_bucket string: S3 bucket name
  • s3_region string: S3 region
  • server_certificate string (values: require_match, allow_any): Remote server certificate
  • server_host_key string: Remote server SSH Host Key. If provided, we will require that the server host key matches the provided key. Uses OpenSSH format similar to what would go into ~/.ssh/known_hosts
  • server_type string (values: ftp, sftp, s3, google_cloud_storage, webdav, wasabi, backblaze_b2): Remote server type.
  • ssl string (values: if_available, require, require_implicit, never): Should we require SSL?
  • username string: Remote server username. Not needed for S3 buckets.
  • google_cloud_storage_bucket string: Google Cloud Storage bucket name
  • google_cloud_storage_project_id string: Google Cloud Project ID
  • backblaze_b2_bucket string: Backblaze B2 Cloud Storage Bucket name
  • backblaze_b2_s3_endpoint string: Backblaze B2 Cloud Storage S3 Endpoint
  • wasabi_bucket string: Wasabi region
  • wasabi_region string: Wasabi Bucket name

Output

• output RemoteServerEntity

getRequests

List Requests

files.getRequests({}, context)

Input

• input object
  • page integer: Current page number.
  • per_page integer: Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
  • action string: Deprecated: If set to count returns a count of matching records rather than the records themselves.
  • mine boolean: Only show requests of the current user? (Defaults to true if current user is not a site admin.)
  • path string: Path to show requests for. If omitted, shows all paths. Send / to represent the root directory.

Output

• output array
  • items RequestEntity

postRequests

Create Request

files.postRequests({
  "path": "",
  "destination": ""
}, context)

Input

• input object
  • path required string: Folder path on which to request the file.
  • destination required string: Destination filename (without extension) to request.
  • user_ids string: A list of user IDs to request the file from. If sent as a string, it should be comma-delimited.
  • group_ids string: A list of group IDs to request the file from. If sent as a string, it should be comma-delimited.

Output

• output RequestEntity

requests.folders._path.get

List Requests

files.requests.folders._path.get({}, context)

Input

• input object
  • page integer: Current page number.
  • per_page integer: Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
  • action string: Deprecated: If set to count returns a count of matching records rather than the records themselves.
  • mine boolean: Only show requests of the current user? (Defaults to true if current user is not a site admin.)
  • path string: Path to show requests for. If omitted, shows all paths. Send / to represent the root directory.

Output

• output array
  • items RequestEntity

deleteRequestsId

Delete Request

files.deleteRequestsId({
  "id": 0
}, context)

Input

• input object
  • id required integer: Request ID.

Output

Output schema unknown

deleteSessions

Delete user session (log out)

files.deleteSessions(null, context)

Input

This action has no parameters

Output

Output schema unknown

postSessions

Create user session (log in)

files.postSessions({}, context)

Input

• input object
  • username string: Username to sign in as
  • password string: Password for sign in
  • otp string: If this user has a 2FA device, provide its OTP or code here.
  • partial_session_id string: Identifier for a partially-completed login

Output

• output SessionEntity

getSite

Show site settings

files.getSite(null, context)

Input

This action has no parameters

Output

• output SiteEntity

patchSite

Update site settings.

files.patchSite({}, context)

Input

• input object
  • name string: Site name
  • subdomain string: Site subdomain
  • domain string: Custom domain
  • email string: Main email for this site
  • allow_bundle_names boolean: Are manual Bundle names allowed?
  • bundle_expiration integer: Site-wide Bundle expiration in days
  • overage_notify boolean: Notify site email of overages?
  • welcome_email_enabled boolean: Will the welcome email be sent to new users