Dracoon

DRACOON API

REST Web Services for DRACOON This page provides an overview of all available and documented DRACOON APIs, which are grouped by tags. Each tag provides a…

Developer tools#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

REST Web Services for DRACOON This page provides an overview of all available and documented DRACOON APIs, which are grouped by tags. Each tag provides a collection of APIs that are intended for a specific area of the DRACOON. Developer Information    Get SDKs on GitHub Terms of service

Endpoints 297

roles

  • GETRequest all roles with assigned rights/v4/rolesDescription: Retrieve a list of all roles with assigned rights. Precondition: Right <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid…
  • GETRequest groups with specific role/v4/roles/:role_id/groups?offset=0&limit=0&filter=stringDescription: Get all groups with a specific role. Precondition: Right <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000;…
  • POSTAssign group(s) to the role/v4/roles/:role_id/groupsDescription: Assign group(s) to a role. Precondition: Right <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000; border-radius: 5px;…
  • DELETERevoke granted role from group(s)/v4/roles/:role_id/groupsDescription: Revoke granted group(s) from a role. Precondition: Right <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000;…
  • GETRequest users with specific role/v4/roles/:role_id/users?offset=0&limit=0&filter=stringDescription: Get all users with a specific role. Precondition: Right <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000;…
  • POSTAssign user(s) to the role/v4/roles/:role_id/usersDescription: Assign user(s) to a role. Precondition: Right <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000; border-radius: 5px;…
  • DELETERevoke granted role from user(s)/v4/roles/:role_id/usersDescription: Revoke granted user(s) from a role. Precondition: Right <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000;…

user

  • GETRequest user account information/v4/user/account?more_info=trueDescription: Retrieves all information regarding the current user's account. Precondition: Authenticated user. Postcondition: User information is returned.…
  • PUTUpdate user account/v4/user/accountDescription: Update current user's account. Precondition: Authenticated user. Postcondition: User's account is updated. Further Information: * All input…
  • GETRequest avatar/v4/user/account/avatar<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.11.0</h3>…
  • POSTChange avatar/v4/user/account/avatar<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.11.0</h3>…
  • DELETEReset avatar/v4/user/account/avatar<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.11.0</h3>…
  • GETRequest customer information for user/v4/user/account/customerDescription: Use this API to get: * customer name * used / free space * used / available * user account info of the according customer. Precondition:…
  • PUTActivate client-side encryption for customer/v4/user/account/customerDeprecated. <h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128679; Deprecated since…
  • GETRequest customer's key pair/v4/user/account/customer/keypairDeprecated. <h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128679; Deprecated since…
  • GETRequest user's key pair/v4/user/account/keypair?version=stringDescription: Retrieve the user key pair. Precondition: Authenticated user. Postcondition: Key pair is returned. Further Information: The private key is…
  • POSTSet user's key pair/v4/user/account/keypairDescription: Set the user key pair. Precondition: Authenticated user. Postcondition: Key pair is set. Further Information: Overwriting an existing key pair is…
  • DELETERemove user's key pair/v4/user/account/keypair?version=stringDescription: Delete user key pair. Precondition: Authenticated user. Postcondition: Key pair is deleted. Further Information: If parameter version is not set…
  • GETRequest all user key pairs/v4/user/account/keypairs<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.24.0</h3>…
  • POSTCreate key pair and preserve copy of old private key/v4/user/account/keypairs<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.24.0</h3>…
  • GETRequest information about the user's mfa status/v4/user/account/mfa<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.37.0</h3>…
  • DELETEUsing emergency-code/v4/user/account/mfa?emergency_code=string<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.37.0</h3>…
  • GETRequest information to setup TOTP as second authentication factor/v4/user/account/mfa/totp<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.37.0</h3>…
  • POSTConfirm second factor TOTP setup with a generated OTP/v4/user/account/mfa/totp<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.37.0</h3>…
  • DELETEDisable a MFA TOTP setup with generated OTP/v4/user/account/mfa/totp/:id?valid_otp=string<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.37.0</h3>…
  • PUTChange user's password/v4/user/account/passwordDescription: Change the user's password. Precondition: Authenticated user. Postcondition: User's password is changed. Further Information: The password MUST…
  • POSTInvalidate authentication token/v4/user/logout?everywhere=trueDeprecated. <h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128679; Deprecated since…
  • GETRequest list of notification configurations/v4/user/notifications/config<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.20.0</h3>…
  • PUTUpdate notification configuration/v4/user/notifications/config/:id<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.20.0</h3>…
  • GETRequest list of OAuth client approvals/v4/user/oauth/approvals?sort=string<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.22.0</h3> Functional…
  • DELETERemove OAuth client approval/v4/user/oauth/approvals/:client_id<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.22.0</h3> Functional…
  • GETRequest list of OAuth client authorizations/v4/user/oauth/authorizations?filter=string&sort=stringDescription: Retrieve information about all OAuth client authorizations. Precondition: Authenticated user. Postcondition: List of OAuth client authorizations…
  • DELETERemove all OAuth authorizations of a client/v4/user/oauth/authorizations/:client_idDescription: Delete all authorizations of a client. Precondition: Authenticated user and valid client ID Postcondition: All authorizations for the client are…
  • DELETERemove a OAuth authorization/v4/user/oauth/authorizations/:client_id/:authorization_id<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.12.0</h3>…
  • GET(authenticated) Ping/v4/user/pingDescription: Test connection to DRACOON Server (while authenticated). Precondition: Authenticated user. Postcondition: 200 OK with principal information is…
  • GETRequest user profile attributes/v4/user/profileAttributes?offset=0&limit=0&filter=string&sort=string<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.7.0</h3> Description:…
  • PUTAdd or edit user profile attributes/v4/user/profileAttributes<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.7.0</h3> Description:…
  • POSTSet user profile attributes/v4/user/profileAttributesDeprecated. <h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128679; Deprecated since…
  • DELETERemove user profile attribute/v4/user/profileAttributes/:key<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.7.0</h3> Description:…
  • GETList Download Share subscriptions/v4/user/subscriptions/download_shares?filter=string&limit=0&offset=0&sort=string<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.20.0</h3>…
  • PUTSubscribe or Unsubscribe a List of Download Shares for notifications/v4/user/subscriptions/download_shares<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.25.0</h3>…
  • POSTSubscribe Download Share for notifications/v4/user/subscriptions/download_shares/:share_id<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.20.0</h3>…
  • DELETEUnsubscribe Download Share from notifications/v4/user/subscriptions/download_shares/:share_id<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.20.0</h3>…
  • GETList node subscriptions/v4/user/subscriptions/nodes?filter=string&limit=0&offset=0&sort=string<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.20.0</h3>…
  • PUTSubscribe or Unsubscribe a List of nodes for notifications/v4/user/subscriptions/nodes<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.25.0</h3>…
  • POSTSubscribe node for notifications/v4/user/subscriptions/nodes/:node_id<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.20.0</h3>…
  • DELETEUnsubscribe node from notifications/v4/user/subscriptions/nodes/:node_id<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.20.0</h3>…
  • GETList Upload Share subscriptions/v4/user/subscriptions/upload_shares?filter=string&limit=0&offset=0&sort=string<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.24.0</h3>…
  • PUTSubscribe or Unsubscribe a List of Upload Shares for notifications/v4/user/subscriptions/upload_shares<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.25.0</h3>…
  • POSTSubscribe Upload Share for notifications/v4/user/subscriptions/upload_shares/:share_id<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.24.0</h3>…
  • DELETEUnsubscribe Upload Share from notifications/v4/user/subscriptions/upload_shares/:share_id<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.24.0</h3>…

