Skip to content

DRACOON API API

by dracoon.team

OAuthHTTPSCloud Platforms
Open documentation ↗

Overview

REST Web Services for DRACOON<br><br>This page provides an overview of all available and documented DRACOON APIs, which are grouped by tags.<br>Each tag provides a collection of APIs that are intended for a specific area of the DRACOON.<br><br><a title='Developer Information' href='https://developer.dracoon.com'>Developer Information</a>&emsp;&emsp;<a title='Get SDKs on GitHub' href='https://github.com/dracoon'>Get SDKs on GitHub</a><br><br><a title='Terms of service' href='https://www.dracoon.com/terms/general-terms-and-conditions/'>Terms of service</a>

DRACOON API is a cloud platforms API from dracoon.team. Requests are authenticated with OAuth. It is served over HTTPS. Its OpenAPI description documents 294 endpoints.

At a glance

Authentication
OAuth
HTTPS
Yes
CORS
Unknown
Version
4.42.2
Endpoints
294
Spec updated
2023-03-06

Endpoints

MethodPathWhat it does
POST/v4/auth/logindeprecatedAuthenticate user (Login)
GET/v4/auth/openid/logindeprecatedInitiate OpenID Connect authentication
POST/v4/auth/openid/logindeprecatedComplete OpenID Connect authentication
GET/v4/auth/pingPing
POST/v4/auth/recover_usernameRecover username
POST/v4/auth/reset_passwordRequest password reset
GET/v4/auth/reset_password/{token}Validate information for password reset
PUT/v4/auth/reset_password/{token}Reset password
GET/v4/config/info/defaultsRequest default values
GET/v4/config/info/generalRequest general settings
GET/v4/config/info/infrastructureRequest infrastructure properties
GET/v4/config/info/notifications/channelsRequest list of notification channels
GET/v4/config/info/policies/algorithmsRequest algorithms
GET/v4/config/info/policies/classificationsRequest classification policies
GET/v4/config/info/policies/guest_usersRequest guest users policies
GET/v4/config/info/policies/passwordsRequest password policies
GET/v4/config/info/product_packagesRequest list of product packages
GET/v4/config/info/product_packages/currentRequest list of currently enabled product packages
GET/v4/config/info/s3_tagsRequest list of configured S3 tags
GET/v4/config/settingsdeprecatedRequest system settings
PUT/v4/config/settingsdeprecatedUpdate system settings
GET/v4/downloads/avatar/{user_id}/{uuid}Download avatar
GET/v4/downloads/zip/{token}Download ZIP archive
GET/v4/downloads/{token}Download file
GET/v4/eventlog/audits/node_infoRequest nodes
GET/v4/eventlog/audits/nodesdeprecatedRequest node assigned users with permissions
GET/v4/eventlog/eventsRequest system events
GET/v4/eventlog/operationsRequest allowed Log Operations
GET/v4/groupsRequest list of user groups
POST/v4/groupsCreate new user group
GET/v4/groups/{group_id}Request user group
PUT/v4/groups/{group_id}Update user group's metadata
DELETE/v4/groups/{group_id}Remove user group
GET/v4/groups/{group_id}/last_admin_roomsRequest rooms where the group is defined as last admin group
GET/v4/groups/{group_id}/rolesRequest list of roles assigned to the group
GET/v4/groups/{group_id}/roomsdeprecatedRequest rooms granted to the group or / and rooms that can be granted
GET/v4/groups/{group_id}/usersRequest group member users or / and users who can become a member
POST/v4/groups/{group_id}/usersAdd group members
DELETE/v4/groups/{group_id}/usersRemove group members
GET/v4/internal/tenant/subscription_planRequest subscription plan
PUT/v4/internal/tenant/subscription_planSet subscription plan
GET/v4/nodesRequest list of nodes
DELETE/v4/nodesRemove nodes
PUT/v4/nodes/comments/{comment_id}Edit node comment
DELETE/v4/nodes/comments/{comment_id}Remove node comment
DELETE/v4/nodes/deleted_nodesRemove nodes from recycle bin
POST/v4/nodes/deleted_nodes/actions/restoreRestore deleted nodes
GET/v4/nodes/deleted_nodes/{deleted_node_id}Request deleted node
PUT/v4/nodes/favoritesMark or unmark a list of nodes (room, folder or file) as favorite
PUT/v4/nodes/filesUpdates a list of file’s metadata
POST/v4/nodes/files/keysSet file keys for a list of users and files
POST/v4/nodes/files/uploadsCreate new file upload channel
GET/v4/nodes/files/uploads/{upload_id}Request status of S3 file upload
POST/v4/nodes/files/uploads/{upload_id}deprecatedUpload file
PUT/v4/nodes/files/uploads/{upload_id}deprecatedComplete file upload
DELETE/v4/nodes/files/uploads/{upload_id}Cancel file upload
PUT/v4/nodes/files/uploads/{upload_id}/s3Complete S3 file upload
POST/v4/nodes/files/uploads/{upload_id}/s3_urlsGenerate presigned URLs for S3 file upload
GET/v4/nodes/files/versions/{reference_id}Request list of file versions
PUT/v4/nodes/files/{file_id}Updates a file’s metadata
GET/v4/nodes/files/{file_id}/data_room_file_keydeprecatedRequest room rescue key
GET/v4/nodes/files/{file_id}/data_space_file_keydeprecatedRequest system rescue key
POST/v4/nodes/files/{file_id}/downloadsGenerate download URL
GET/v4/nodes/files/{file_id}/user_file_keyRequest user's file key
POST/v4/nodes/foldersCreate new folder
PUT/v4/nodes/folders/{folder_id}Updates folder’s metadata
GET/v4/nodes/missingFileKeysRequest files without user's file key
POST/v4/nodes/roomsCreate new room
GET/v4/nodes/rooms/pendingRequest user-room assignments per group
PUT/v4/nodes/rooms/pendingHandle user-room assignments per group
PUT/v4/nodes/rooms/{room_id}Updates room’s metadata
PUT/v4/nodes/rooms/{room_id}/configConfigure room
PUT/v4/nodes/rooms/{room_id}/encryptEncrypt room
GET/v4/nodes/rooms/{room_id}/eventsRequest events of a room
GET/v4/nodes/rooms/{room_id}/groupsRequest room granted group(s) or / and group(s) that can be granted
PUT/v4/nodes/rooms/{room_id}/groupsAdd or change room granted group(s)
DELETE/v4/nodes/rooms/{room_id}/groupsRevoke granted group(s) from room
PUT/v4/nodes/rooms/{room_id}/guest_usersAdd guest users to a room
GET/v4/nodes/rooms/{room_id}/keypairRequest room rescue key
POST/v4/nodes/rooms/{room_id}/keypairSet room's rescue key pair
DELETE/v4/nodes/rooms/{room_id}/keypairRemove rooms's rescue key pair
GET/v4/nodes/rooms/{room_id}/keypairsRequest all room rescue key pairs
POST/v4/nodes/rooms/{room_id}/keypairsCreate key pair and preserve copy of old private key
GET/v4/nodes/rooms/{room_id}/policiesRequest Room Policies
PUT/v4/nodes/rooms/{room_id}/policiesSet room policies
GET/v4/nodes/rooms/{room_id}/s3_tagsRequest list of all assigned S3 tags to the room
POST/v4/nodes/rooms/{room_id}/s3_tagsSet S3 tags for a room
GET/v4/nodes/rooms/{room_id}/usersRequest room granted user(s) or / and user(s) that can be granted
PUT/v4/nodes/rooms/{room_id}/usersAdd or change room granted user(s)
DELETE/v4/nodes/rooms/{room_id}/usersRevoke granted user(s) from room
GET/v4/nodes/rooms/{room_id}/webhooksRequest list of webhooks that are assigned or can be assigned to this room
PUT/v4/nodes/rooms/{room_id}/webhooksAssign or unassign webhooks to room
GET/v4/nodes/searchSearch nodes
POST/v4/nodes/zipGenerate download URL for ZIP download
POST/v4/nodes/zip/downloadDownload files / folders as ZIP archive
GET/v4/nodes/{node_id}Request node
DELETE/v4/nodes/{node_id}Remove node
GET/v4/nodes/{node_id}/commentsRequest list of node comments
POST/v4/nodes/{node_id}/commentsCreate node comment
POST/v4/nodes/{node_id}/copy_toCopy node(s)

