Managing Users

With Couchdrop you can configure additional users. Additional users cannot manage your Couchdrop service, but are able to upload/download and view files.

get
Get Users
https://api.couchdrop.io/manage/credentials
This endpoint allows you to get configured users/credentials
Request
Response
Request
Query Parameters
token
required
string
API Access Token
Response
200: OK
Credentials successfully retrieved.
{
  "credentials": [
    {
      "id": "905abg1a-f206-11e8-b591-0242bc140002", 
      "password": "password", 
      "permissions_mode": "r", 
      "permissions_path": "/box/michael", 
      "public_key": null, 
      "username": "michael"
    }
  ]
}
put
Add User
https://api.couchdrop.io/manage/credentials
Add a user
Request
Response
Request
Path Parameters
token
required
string
API Access Token
Response
200: OK
User was added
{id: "abc", username: "user-xyz"}
post
Modify a User
https://api.couchdrop.io/manage/credentials
This method is used to modify a user. Either the username or id can be supplied. If you wish to change the username, then the id must be specified. 
Request
Response
Request
Path Parameters
token
required
string
API Access Token
Body Parameters
id
required
string
User identifier, generated by system
username
required
string
Username for user
password
optional
string
Password for user
email_address
optional
string
Email address for user
public_key
optional
string
RSA public key
permissions_path
optional
string
Root/home directory
permissions_mode
optional
string
Permissions, ie: 'rw'
allowed_ips
optional
string
IP address to allow. ie: 8.8.8.8, 1.2.3.4/24
allow_sftp_scp_rsync
optional
boolean
Allow access via SFTP/SCP/RSYNC
allow_ftp
optional
boolean
Allow access via traditional FTP
allow_upload_portal
optional
boolean
Allow upload via drop.couchdrop.io
allow_admin
optional
boolean
Allow admin access to Couchdrop
allow_webportal
optional
boolean
Allow access via Couchdrop web UI
Response
200: OK
​
delete
Delete A User
https://api.couchdrop.io/manage/credentials/:username/delete
Request
Response
Request
Path Parameters
username
required
string
Username to delete
token
required
string
API Access Token
Response
200: OK
​

General Settings

Managing Files

Last updated 2 months ago

Managing Users

getGet Users

putAdd User

postModify a User

deleteDelete A User

get
Get Users

put
Add User

post
Modify a User

delete
Delete A User