config

  • GETRequest default values/v4/config/info/defaults<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.6.0</h3> Description:…
  • GETRequest general settings/v4/config/info/general<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.6.0</h3> Description:…
  • GETRequest infrastructure properties/v4/config/info/infrastructure<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.6.0</h3> Description:…
  • GETRequest list of notification channels/v4/config/info/notifications/channels<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.20.0</h3>…
  • GETRequest algorithms/v4/config/info/policies/algorithms<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.24.0</h3>…
  • GETRequest classification policies/v4/config/info/policies/classifications<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.30.0</h3>…
  • GETRequest guest users policies/v4/config/info/policies/guest_users<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.40.0</h3>…
  • GETRequest password policies/v4/config/info/policies/passwords<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.14.0</h3>…
  • GETRequest list of product packages/v4/config/info/product_packages<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.38.0</h3>…
  • GETRequest list of currently enabled product packages/v4/config/info/product_packages/current<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.38.0</h3>…
  • GETRequest list of configured S3 tags/v4/config/info/s3_tags<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.9.0</h3> Description:…
  • GETRequest system settings/v4/config/settingsDeprecated. <h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128679; Deprecated since…
  • PUTUpdate system settings/v4/config/settingsDeprecated. <h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128679; Deprecated since…

users

  • GETRequest users/v4/users?offset=0&limit=0&filter=string&sort=string&include_attributes=true&include_roles=true&include_manageable_rooms=trueDescription: Returns a list of DRACOON users. Precondition: Right <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000; border-radius:…
  • POSTCreate new user/v4/usersDescription: Create a new user. Precondition: Right <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000; border-radius: 5px; display:…
  • GETRequest user/v4/users/:user_id?effective_roles=trueDescription: Retrieve detailed information about a single user. Precondition: Right <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid…
  • PUTUpdate user's metadata/v4/users/:user_idDescription: Update user's metadata. Precondition: Right <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000; border-radius: 5px;…
  • DELETERemove user/v4/users/:user_idDescription: Delete a user. Precondition: Right <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000; border-radius: 5px; display:…
  • GETRequest groups that user is a member of or / and can become a member/v4/users/:user_id/groups?offset=0&limit=0&filter=stringDescription: Retrieves a list of groups a user is member of and / or can become a member. Precondition: Right <span style='padding: 3px; background-color:…
  • GETRequest rooms where the user is last admin/v4/users/:user_id/last_admin_rooms<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.10.0</h3>…
  • POSTRequest emergency MFA code/v4/users/:user_id/mfa/emergency_code<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.37.0</h3>…
  • GETRequest user's granted roles/v4/users/:user_id/rolesDescription: Retrieve a list of all roles granted to a user. Precondition: Right <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000;…
  • GETRequest rooms granted to the user or / and rooms that can be granted/v4/users/:user_id/rooms?offset=0&limit=0&filter=stringDeprecated. <h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128679; Deprecated since…
  • GETRequest custom user attributes/v4/users/:user_id/userAttributes?offset=0&limit=0&filter=string&sort=string<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.12.0</h3>…
  • PUTAdd or edit custom user attributes/v4/users/:user_id/userAttributesDescription: Add or edit custom user attributes. <br/><br/><span style="font-weight: bold; color: red;"> &#128679; Warning: Please note that the response with…
  • POSTSet custom user attributes/v4/users/:user_id/userAttributesDeprecated. <h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128679; Deprecated since…
  • DELETERemove custom user attribute/v4/users/:user_id/userAttributes/:keyDescription: Delete custom user attribute. Precondition: Right <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000; border-radius:…

resources

  • GETRequest list of subscription scopes/v4/resources/user/notifications/scopes<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.20.0</h3>…
  • GETRequest user avatar/v4/resources/users/:user_id/avatar/:uuidDescription: Get user avatar. Precondition: Valid user ID and avatar UUID Postcondition: Avatar is returned. Further Information: None.

