FIfiles
user_sftp_client_uses
User SFTP Client Uses

List User SFTP Client Uses

Changed on

List User SFTP Client Uses

get/user_sftp_client_uses

Request

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

Query parameters

user_idinteger

User ID. If provided, will return uses for this user.

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 UserSftpClientUses objects.

idinteger

UserSftpClientUse ID

sftp_clientstring

The SFTP client used

created_atstring date-time

The earliest recorded use of this SFTP client (for this user)

updated_atstring date-time

The most recent use of this SFTP client (for this user)

user_idinteger

ID of the user who performed this access

Example response

[
  {
    "id": 1,
    "sftp_client": "example",
    "created_at": "2000-01-01T01:00:00Z",
    "updated_at": "2000-01-01T01:00:00Z",
    "user_id": 1
  }
]

Changes