FIfiles
behaviors
Behaviors

List Behaviors

Changed on

List Behaviors

get/behaviors

Request

  • Base URL
    https://app.files.com/api/rest/v1
  • URL
    https://app.files.com/api/rest/v1/behaviors
  • Auth
    none declared

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 behavior.

If set, return records where the specified field is equal to the supplied value. Valid fields are clickwrap_id, form_field_set_id, impacts_ui, remote_server_id or behavior. Valid field combinations are [ impacts_ui, behavior ] and [ behavior, remote_server_id ].

Response

A list of Behaviors objects.

idinteger

Folder behavior ID

pathstring

Folder path. Note that Behavior paths cannot be updated once initially set. You will need to remove and re-create the behavior on the new path.

attachment_urlstring

URL for attached file

behavior'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' | 'malware_scanning'

Behavior type.

namestring

Name for this behavior.

descriptionstring

Description for this behavior.

valueobject

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.

public_hosting_urlstring

Public URL for this publicly hosted folder when the Serve Publicly behavior has a key configured. When a Custom Domain with public_hosting destination is attached to this behavior, the URL uses that domain. Otherwise it uses the site's subdomain.hosted-by-files.com host, unless custom_domain_only is enabled, in which case no URL is returned.

disable_parent_folder_behaviorboolean

If true, disables the inherited behavior for this folder and its children. Valid only for behavior types that child folders may override, and requires recursive to be true. Rejected for all other behavior types.

recursiveboolean

Whether this behavior is recursive for this record. always behaviors are always true, never behaviors are always false, and sometimes behaviors may be either value.

inheritedboolean

If true, this behavior is inherited from a higher scope rather than owned by the requested workspace.

managedboolean

If true, this behavior is controlled by a parent-site policy and cannot be modified locally.

root_behavior_site_admin_onlyboolean

If true, this behavior may only be modified by a site admin because it is at the site root or disables a root behavior.

Example response

[
  {
    "id": 1,
    "path": "example",
    "attachment_url": "example",
    "behavior": "webhook",
    "name": "example",
    "description": "example",
    "public_hosting_url": "example",
    "disable_parent_folder_behavior": true,
    "recursive": true,
    "inherited": true,
    "managed": true,
    "root_behavior_site_admin_only": true
  }
]

Changes

  • e20172733728Revision changes
    • warning

      deleted the query request parameter filter_prefix

  • 3bb8c8a06041Revision changes
    • warning

      deleted the query request parameter behavior

    • warning

      deleted the query request parameter filter_gt

    • warning

      deleted the query request parameter filter_gteq

    • warning

      deleted the query request parameter filter_like

    • warning

      deleted the query request parameter filter_lt

    • warning

      deleted the query request parameter filter_lteq

    • info

      api tag Behaviors added

    • info

      added the new optional query request parameter filter_prefix