system-settings-config

  • GETRequest authentication settings/v4/system/config/settings/auth<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.6.0</h3> Description:…
  • PUTUpdate authentication settings/v4/system/config/settings/auth<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.6.0</h3> Description:…
  • GETRequest system defaults/v4/system/config/settings/defaults<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.6.0</h3> Description:…
  • PUTUpdate system defaults/v4/system/config/settings/defaults<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.6.0</h3> Description:…
  • GETRequest eventlog settings/v4/system/config/settings/eventlog<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.6.0</h3> Description:…
  • PUTUpdate eventlog settings/v4/system/config/settings/eventlog<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.6.0</h3> Description:…
  • GETRequest general settings/v4/system/config/settings/general<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.6.0</h3> Description:…
  • PUTUpdate general settings/v4/system/config/settings/general<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.6.0</h3> Description:…
  • GETRequest infrastructure properties/v4/system/config/settings/infrastructure<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.6.0</h3> Description:…
  • GETRequest syslog settings/v4/system/config/settings/syslog<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.6.0</h3> Description:…
  • PUTUpdate syslog settings/v4/system/config/settings/syslog<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.6.0</h3> Description:…

public

  • GETRequest public Download Share information/v4/public/shares/downloads/:access_keyDescription: Retrieve the public information of a Download Share. Precondition: None. Postcondition: Download Share information is returned. Further…
  • POSTGenerate download URL/v4/public/shares/downloads/:access_keyDescription: Generate a download URL to retrieve a shared file. Precondition: None. Postcondition: Download URL and token are generated and returned. Further…
  • HEADCheck public Download Share password/v4/public/shares/downloads/:access_key?password=string<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.36.0</h3>…
  • GETDownload file with token/v4/public/shares/downloads/:access_key/:token?generic_mimetype=true&inline=trueDescription: Download a file (or zip archive if target is a folder or room). Precondition: Valid download token. Postcondition: Stream is returned. Further…
  • HEADDownload file with token/v4/public/shares/downloads/:access_key/:token?generic_mimetype=true&inline=trueDescription: Download a file (or zip archive if target is a folder or room). Precondition: Valid download token. Postcondition: Stream is returned. Further…
  • GETRequest public Upload Share information/v4/public/shares/uploads/:access_keyDescription: Provides information about the desired Upload Share. Precondition: Only userUserPublicKeyList is returned to the users who owns one of the…
  • POSTCreate new file upload channel/v4/public/shares/uploads/:access_keyDescription: Create a new upload channel. Precondition: None. Postcondition: Upload channel is created and corresponding upload URL, token & upload ID are…
  • GETRequest status of S3 file upload/v4/public/shares/uploads/:access_key/:upload_id<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.15.0</h3>…
  • PUTComplete file upload/v4/public/shares/uploads/:access_key/:upload_idDescription: Finalize (chunked) upload via Upload Share. Precondition: Valid upload ID. Only returns users that owns one of the following permissions: <span…
  • POSTUpload file/v4/public/shares/uploads/:access_key/:upload_idDescription: Chunked upload of files via Upload Share. Precondition: Valid upload ID. Postcondition: Chunk of file is uploaded. Further Information: Chunked…
  • DELETECancel file upload/v4/public/shares/uploads/:access_key/:upload_idDescription: Abort (chunked) upload via Upload Share. Precondition: Valid Upload ID. Postcondition: Aborts upload and invalidates upload ID / token. Further…
  • PUTComplete S3 file upload/v4/public/shares/uploads/:access_key/:upload_id/s3<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.15.0</h3>…
  • POSTGenerate presigned URLs for S3 file upload/v4/public/shares/uploads/:access_key/:upload_id/s3_urls<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.15.0</h3>…
  • GETRequest third-party software dependencies/v4/public/software/third_party_dependencies<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.9.0</h3> Description:…
  • GETRequest software version information/v4/public/software/versionDescription: Public software version information. Precondition: None. Postcondition: Sofware version information is returned. Further Information: The version…
  • GETRequest system information/v4/public/system/info?is_enabled=trueDescription: Provides information about system. Precondition: None. Postcondition: System information is returned. Further Information: Authentication methods…
  • GETRequest Active Directory authentication information/v4/public/system/info/auth/ad?is_global_available=trueDescription: Provides information about Active Directory authentication options. Precondition: None. Postcondition: Active Directory authentication options…
  • GETRequest OpenID Connect provider authentication information/v4/public/system/info/auth/openid?is_global_available=trueDescription: Provides information about OpenID Connect authentication options. Precondition: None. Postcondition: OpenID Connect authentication options…
  • GETRequest system time/v4/public/timeDescription: Retrieve the actual server time. Precondition: None. Postcondition: Server time is returned. Further Information: None.

