files-cli

Files.com User Additional Email Recipients via files-cli.

A Holiday Calendar defines site-wide holiday dates and optional partial-day windows that scheduled resources skip.

A RemoteServerCredential is a way to store a credential for Remote Servers in a centralized vault and then reference it from Remote Server definitions.

A RemoteServer is a specific type of Behavior called `remote_server_sync`.

Files.com Files via files-cli.

Expectations let your Files.com site define what “correct” file delivery looks like, continuously evaluate whether it happened, and keep history when it did not.

An AutomationLog is an audit log for monitoring and troubleshooting triggered Automation.

An Automation is an automated process of controlling workflows on your Files.com site.

An AutomationRun is a record with information about a single execution of a given Automation.

A Behavior is an API resource for what are also known as Folder Settings.

A Site is the place you'll come to update site settings, as well as manage site-wide API keys.

A Group is a powerful tool for permissions and user management on Files.com.

An Integration Centric Profile defines the Remote Server integrations a user is expected to add and connect during integration-centric onboarding.

A User represents a human or system/service user with the ability to connect to Files.com via any of the available connectivity methods (unless restricted to specific protocols). Pick `--authentication-method` carefully at creation. Each method behaves differently: `email_signup` mails a "set your password" link; `password` requires the admin to set one upfront; `sso` defers authentication to a configured SSO strategy; `none` allows only API key or SSH key login.

A PartnerChannelTemplate defines reusable Partner Channel configuration that can be applied to Partners.

A PartnerChannel defines a structured communication path within a Partner root folder, including directional folder names and partner-scoped routing configuration.

A Partner is a first-class entity that cleanly represents an external organization, enables delegated administration, and enforces strict boundaries.

A CustomDomain object represents an additional customer-owned domain that routes to a Files.com site.

A Secret stores named, typed secret material for later use by features that reference the Secret by ID.

An AI Assistant Personality defines a system prompt used to customize the in-app AI Assistant.

A ChatSession represents one conversation with the Files.com AI Assistant.

An AI Task defines a Files.com AI prompt that can run on a schedule or in response to file actions.

An APIKey is a key that allows programmatic access to your Site.

A Bundle is the API/SDK term for the feature called Share Links in the web interface. Creating a Share Link does not send any email. To deliver the link by email, either call `bundles share` after creation, or pass `--share-after-create=true` when adding a recipient with `bundle-recipients create`.

A Permission object represents a grant of access permission on a specific Path to a User or Group. Use this skill to answer access questions — who can access a folder, and what a given user or group can access — and to grant or revoke folder access. For a full site-wide permissions report, use a `permission_audit` scheduled export (see `recipe-generating-reports`).

A Workspace is a lightweight way to organize related resources inside a single Files.com Site.

Determine storage usage and file/folder counts on Files.com from the data the agent can actually read back, without recursively walking the tree; use this when the user asks "how big is this folder", "how much storage are we using", or "how many files do we have". The agent-readable source is `usage-snapshots` / `usage-daily-snapshots` (size and file count per top-level folder) and `site/usage` (site totals). Note the important limits: usage data only breaks down by top-level folder, and the `folder_size_audit` scheduled export is emailed to a Site Admin rather than returned to the API.

Choose the right built-in Files.com report or export instead of assembling one by hand; use this when the user asks for a report, audit, export, or summary — storage/usage, bandwidth/transfer, activity/audit logs, webhook delivery, permissions, group membership, or share-link audits. Files.com already produces these as first-class resources (`usage-snapshots`, `bandwidth-snapshots`, `history-exports`, `action-notification-exports`, and `scheduled-exports`). Prefer them; only home-roll a report by listing and aggregating records when no built-in report covers the need.

Find files and folders on Files.com effectively, and pick the right tool for the job; use this when the user wants to locate files by name, path, modified time, or custom metadata. The key distinction: the `--search` / `--search-all` flags on `folders list-for` are the web search bar — best-effort, not real time, and meant only for ad-hoc human lookups — while automated or precise lookups should list a folder directly and filter deterministically. Covers both, and when to use each.

An EventChannel is a named grouping of EventSubscriptions.

A PartnerSiteRequest represents a request for a Guest Partner to add their Files.com Site to their Partnership with the Host Partner.

Files.com Partner Sites via files-cli.

A Sync represents a file synchronization job between two locations (local-remote, remote-remote, local-child_site, etc).

A KeyLifecycleRule represents a rule that applies to API keys, GPG keys, and SSH keys (also called User Public Keys) based on their inactivity or age.

A Notification is our feature that sends E-Mails when specific actions occur in the folder.

Files.com Siem Http Destinations via files-cli.

A Scheduled Export defines a recurring schedule for generating one of the built-in CSV exports and e-mailing it to a Site Admin recipient.

An ActionLog is an audit log of file actions performed by users or the system.

An ActionNotificationExportResult is a single record containing webhook log information that can be obtained as a part of Action Notification Export request.

An ActionNotificationExport is an operation that provides access to outgoing webhook logs.