FIfiles
history
Actions

List site login history.

Changed on

List site login history.

get/history/login

Request

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

Query parameters

start_atstring date-time

Leave blank or set to a date/time to filter earlier entries.

end_atstring date-time

Leave blank or set to a date/time to filter later entries.

displaystring

Display format. Leave blank or set to full or parent.

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

Response

A list of History objects.

idinteger

Action ID

pathstring

Path

whenstring date-time

Action occurrence date/time

destinationstring

The destination path for this action, if applicable

displaystring

Friendly displayed output

ipstring

IP Address that performed this action

sourcestring

The source path for this action, if applicable

targetsobject

Targets

user_idinteger

User ID

usernamestring

Username

user_is_from_parent_siteboolean

true if this change was performed by a user on a parent site.

action'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' | 'archived_delete'

Type of action

failure_type'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' | 'country_mismatch' | 'insecure_ftp' | 'insecure_cipher' | 'rate_limited' | 'no_s3_compatible_endpoint_permission' | 'mobile_ip_mismatch' | 'mobile_api_key_not_used_quickly_enough' | 'desktop_app_disabled' | 'mobile_app_disabled'

Failure type. If action was a user login or session failure, why did it fail?

interface'web' | 'ftp' | 'robot' | 'jsapi' | 'webdesktopapi' | 'sftp' | 'dav' | 'desktop' | 'restapi' | 'scim' | 'office' | 'mobile' | 'as2' | 'inbound_email' | 'remote' | 'inbound_s3'

Interface on which this action occurred.

Example response

[
  {
    "id": 1,
    "path": "path",
    "when": "2000-01-01T01:00:00Z",
    "destination": "/to_path",
    "display": "Actual text of the action here.",
    "ip": "192.283.128.182",
    "source": "/from_path",
    "targets": {},
    "user_id": 1,
    "username": "user",
    "action": "create",
    "failure_type": "none",
    "interface": "web"
  }
]

Changes

  • 3bb8c8a06041Revision changes
    • info

      api operation id ListLogins removed and replaced with HistoryListLogins

    • info

      api tag Actions added

  • 334e0cf90234Revision changes
    • warning

      deleted the query request parameter action

    • warning

      deleted the query request parameter page

    • info

      added the new optional query request parameter cursor

    • info

      added the new optional query request parameter sort_by