Menu
An APIKey is a key that allows programmatic access to your Site.
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
Based on SOC occupation classification
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.
| name | filescom-api-keys |
| description | An APIKey is a key that allows programmatic access to your Site. |
An APIKey is a key that allows programmatic access to your Site.
API keys confer all the permissions of the user who owns them unless the key uses a restricted permission set.
If an API key is created without a user owner, it is considered a site-wide API key. Site-wide API keys with the files_only permission set are restricted to file-user permissions and workspace scoping.
We recommend registering API keys to service users wherever possible and then using User or Group Permissions to restrict that API Key appropriately.
All subcommands also accept the global flags documented in CONTEXT.md (--api-key, --format, --workspace-id, --debug, and the pagination flags --cursor / --per-page / --max-pages on list). Those are not repeated below.
files-cli api-keys listList API Keys.
| Flag | Type | Description |
|---|---|---|
--user-id | int64 | User ID. Provide a value of 0 to operate the current session's user. |
--sort-by | object | If set, sort records by the specified field in either asc or desc direction. Valid fields are site_id and workspace_id. |
--filter | object | If set, return records where the specified field is equal to the supplied value. Valid fields are aws_style_credentials and expires_at. |
--filter-gt | object | If set, return records where the specified field is greater than the supplied value. Valid fields are expires_at. |
--filter-gteq | object | If set, return records where the specified field is greater than or equal the supplied value. Valid fields are expires_at. |
--filter-lt | object | If set, return records where the specified field is less than the supplied value. Valid fields are expires_at. |
--filter-lteq | object | If set, return records where the specified field is less than or equal the supplied value. Valid fields are expires_at. |
files-cli api-keys find-currentShow information about current API key. (Requires current API connection to be using an API key.).
No flags beyond the global ones.
files-cli api-keys findShow API Key.
| Flag | Type | Description |
|---|---|---|
--id | int64 | Api Key ID. Required. |
files-cli api-keys create [path]Create API Key.
| Flag | Type | Description |
|---|---|---|
--user-id | int64 | User ID. Provide a value of 0 to operate the current session's user. |
--description | string | User-supplied description of API key. |
--expires-at | datetime | API Key expiration date |
--name | string | Internal name for the API Key. For your use. Required. |
--aws-style-credentials | bool | If true, this API key will be usable with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint. |
--path | string | Folder path restriction for office_integration permission set API keys. |
--permission-set | enum | 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). Keys with the office_integration permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Keys with the files_only permission set can perform file operations as a full-access file user in the key's workspace scope, but cannot use site admin, workspace admin, folder admin, group admin, partner admin, or billing privileges from the owning user. One of: none, full, desktop_app, sync_app, office_integration, mobile_app, files_only. |
--workspace-id | int64 | Workspace ID for this API Key. 0 means the default workspace. |
files-cli api-keys update-currentUpdate current API key. (Requires current API connection to be using an API key.).
| Flag | Type | Description |
|---|---|---|
--expires-at | datetime | API Key expiration date |
--name | string | Internal name for the API Key. For your use. |
--permission-set | enum | 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). Keys with the office_integration permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Keys with the files_only permission set can perform file operations as a full-access file user in the key's workspace scope, but cannot use site admin, workspace admin, folder admin, group admin, partner admin, or billing privileges from the owning user. One of: none, full, desktop_app, sync_app, office_integration, mobile_app, files_only. |
files-cli api-keys updateUpdate API Key.
| Flag | Type | Description |
|---|---|---|
--id | int64 | Api Key ID. Required. |
--description | string | User-supplied description of API key. |
--expires-at | datetime | API Key expiration date |
--name | string | Internal name for the API Key. For your use. |
files-cli api-keys delete-currentDelete current API key. (Requires current API connection to be using an API key.).
No flags beyond the global ones.
files-cli api-keys deleteDelete API Key.
| Flag | Type | Description |
|---|---|---|
--id | int64 | Api Key ID. Required. |