Groups

Managing groups can be done via the API. The following routes are available.

Get all groups

GET https://api.couchdrop.io/manage/groups

Get all user groups in an organisation

Headers

NameTypeDescription

token*

String

API Token

{
    "groups":[
        {
            "id":"group_id", 
            "groupname": "name":,
            "allowed_ips":"192.168.1.1, 10.1.1.1/32",
            "allow_sftp_scp_rsync":false,
            "allow_upload_portal": false,
            "allow_ftp": false,
            "allow_admin": true,
            "allow_webportal": true,
            "allow_ftps": true,
            "allow_inboxes": true,
            "allow_shared_links": false,
            "allow_workflows": false
        }
    ]
}

Get an individual group by ID

GET https://api.couchdrop.io/manage/group/<group_id>

Headers

NameTypeDescription

token*

String

API Token

{
    "group": {
        ...
    }
}

Create an group

PUT https://api.couchdrop.io/manage/groups

Create a new group

Headers

NameTypeDescription

token*

String

API Token

Request Body

NameTypeDescription

groupname

String

Group Name

{
    "group_id":"new_group_id"
}

Update an existing group

POST https://api.couchdrop.io/manage/groups

Headers

NameTypeDescription

token*

String

API Token

Request Body

NameTypeDescription

id*

String

Group ID

groupname

String

Group name

allowed_ips

String

Allowed IP addresses

allow_sftp_scp_rsync

String

Allow SFTP based access

allow_upload_portal

String

Allow access to the upload portal

allow_ftp

String

Allow FTP based access

allow_admin

String

Allow admin access

allow_webportal

String

Allow access to the web portal

allow_inboxes

String

Allow access to inboxs

allow_shared_links

String

Allow access to shared links

allow_workflows

String

Allow access to workflows

Delete a group by ID

DELETE https://api.couchdrop.io/manage/groups/<group_id>

Headers

NameTypeDescription

token*

String

API Token

Get all group members

GET https://api.couchdrop.io/manage/groups/<group_id>/users

Headers

NameTypeDescription

token*

String

API Token

{
    "users": []
}

Last updated