system-auth-config

  • POSTTest Active Directory configuration/v4/system/config/actions/test/adDescription: Test Active Directory configuration. Precondition: Right <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000;…
  • POSTTest RADIUS server availability/v4/system/config/actions/test/radiusDescription: Test RADIUS configuration. Precondition: Right <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000; border-radius: 5px;…
  • GETRequest list of Active Directory configurations/v4/system/config/auth/adsDescription: Retrieve a list of configured Active Directories. Precondition: Right <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid…
  • POSTCreate Active Directory configuration/v4/system/config/auth/adsDescription: Create a new Active Directory configuration. Precondition: Right <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000;…
  • GETRequest Active Directory configuration/v4/system/config/auth/ads/:ad_idDescription: Retrieve the configuration of an Active Directory. Precondition: Right <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid…
  • PUTUpdate Active Directory configuration/v4/system/config/auth/ads/:ad_idDescription: Update an existing Active Directory configuration. Precondition: Right <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid…
  • DELETERemove Active Directory configuration/v4/system/config/auth/ads/:ad_idDescription: Delete an existing Active Directory configuration. Precondition: Right <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid…
  • GETRequest list of OpenID Connect IDP configurations/v4/system/config/auth/openid/idpsDescription: Retrieve a list of configured OpenID Connect IDPs. Precondition: Right <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid…
  • POSTCreate OpenID Connect IDP configuration/v4/system/config/auth/openid/idpsDescription: Create new OpenID Connect IDP configuration. Precondition: Right <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000;…
  • GETRequest OpenID Connect IDP configuration/v4/system/config/auth/openid/idps/:idp_idDescription: Retrieve an OpenID Connect IDP configuration. Precondition: Right <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000;…
  • PUTUpdate OpenID Connect IDP configuration/v4/system/config/auth/openid/idps/:idp_idDescription: Update an existing OpenID Connect IDP configuration. Precondition: Right <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid…
  • DELETERemove OpenID Connect IDP configuration/v4/system/config/auth/openid/idps/:idp_idDescription: Delete an existing OpenID Connect IDP configuration. Precondition: Right <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid…
  • GETRequest RADIUS configuration/v4/system/config/auth/radiusDescription: Retrieve a RADIUS configuration. Precondition: Right <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000; border-radius:…
  • PUTUpdate RADIUS configuration/v4/system/config/auth/radiusDescription: Update existing RADIUS configuration. Precondition: Right <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000;…
  • POSTCreate RADIUS configuration/v4/system/config/auth/radiusDescription: Create new RADIUS configuration. Precondition: Right <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000; border-radius:…
  • DELETERemove RADIUS configuration/v4/system/config/auth/radiusDescription: Delete existing RADIUS configuration. Precondition: Right <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000;…
  • GETRequest list of OAuth clients/v4/system/config/oauth/clients?filter=string&sort=stringDescription: Retrieve a list of configured OAuth clients. Precondition: Right <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000;…
  • POSTCreate OAuth client/v4/system/config/oauth/clientsDescription: Create a new OAuth client. Precondition: Right <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000; border-radius: 5px;…
  • GETRequest OAuth client/v4/system/config/oauth/clients/:client_idDescription: Retrieve the configuration of an OAuth client. Precondition: Right <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000;…
  • PUTUpdate OAuth client/v4/system/config/oauth/clients/:client_idDescription: Update an existing OAuth client. Precondition: Right <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000; border-radius:…
  • DELETERemove OAuth client/v4/system/config/oauth/clients/:client_idDescription: Delete an existing OAuth client. Precondition: Right <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000; border-radius:…

downloads

  • GETDownload avatar/v4/downloads/avatar/:user_id/:uuid<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.11.0</h3>…
  • GETDownload ZIP archive/v4/downloads/zip/:tokenDescription: Download multiple files in a ZIP archive. Precondition: Valid download token. Postcondition: Stream is returned. Further Information: Create a…
  • GETDownload file/v4/downloads/:token?generic_mimetype=true&inline=trueDescription: Download a file. Precondition: Valid download token. Postcondition: Stream is returned. Further Information: Range requests are supported.
  • HEADDownload file/v4/downloads/:token?generic_mimetype=true&inline=trueDescription: Download a file. Precondition: Valid download token. Postcondition: Stream is returned. Further Information: Range requests are supported.

provisioning

  • GETRequest list of customers/v4/provisioning/customers?offset=0&limit=0&filter=string&sort=string&include_attributes=trueDescription: Receive a list of customers. Precondition: Authentication with X-Sds-Service-Token required. Postcondition: List of customers is returned.…
  • POSTCreate customer/v4/provisioning/customersDescription: Create a new customer. Precondition: Authentication with X-Sds-Service-Token required. Postcondition: A new customer is created. Further…
  • GETGet customer/v4/provisioning/customers/:customer_id?include_attributes=trueDescription: Receive details of a selected customer. Precondition: Authentication with X-Sds-Service-Token required. Postcondition: Customer details are…
  • PUTUpdate customer/v4/provisioning/customers/:customer_idDescription: Change selected attributes of a customer. Precondition: Authentication with X-Sds-Service-Token required. Postcondition: Selected attributes of…
  • DELETERemove customer/v4/provisioning/customers/:customer_idDescription: Delete a customer. Precondition: Authentication with X-Sds-Service-Token required. Postcondition: Customer is deleted. Further Information: None.
  • GETRequest customer attributes/v4/provisioning/customers/:customer_id/customerAttributes?offset=0&limit=0&filter=string&sort=string<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.4.0</h3> Description:…
  • PUTAdd or edit customer attributes/v4/provisioning/customers/:customer_id/customerAttributes<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.4.0</h3> Description:…
  • POSTSet customer attributes/v4/provisioning/customers/:customer_id/customerAttributesDeprecated. <h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128679; Deprecated since…
  • DELETERemove customer attribute/v4/provisioning/customers/:customer_id/customerAttributes/:key<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.4.0</h3> Description:…
  • GETRequest list of customer users/v4/provisioning/customers/:customer_id/users?offset=0&limit=0&filter=string&sort=string&include_attributes=true&include_roles=true&include_manageable_rooms=trueDescription: Receive a list of users associated with a certain customer. Precondition: Authentication with X-Sds-Service-Token required. Postcondition: List…
  • GETRequest list of tenant webhooks/v4/provisioning/webhooks?offset=0&limit=0&filter=string&sort=string<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.19.0</h3>…
  • POSTCreate tenant webhook/v4/provisioning/webhooks<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.19.0</h3>…
  • GETRequest list of event types/v4/provisioning/webhooks/event_types<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.19.0</h3>…
  • GETRequest tenant webhook/v4/provisioning/webhooks/:webhook_id<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.19.0</h3>…
  • PUTUpdate tenant webhook/v4/provisioning/webhooks/:webhook_id<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.19.0</h3>…
  • DELETERemove tenant webhook/v4/provisioning/webhooks/:webhook_id<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.19.0</h3>…
  • POSTReset tenant webhook lifetime/v4/provisioning/webhooks/:webhook_id/reset_lifetime<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.19.0</h3>…

