API keys

Add API key

Adds a new API key

post/apikeys

Request

Base URL
/api/v2 (relative, and the document was published on a file host, not at the API’s origin)
Auth
HTTP bearer
TypeScript
https://skmtc.dev/kanton-bern/apis/sftpgo/docs/apikeys/post.ts
A function with typed inputs. Its response is checked against the schema.

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:

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

successful operation

mesagestring

keystring

generated API key

{
  "mesage": "API key created. This is the only time the API key is visible, please save it."
}

No recorded changes to this operation across all 1 revision of this API.