Showing the first 100 of 294 endpoints; the full list is in the documentation.

Questions

Does the DRACOON API API need an API key?

Yes. The DRACOON API API uses OAuth authentication; the documentation explains how to get credentials.

Does the DRACOON API API support HTTPS?

Yes, the DRACOON API API is served over HTTPS.

How many endpoints does the DRACOON API API have?

Its OpenAPI description lists 294 endpoints in version 4.42.2. The first 100 are shown on this page.

What are alternatives to the DRACOON API API?

Other Cloud Platforms APIs include Remote Settings PROD, Linode API, DigitalOcean API, Vercel API, Platform API.

Compare alternatives →

Remote Settings PROD

Cloud Platforms

Firefox is a free web browser backed by Mozilla, a non-profit dedicated to internet health and privacy.

No auth19 endpoints

Linode API

Cloud Platforms

## Introduction The Linode API provides the ability to programmatically manage the full range of Linode products and services. This reference is designed to assist application developers and system administrators. Each endpoint includes descriptions, request syntax, and examples using standard HTTP requests. Response data is returned in JSON format. This document was generated from our OpenAPI Specification. See the <a target="_top" href="https://www.openapis.org">OpenAPI website</a> for more information. <a target="_top" href="/docs/api/openapi.yaml">Download the Linode OpenAPI Specification</a>. ## Changelog <a target="_top" href="/docs/products/tools/api/release-notes/">View our Changelog</a> to see release notes on all changes made to our API. ## Access and Authentication Some endpoints are publicly accessible without requiring authentication. All endpoints affecting your Account, however, require either a Personal Access Token or OAuth authentication (when using third-party applications). ### Personal Access Token The easiest way to access the API is with a Personal Access Token (PAT) generated from the <a target="_top" href="https://cloud.linode.com/profile/tokens">Linode Cloud Manager</a> or the [Create Personal Access Token](/docs/api/profile/#personal-access-token-create) endpoint. All scopes for the OAuth security model ([defined below](/docs/api/profile/#oauth)) apply to this security model as well. #### Authentication | Security Scheme Type: | HTTP | |-----------------------|------| | **HTTP Authorization Scheme** | bearer | ### OAuth If you only need to access the Linode API for personal use, we recommend that you create a [personal access token](/docs/api/#personal-access-token). If you're designing an application that can authenticate with an arbitrary Linode user, then you should use the OAuth 2.0 workflows presented in this section. For a more detailed example of an OAuth 2.0 implementation, see our guide on [How to Create an OAuth App with the Linode Python API Library](/docs/products/tools/api/guides/create-an-oauth-app-with-the-python-api-library/#oauth-2-authentication-exchange). Before you implement OAuth in your application, you first need to create an OAuth client. You can do this [with the Linode API](/docs/api/account/#oauth-client-create) or [via the Cloud Manager](https://cloud.linode.com/profile/clients): - When creating the client, you'll supply a `label` and a `redirect_uri` (referred to as the Callback URL in the Cloud Manager). - The response from this endpoint will give you a `client_id` and a `secret`. - Clients can be public or private, and are private by default. You can choose to make the client public when it is created. - A private client is used with applications which can securely store the client secret (that is, the secret returned to you when you first created the client). For example, an application running on a secured server that only the developer has access to would use a private OAuth client. This is also called a confidential client in some OAuth documentation. - A public client is used with applications where the client secret is not guaranteed to be secure. For example, a native app running on a user's computer may not be able to keep the client secret safe, as a user could potentially inspect the source of the application. So, native apps or apps that run in a user's browser should use a public client. - Public and private clients follow different workflows, as described below. #### OAuth Workflow The OAuth workflow is a series of exchanges between your third-party app and Linode. The workflow is used to authenticate a user before an application can start making API calls on the user's behalf. Notes: - With respect to the diagram in [section 1.2 of RFC 6749](https://tools.ietf.org/html/rfc6749#section-1.2), login.linode.com (referred to in this section as the *login server*) is the Resource Owner and the Authorization Server; api.linode.com (referred to here as the *api se

