Sign in

v1

latestOpenAPI 3.0.3AGPL-3.0-only2026-07-17120116247.0 KB
API keys

Get API keys

Returns an array with one or more API keys. For security reasons hashed keys are omitted in the response

get/apikeys

Query parameters

offsetinteger
limitinteger

The maximum number of items to return. Max value is 500, default is 100

order'ASC' | 'DESC'
Example:ASC

Ordering API keys by id. Default ASC

Response

successful operation

idstring

unique key identifier

namestring

User friendly key name

keystring password

We store the hash of the key. This is just like a password. For security reasons this field is omitted when you search/get API keys

scope1 | 2

Options:

  • 1 - admin scope. The API key will be used to impersonate an SFTPGo admin
  • 2 - user scope. The API key will be used to impersonate an SFTPGo user
created_atinteger

creation time as unix timestamp in milliseconds

updated_atinteger

last update time as unix timestamp in milliseconds

last_use_atinteger

last use time as unix timestamp in milliseconds. It is saved at most once every 10 minutes

expires_atinteger

expiration time as unix timestamp in milliseconds

descriptionstring

optional description

userstring

username associated with this API key. If empty and the scope is "user scope" the key can impersonate any user

adminstring

admin associated with this API key. If empty and the scope is "admin scope" the key can impersonate any admin