auth

  • POSTAuthenticate user (Login)/v4/auth/loginDeprecated. <h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128679; Deprecated since…
  • GETInitiate OpenID Connect authentication/v4/auth/openid/login?issuer=string&redirect_uri=string&language=string&test=trueDeprecated. <h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128679; Deprecated since…
  • POSTComplete OpenID Connect authentication/v4/auth/openid/login?code=string&id_token=string&state=stringDeprecated. <h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128679; Deprecated since…
  • GETPing/v4/auth/pingDescription: Test connection to DRACOON Core Service. Precondition: None. Postcondition: 200 OK with current date string is returned if successful. Further…
  • POSTRecover username/v4/auth/recover_username<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.13.0</h3>…
  • POSTRequest password reset/v4/auth/reset_passwordDescription: Request an email with a password reset token for a certain user to reset password. Precondition: Registered user account. Postcondition: Provided…
  • GETValidate information for password reset/v4/auth/reset_password/:tokenDescription: Request all information for a password change dialogue e.g. real name of user. Precondition: User received a password reset token. Postcondition:…
  • PUTReset password/v4/auth/reset_password/:tokenDescription: Resets user's password. Precondition: User received a password reset token. Postcondition: User's password is reset to the provided password.…

uploads

  • PUTComplete file upload/v4/uploads/:tokenDescription: Finish uploading a file. Precondition: Valid upload token. Postcondition: File created. Further Information: The provided file name might be…
  • POSTUpload file/v4/uploads/:tokenDescription: Upload a (chunk of a) file. Precondition: Valid upload token. Postcondition: Chunk uploaded. Further Information: Range requests are supported.…
  • DELETECancel file upload/v4/uploads/:tokenDescription: Cancel file upload. Precondition: Valid upload token. Postcondition: Upload canceled, token invalidated and all already transfered chunks…

settings

  • GETRequest customer settings/v4/settingsDescription: Retrieve customer related settings. Precondition: Right <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000;…
  • PUTSet customer settings/v4/settingsDescription: Set customer related settings. Precondition: Right <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000; border-radius:…
  • GETRequest system rescue key pair/v4/settings/keypair?version=string<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.24.0</h3>…
  • POSTActivate client-side encryption for customer/v4/settings/keypair<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.24.0</h3>…
  • DELETERemove system rescue key pair/v4/settings/keypair?version=string<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.24.0</h3>…
  • GETRequest all system rescue key pairs/v4/settings/keypairs<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.24.0</h3>…
  • POSTCreate system rescue key pair and preserve copy of old private key/v4/settings/keypairs<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.24.0</h3>…
  • GETRequest list of notification channels/v4/settings/notifications/channels<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.20.0</h3>…
  • PUTToggle notification channels/v4/settings/notifications/channels<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.20.0</h3>…
  • GETRequest list of webhooks/v4/settings/webhooks?offset=0&limit=0&filter=string&sort=string<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.19.0</h3>…
  • POSTCreate webhook/v4/settings/webhooks<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.19.0</h3>…
  • GETRequest list of event types/v4/settings/webhooks/event_types<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.19.0</h3>…
  • GETRequest webhook/v4/settings/webhooks/:webhook_id<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.19.0</h3>…
  • PUTUpdate webhook/v4/settings/webhooks/:webhook_id<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.19.0</h3>…
  • DELETERemove webhook/v4/settings/webhooks/:webhook_id<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.19.0</h3>…
  • POSTReset webhook lifetime/v4/settings/webhooks/:webhook_id/reset_lifetime<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.19.0</h3>…

system-policies-config

  • GETRequest classification policies/v4/system/config/policies/classifications<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.30.0</h3>…
  • PUTChange classification policies/v4/system/config/policies/classifications<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.30.0</h3>…
  • GETRequest guest user policies/v4/system/config/policies/guest_users<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.40.0</h3>…
  • PUTChange guest user policies/v4/system/config/policies/guest_users<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.40.0</h3>…
  • GETRequest MFA policies/v4/system/config/policies/mfa<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.37.0</h3>…
  • PUTChange MFA policies/v4/system/config/policies/mfa<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.37.0</h3>…
  • GETRequest password policies/v4/system/config/policies/passwords<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.14.0</h3>…
  • PUTChange password policies/v4/system/config/policies/passwords<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.14.0</h3>…
  • POSTEnforce login password change for all users/v4/system/config/policies/passwords/enforce_change<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.24.0</h3>…
  • GETRequest password policies for a certain password type/v4/system/config/policies/passwords/:password_type<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.14.0</h3>…

shares

  • GETRequest list of Download Shares/v4/shares/downloads?filter=string&sort=string&offset=0&limit=0Description: Retrieve a list of Download Shares. Precondition: Authenticated user. Postcondition: List of available Download Shares is returned. Further…
  • PUTUpdate a list of Download Shares/v4/shares/downloads<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.25.0</h3>…
  • POSTCreate new Download Share/v4/shares/downloadsDescription: Create a new Download Share. Precondition: User with <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000; border-radius:…
  • DELETERemove Download Shares/v4/shares/downloads<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.21.0</h3> Functional…
  • GETRequest Download Share/v4/shares/downloads/:share_idDescription: Retrieve detailed information about one Download Share. Precondition: User with <span style='padding: 3px; background-color: #F6F7F8; border: 1px…
  • PUTUpdate Download Share/v4/shares/downloads/:share_id<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.11.0</h3>…
  • DELETERemove Download Share/v4/shares/downloads/:share_idDescription: Delete a Download Share. Precondition: User with <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000; border-radius:…
  • POSTSend an existing Download Share link via email/v4/shares/downloads/:share_id/email<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.11.0</h3>…
  • GETRequest Download Share via QR Code/v4/shares/downloads/:share_id/qrDescription: Retrieve detailed information about one Download Share. Precondition: User with <span style='padding: 3px; background-color: #F6F7F8; border: 1px…
  • GETRequest list of Upload Shares/v4/shares/uploads?filter=string&sort=string&offset=0&limit=0Description: Retrieve a list of Upload Shares (aka File Requests). Precondition: Authenticated user. Postcondition: List of available Upload Shares is…
  • PUTUpdate List of Upload Shares/v4/shares/uploads<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.25.0</h3>…
  • POSTCreate new Upload Share/v4/shares/uploadsDescription: Create a new Upload Share (aka File Request). Precondition: User has <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid…
  • DELETERemove Upload Shares/v4/shares/uploads<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.21.0</h3> Functional…
  • GETRequest Upload Share/v4/shares/uploads/:share_idDescription: Retrieve detailed information about one Upload Share (aka File Request). Precondition: User has <span style='padding: 3px; background-color:…
  • PUTUpdate Upload Share/v4/shares/uploads/:share_id<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.11.0</h3>…
  • DELETERemove Upload Share/v4/shares/uploads/:share_idDescription: Delete an Upload Share (aka File Request). Precondition: User has <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000;…
  • POSTSend an existing Upload Share link via email/v4/shares/uploads/:share_id/email<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.11.0</h3>…
  • GETRequest Upload Share via QR Code/v4/shares/uploads/:share_id/qrDescription: Retrieve detailed information about one Upload Share (aka File Request). Precondition: User has <span style='padding: 3px; background-color:…