Bearer token350 endpoints

DigitalOcean API

Cloud Platforms

# Introduction The DigitalOcean API allows you to manage Droplets and resources within the DigitalOcean cloud in a simple, programmatic way using conventional HTTP requests. All of the functionality that you are familiar with in the DigitalOcean control panel is also available through the API, allowing you to script the complex actions that your situation requires. The API documentation will start with a general overview about the design and technology that has been implemented, followed by reference information about specific endpoints. ## Requests Any tool that is fluent in HTTP can communicate with the API simply by requesting the correct URI. Requests should be made using the HTTPS protocol so that traffic is encrypted. The interface responds to different methods depending on the action required. |Method|Usage| |--- |--- | |GET|For simple retrieval of information about your account, Droplets, or environment, you should use the GET method. The information you request will be returned to you as a JSON object. The attributes defined by the JSON object can be used to form additional requests. Any request using the GET method is read-only and will not affect any of the objects you are querying.| |DELETE|To destroy a resource and remove it from your account and environment, the DELETE method should be used. This will remove the specified object if it is found. If it is not found, the operation will return a response indicating that the object was not found. This idempotency means that you do not have to check for a resource's availability prior to issuing a delete command, the final state will be the same regardless of its existence.| |PUT|To update the information about a resource in your account, the PUT method is available. Like the DELETE Method, the PUT method is idempotent. It sets the state of the target using the provided values, regardless of their current values. Requests using the PUT method do not need to check the current attributes of the object.| |PATCH|Some resources support partial modification. In these cases, the PATCH method is available. Unlike PUT which generally requires a complete representation of a resource, a PATCH request is is a set of instructions on how to modify a resource updating only specific attributes.| |POST|To create a new object, your request should specify the POST method. The POST request includes all of the attributes necessary to create a new object. When you wish to create a new object, send a POST request to the target endpoint.| |HEAD|Finally, to retrieve metadata information, you should use the HEAD method to get the headers. This returns only the header of what would be returned with an associated GET request. Response headers contain some useful information about your API access and the results that are available for your request. For instance, the headers contain your current rate-limit value and the amount of time available until the limit resets. It also contains metrics about the total number of objects found, pagination information, and the total content length.| ## HTTP Statuses Along with the HTTP methods that the API responds to, it will also return standard HTTP statuses, including error codes. In the event of a problem, the status will contain the error code, while the body of the response will usually contain additional information about the problem that was encountered. In general, if the status returned is in the 200 range, it indicates that the request was fulfilled successfully and that no error was encountered. Return codes in the 400 range typically indicate that there was an issue with the request that was sent. Among other things, this could mean that you did not authenticate correctly, that you are requesting an action that you do not have authorization for, that the object you are requesting does not exist, or that your request is malformed. If you receive a status in the 500 range, this generally indicates a server-side problem. This means that we are having

Bearer token290 endpoints

Vercel API

Cloud Platforms

Vercel combines the best developer experience with an obsessive focus on end-user performance. Our platform enables frontend teams to do their best work.

Bearer token112 endpoints

Platform API

Cloud Platforms

The [REST API specification](https://www.ably.io/documentation/rest-api) for Ably.

HTTP Basic22 endpoints

Azure Data Lake Storage

Cloud Platforms

Azure Data Lake Storage provides storage for Hadoop and other big data workloads.

No auth10 endpoints

Listed from APIs.guru (CC0).