v4

latestSwagger 2.02026-08-0343714211.7 MB
apps
Apps

List Apps

List Apps

get/apps

Query parameters

cursorstring

Used for pagination. When a list request has more records available, cursors are provided in the response headers X-Files-Cursor-Next and X-Files-Cursor-Prev. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.

per_pageinteger

Number of records to show per page. (Max: 10000, 1,000 or less is recommended).

If set, sort records by the specified field in either asc or desc direction. Valid fields are name and app_type.

If set, return records where the specified field is equal to the supplied value. Valid fields are name and app_type. Valid field combinations are [ name, app_type ].

If set, return records where the specified field is prefixed by the supplied value. Valid fields are name.

Response

A list of Apps objects.

app_type'sdk' | 'sso' | 'remote_server' | 'folder_behavior' | 'client_app' | 'app_integration' | 'siem'

The type of the App

documentation_linksobject

Collection of named links to documentation

extended_descriptionstring

Long description for the in-App landing page

extended_description_for_marketing_sitestring

Long form description of the App

external_homepage_urlstring

Link to external homepage

featuredboolean

Is featured on the App listing?

folder_behavior_type'webhook' | 'file_expiration' | 'auto_encrypt' | 'lock_subfolders' | 'storage_region' | 'serve_publicly' | 'create_user_folders' | 'inbox' | 'limit_file_extensions' | 'limit_file_regex' | 'amazon_sns' | 'watermark' | 'remote_server_mount' | 'slack_webhook' | 'auto_decrypt' | 'override_upload_filename' | 'permission_fence' | 'limit_filename_length' | 'organize_files_into_subfolders' | 'teams_webhook' | 'google_pub_sub' | 'archive_overwritten_or_deleted_files' | 'auto_recrypt' | 'metadata_category' | 'auto_unzip' | 'remote_server_metadata_index'

Associated Folder Behavior type, if any

icon_urlstring

App icon

logo_thumbnail_urlstring

Logo thumbnail for the App

logo_urlstring

Full size logo for the App

marketing_introstring

Marketing introdution of the App

marketing_youtube_urlstring

Marketing video page

namestring

Name of the App

package_manager_install_commandstring

Package manager install command

remote_server_type'ftp' | 'sftp' | 's3' | 'google_cloud_storage' | 'webdav' | 'wasabi' | 'backblaze_b2' | 'one_drive' | 'box' | 'dropbox' | 'google_drive' | 'azure' | 'sharepoint' | 's3_compatible' | 'azure_files' | 'files_agent' | 'filebase' | 'cloudflare' | 'linode' | 'files_com'

Associated Remote Server type, if any

screenshot_list_urlsstring[]

Screenshots of the App

sdk_installation_instructions_linkstring

Link to SDK installation instructions

short_descriptionstring

Short description of the App

sso_strategy_type'google' | 'auth0' | 'okta' | 'azure' | 'box' | 'dropbox' | 'slack' | 'onelogin' | 'saml' | 'idaptive' | 'ldap' | 'scim' | 'jumpcloud' | 'duo'

Associated SSO Strategy type, if any

siem_type'generic' | 'splunk' | 'azure_legacy' | 'qradar' | 'sumo' | 'rapid7' | 'solar_winds' | 'new_relic' | 'datadog' | 'azure' | 'file' | 'crowdstrike' | 'splunk_compatible'

Associated SIEM type, if any

tutorial_youtube_urlstring

Tutorial video page

Example response

[
  {
    "app_type": "example",
    "documentation_links": {
      "Important Info": "http://files.test/learn-more"
    },
    "extended_description": "example",
    "extended_description_for_marketing_site": "example",
    "external_homepage_url": "example",
    "featured": true,
    "folder_behavior_type": "example",
    "icon_url": "example",
    "logo_thumbnail_url": "example",
    "logo_url": "example",
    "marketing_intro": "example",
    "marketing_youtube_url": "example",
    "name": "example",
    "package_manager_install_command": "example",
    "remote_server_type": "example",
    "screenshot_list_urls": [
      "example"
    ],
    "sdk_installation_instructions_link": "example",
    "short_description": "example",
    "sso_strategy_type": "example",
    "siem_type": "example",
    "tutorial_youtube_url": "example"
  }
]