system-storage-config

  • GETRequest S3 storage configuration/v4/system/config/storage/s3<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.3.0</h3> Description:…
  • PUTUpdate S3 storage configuration/v4/system/config/storage/s3<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.3.0</h3> Description:…
  • POSTCreate S3 storage configuration/v4/system/config/storage/s3<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.3.0</h3> Description:…
  • GETRequest list of configured S3 tags/v4/system/config/storage/s3/tags<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.9.0</h3> Description:…
  • POSTCreate S3 tag/v4/system/config/storage/s3/tags<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.9.0</h3> Description:…
  • GETRequest S3 tag/v4/system/config/storage/s3/tags/:id<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.9.0</h3> Description:…
  • DELETERemove S3 tag/v4/system/config/storage/s3/tags/:id<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.9.0</h3> Description:…

groups

  • GETRequest list of user groups/v4/groups?offset=0&limit=0&filter=string&sort=stringDescription: Returns a list of user groups. Precondition: Right <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000; border-radius:…
  • POSTCreate new user group/v4/groupsDescription: Create a new user group. Precondition: Right <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000; border-radius: 5px;…
  • GETRequest user group/v4/groups/:group_idDescription: Retrieve detailed information about a user group. Precondition: Right <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid…
  • PUTUpdate user group's metadata/v4/groups/:group_idDescription: Update user group's metadata . Precondition: Right <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000; border-radius:…
  • DELETERemove user group/v4/groups/:group_idDescription: Delete a user group. Precondition: Right <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000; border-radius: 5px;…
  • GETRequest rooms where the group is defined as last admin group/v4/groups/:group_id/last_admin_rooms<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.10.0</h3>…
  • GETRequest list of roles assigned to the group/v4/groups/:group_id/rolesDescription: Retrieve a list of all roles granted to a group. Precondition: Right <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid…
  • GETRequest rooms granted to the group or / and rooms that can be granted/v4/groups/:group_id/rooms?offset=0&limit=0&filter=stringDeprecated. <h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128679; Deprecated since…
  • GETRequest group member users or / and users who can become a member/v4/groups/:group_id/users?offset=0&limit=0&filter=stringDescription: Retrieve a list of group member users or / and users who can become a member. Precondition: Right <span style='padding: 3px; background-color:…
  • POSTAdd group members/v4/groups/:group_id/usersDescription: Add members to a group. Precondition: Right <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000; border-radius: 5px;…
  • DELETERemove group members/v4/groups/:group_id/usersDescription: Remove group members. Precondition: Right <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000; border-radius: 5px;…

internal

  • GETRequest subscription plan/v4/internal/tenant/subscription_plan<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.36.0</h3>…
  • PUTSet subscription plan/v4/internal/tenant/subscription_plan<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.36.0</h3>…

eventlog

  • GETRequest nodes/v4/eventlog/audits/node_info?parent_id=0&offset=0&limit=0&filter=string&sort=string<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.31.0</h3>…
  • GETRequest node assigned users with permissions/v4/eventlog/audits/nodes?offset=0&limit=0&filter=string&sort=stringDeprecated. <h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128679; Deprecated since…
  • GETRequest system events/v4/eventlog/events?sort=string&offset=0&limit=0&date_start=string&date_end=string&type=0&user_id=0&status=0&user_client=string<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.3.0</h3> Description:…
  • GETRequest allowed Log Operations/v4/eventlog/operations?is_deprecated=true<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.3.0</h3> Description:…

