FIfiles
public_keys
Public Keys

List Public Keys

Changed on

List Public Keys

get/public_keys

Request

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

Query parameters

user_idinteger

User ID. Provide a value of 0 to operate the current session's 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 workspace_id, user_id, title or created_at.

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

If set, return records where the specified field is greater than the supplied value. Valid fields are created_at.

If set, return records where the specified field is greater than or equal the supplied value. Valid fields are created_at.

If set, return records where the specified field is less than the supplied value. Valid fields are created_at.

If set, return records where the specified field is less than or equal the supplied value. Valid fields are created_at.

Response

A list of PublicKeys objects.

idinteger

Public key ID

workspace_idinteger

Workspace ID (0 for default workspace).

titlestring

Public key title

created_atstring date-time

Public key created at date/time

expires_atstring date-time

Public key expiration date/time

expiredboolean

Is this public key expired?

fingerprintstring

Public key fingerprint (MD5)

fingerprint_sha256string

Public key fingerprint (SHA256)

status'error' | 'not_set' | 'to_be_generated' | 'generating' | 'complete'

Only returned when generating keys. Can be invalid, not_generated, generating, complete

last_login_atstring date-time

Key's most recent login time via SFTP

generated_private_keystring

Only returned when generating keys. Private key generated for the user.

generated_public_keystring

Only returned when generating keys. Public key generated for the user.

usernamestring

Username of the user this public key is associated with

user_idinteger

User ID this public key is associated with

Example response

[
  {
    "id": 1,
    "title": "My public key",
    "created_at": "2000-01-01T01:00:00Z",
    "expires_at": "2000-01-01T01:00:00Z",
    "expired": true,
    "fingerprint": "43:51:43:a1:b5:fc:8b:b7:0a:3a:a9:b1:0f:66:73:a8",
    "fingerprint_sha256": "V5Q5t/ghT3R8Tol5GX9385bzmpygWVRnLuI9EXNrjCX",
    "status": "complete",
    "last_login_at": "2000-01-01T01:00:00Z",
    "generated_private_key": "example",
    "generated_public_key": "example",
    "username": "User",
    "user_id": 1
  }
]

Changes

  • e20172733728Revision changes
    • info

      added the new optional query request parameter filter

    • info

      added the new optional query request parameter filter_gt

    • info

      added the new optional query request parameter filter_gteq

    • info

      added the new optional query request parameter filter_lt

    • info

      added the new optional query request parameter filter_lteq

    • info

      added the new optional query request parameter sort_by

  • 3bb8c8a06041Revision changes
    • info

      api tag Public Keys added