nodes

  • GETRequest list of nodes/v4/nodes?depth_level=0&parent_id=0&room_manager=true&filter=string&sort=string&offset=0&limit=0Description: Provides a hierarchical list of file system nodes (rooms, folders or files) of a given parent that are accessible by the current user.…
  • DELETERemove nodes/v4/nodesDescription: Delete nodes (room, folder or file). Precondition: Authenticated user with <span style='padding: 3px; background-color: #F6F7F8; border: 1px…
  • PUTEdit node comment/v4/nodes/comments/:comment_id<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.10.0</h3>…
  • DELETERemove node comment/v4/nodes/comments/:comment_id<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.10.0</h3>…
  • DELETERemove nodes from recycle bin/v4/nodes/deleted_nodesDescription: Permanently remove a list of nodes from the recycle bin. Precondition: User has <span style='padding: 3px; background-color: #F6F7F8; border: 1px…
  • POSTRestore deleted nodes/v4/nodes/deleted_nodes/actions/restoreDescription: Restore a list of deleted nodes. Precondition: User has <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000;…
  • GETRequest deleted node/v4/nodes/deleted_nodes/:deleted_node_idDescription: Get metadata of a deleted node. Precondition: User can access parent room and has <span style='padding: 3px; background-color: #F6F7F8; border:…
  • PUTMark or unmark a list of nodes (room, folder or file) as favorite/v4/nodes/favorites<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.25.0</h3>…
  • PUTUpdates a list of file’s metadata/v4/nodes/files<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.25.0</h3>…
  • POSTSet file keys for a list of users and files/v4/nodes/files/keysDescription: Sets symmetric file keys for several users and files. Precondition: User has file keys for the files. Only settable by users that own one of the…
  • POSTCreate new file upload channel/v4/nodes/files/uploadsDescription: This endpoint creates a new upload channel which is the first step in any file upload workflow. Precondition: User has <span style='padding: 3px;…
  • GETRequest status of S3 file upload/v4/nodes/files/uploads/:upload_id<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.15.0</h3>…
  • PUTComplete file upload/v4/nodes/files/uploads/:upload_idDeprecated. <h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128679; Deprecated since…
  • POSTUpload file/v4/nodes/files/uploads/:upload_idDeprecated. <h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128679; Deprecated since…
  • DELETECancel file upload/v4/nodes/files/uploads/:upload_idDescription: Cancel a (S3) file upload and destroy the upload channel. Precondition: An upload channel has been created and user has to be the creator of the…
  • PUTComplete S3 file upload/v4/nodes/files/uploads/:upload_id/s3<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.15.0</h3>…
  • POSTGenerate presigned URLs for S3 file upload/v4/nodes/files/uploads/:upload_id/s3_urls<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.15.0</h3>…
  • GETRequest list of file versions/v4/nodes/files/versions/:reference_id?offset=0&limit=0<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.37.0</h3>…
  • PUTUpdates a file’s metadata/v4/nodes/files/:file_idDescription: Updates a list of file’s metadata. Precondition: User has <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000;…
  • GETRequest room rescue key/v4/nodes/files/:file_id/data_room_file_key?version=stringDeprecated. <h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128679; Deprecated since…
  • GETRequest system rescue key/v4/nodes/files/:file_id/data_space_file_key?version=stringDeprecated. <h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128679; Deprecated since…
  • POSTGenerate download URL/v4/nodes/files/:file_id/downloadsDescription: Create a download URL to retrieve a file without X-Sds-Auth-Token Header. Precondition: User with <span style='padding: 3px; background-color:…
  • GETRequest user's file key/v4/nodes/files/:file_id/user_file_key?version=stringDescription: Returns the file key for the current user (if available). Precondition: User with one of the following permissions in parent room: <span…
  • POSTCreate new folder/v4/nodes/foldersDescription: Create a new folder. Precondition: User has <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000; border-radius: 5px;…
  • PUTUpdates folder’s metadata/v4/nodes/folders/:folder_idDescription: Updates folder’s metadata. Precondition: User has <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000; border-radius:…
  • GETRequest files without user's file key/v4/nodes/missingFileKeys?offset=0&limit=0&room_id=0&file_id=0&user_id=0&use_key=room_rescue_keyDescription: Requests a list of missing file keys that may be generated by the current user. Precondition: User has a key pair. Only returns users that owns…
  • POSTCreate new room/v4/nodes/roomsDescription: Creates a new room at the provided parent node. Creation of top level rooms provided. Precondition: User has <span style='padding: 3px;…
  • GETRequest user-room assignments per group/v4/nodes/rooms/pending?offset=0&limit=0&filter=string&sort=stringDescription: Requests a list of user-room assignments by groups that have NOT been approved yet These can have the state: * WAITING * DENIED * ACCEPTED…
  • PUTHandle user-room assignments per group/v4/nodes/rooms/pendingDescription: Handles a list of user-room assignments by groups that have NOT been approved yet WAITING or DENIED assignments can be ACCEPTED. Precondition:…
  • PUTUpdates room’s metadata/v4/nodes/rooms/:room_idDescription: Updates room’s metadata. Precondition: User is a <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000; border-radius:…
  • PUTConfigure room/v4/nodes/rooms/:room_id/configDescription: Configure a room. Precondition: User needs to be a <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000; border-radius:…
  • PUTEncrypt room/v4/nodes/rooms/:room_id/encryptDescription: Activates the client-side encryption for a room. Precondition: User needs to be a <span style='padding: 3px; background-color: #F6F7F8; border:…
  • GETRequest events of a room/v4/nodes/rooms/:room_id/events?sort=string&offset=0&limit=0&date_start=string&date_end=string&type=0&user_id=0&status=0<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.3.0</h3> Description:…
  • GETRequest room granted group(s) or / and group(s) that can be granted/v4/nodes/rooms/:room_id/groups?offset=0&limit=0&filter=string&sort=stringDescription: Retrieve a list of groups that are and / or can be granted to the room. Precondition: Any permissions on target room. Postcondition: List of…
  • PUTAdd or change room granted group(s)/v4/nodes/rooms/:room_id/groupsDescription: All existing group permissions will be overwritten. Precondition: User needs to be a <span style='padding: 3px; background-color: #F6F7F8;…
  • DELETERevoke granted group(s) from room/v4/nodes/rooms/:room_id/groupsDescription: Revoke granted groups from room. Precondition: User needs to be a <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000;…
  • PUTAdd guest users to a room/v4/nodes/rooms/:room_id/guest_usersDescription: Add guest users to a room Precondition: User needs to be a <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000;…
  • GETRequest room rescue key/v4/nodes/rooms/:room_id/keypair?version=stringDescription: Retrieve the room rescue key pair. Precondition: User has <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000;…
  • POSTSet room's rescue key pair/v4/nodes/rooms/:room_id/keypair<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.24.0</h3>…
  • DELETERemove rooms's rescue key pair/v4/nodes/rooms/:room_id/keypair?version=string<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.24.0</h3>…
  • GETRequest all room rescue key pairs/v4/nodes/rooms/:room_id/keypairs<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.24.0</h3>…
  • POSTCreate key pair and preserve copy of old private key/v4/nodes/rooms/:room_id/keypairs<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.24.0</h3>…
  • GETRequest Room Policies/v4/nodes/rooms/:room_id/policies<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.32.0</h3>…
  • PUTSet room policies/v4/nodes/rooms/:room_id/policies<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.32.0</h3>…
  • GETRequest list of all assigned S3 tags to the room/v4/nodes/rooms/:room_id/s3_tags<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.9.0</h3> Description:…
  • POSTSet S3 tags for a room/v4/nodes/rooms/:room_id/s3_tags<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.9.0</h3> Description:…
  • GETRequest room granted user(s) or / and user(s) that can be granted/v4/nodes/rooms/:room_id/users?offset=0&limit=0&filter=string&sort=stringDescription: Retrieve a list of users that are and / or can be granted to the room. Precondition: Any permissions on target room. Postcondition: None. Further…
  • PUTAdd or change room granted user(s)/v4/nodes/rooms/:room_id/usersDescription: All existing user permissions will be overwritten. Precondition: User needs to be a <span style='padding: 3px; background-color: #F6F7F8; border:…
  • DELETERevoke granted user(s) from room/v4/nodes/rooms/:room_id/usersDescription: Revoke granted users from room. Precondition: User needs to be a <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000;…
  • GETRequest list of webhooks that are assigned or can be assigned to this room/v4/nodes/rooms/:room_id/webhooks?offset=0&limit=0&filter=string<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.19.0</h3>…
  • PUTAssign or unassign webhooks to room/v4/nodes/rooms/:room_id/webhooks<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.19.0</h3>…
  • GETSearch nodes/v4/nodes/search?search_string=string&depth_level=0&parent_id=0&filter=string&sort=string&offset=0&limit=0Description: Provides a flat list of file system nodes (rooms, folders or files) of a given parent that are accessible by the current user. Precondition:…
  • POSTGenerate download URL for ZIP download/v4/nodes/zipDescription: Create a download URL to retrieve several files in one ZIP archive. Precondition: User has <span style='padding: 3px; background-color: #F6F7F8;…
  • POSTDownload files / folders as ZIP archive/v4/nodes/zip/downloadDescription: Download multiple files in a ZIP archive. Precondition: User has <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000;…
  • GETRequest node/v4/nodes/:node_idDescription: Get node (room, folder or file). Precondition: User has <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000;…
  • DELETERemove node/v4/nodes/:node_idDescription: Delete node (room, folder or file). Precondition: Authenticated user with <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid…
  • GETRequest list of node comments/v4/nodes/:node_id/comments?offset=0&limit=0&hide_deleted=true<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.10.0</h3>…
  • POSTCreate node comment/v4/nodes/:node_id/comments<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.10.0</h3>…
  • POSTCopy node(s)/v4/nodes/:node_id/copy_toDescription: Copies nodes (folder, file) to another parent. Precondition: Authenticated user with <span style='padding: 3px; background-color: #F6F7F8;…
  • GETRequest list of deleted nodes/v4/nodes/:node_id/deleted_nodes?filter=string&sort=string&offset=0&limit=0Description: Retrieve a list of deleted nodes in a recycle bin. Precondition: User can access parent room and has <span style='padding: 3px; background-color:…
  • DELETEEmpty recycle bin/v4/nodes/:node_id/deleted_nodesDescription: Empty a recycle bin. Precondition: User has <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000; border-radius: 5px;…
  • GETRequest deleted versions of nodes/v4/nodes/:node_id/deleted_nodes/versions?type=string&name=string&sort=string&offset=0&limit=0Description: Retrieve all deleted versions of a node. Precondition: User can access parent room and has <span style='padding: 3px; background-color: #F6F7F8;…
  • POSTMark a node (room, folder or file) as favorite/v4/nodes/:node_id/favoriteDescription: Marks a node (room, folder or file) as favorite. Precondition: Authenticated user is allowed to <span style='padding: 3px; background-color:…
  • DELETEUnmark a node (room, folder or file) as favorite/v4/nodes/:node_id/favoriteDescription: Unmarks a node (room, folder or file) as favorite. Precondition: Authenticated user is allowed to <span style='padding: 3px; background-color:…
  • POSTMove node(s)/v4/nodes/:node_id/move_toDescription: Moves nodes (folder, file) to another parent. Precondition: Authenticated user with <span style='padding: 3px; background-color: #F6F7F8; border:…
  • GETRequest list of parent nodes/v4/nodes/:node_id/parents<h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>&#128640; Since v4.10.0</h3>…

API details

Authentication
OAuth 2.0 (authorization code flow) with 1 scope
Operations
297 operations on 181 pathsGET 131POST 63PUT 57DELETE 43HEAD 3
18 marked deprecated
Main resources
nodes 66user 44system-auth-config 21public 19shares 18provisioning 17settings 16users 14config 13groups 11
Response formats
application/json application/octet-stream */* text/plain
Description format
OpenAPI 3.0.1, API version 4.42.2
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the DRACOON API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the DRACOON API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Request all roles with assigned rights” (GET /v4/roles), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the DRACOON API?

REST Web Services for DRACOON This page provides an overview of all available and documented DRACOON APIs, which are grouped by tags. Each tag provides a… It is listed under Developer tools and has 297 endpoints.

Who publishes the DRACOON API?

It is listed from Dracoon's public API description (an OpenAPI document), not published by Dracoon on Swastik Codes. Anyone who controls dracoon.team can claim the profile by adding a DNS TXT record.

How do I authenticate with the DRACOON API?

With OAuth 2.0 (authorization code flow) with 1 scope.

How many endpoints does the DRACOON API have?

297 operations on 181 paths (131 GET, 63 POST, 57 PUT, 43 DELETE, 3 HEAD). The largest groups are nodes, user, system-auth-config, public.

Is forking the DRACOON API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.