API and SDKs

All about our REST API and the SDKs that we provide to our community. Suggestions / Bug reports / Feature requests

avatar

pvansluisveld

Filter by subType while using API

Is there a way to filter on "subType" for entries within a vault using API? We want to get all entries with subType "X.509" inside our vaults, without retrieving all entries within the vault. For example: https://<https://dvls-server>/api/v1/vault/42ee6ef3-2b83-4dd5-b5e5-6e6ba64dae56/entry?pageSize=100&pageNumber=0& subType=X509

34

2

avatar

Patrick Ouimet

avatar

sarahpho

Implemented

Rest API Documentation

Hello, I am looking for a way to integrate my system with Devolutions via Rest calls triggered by a Java script. I was browsing through the Github repository and found this documentation . Sadly, it does not mention Rest API. Can you give me an exemple on how to retrieve all entries from a vault and the credentials from a single entry via Rest calls ? I hope you can help me out with this. Best wishes, Sarah Pho

3096

33

avatar

Maxim Robert

avatar

pvansluisveld

Resolved

Application identity get all vaults works but data inside a vault is empty

I created a application identity inside our Devolutions Server. With the application id/secret I'm able to get a TokenID. With this TokenID I'm also able to get a list of all our Vaults. When I try to get data inside one of our Vaults I'm getting no data back in our response. And yes there are entries inside this specific vault. Application identity [image] [image] Login [image] Get all vaults [image] Get all entries inside one of our vaults, but no data. [image]

Recommended Answer

a month ago

Hello, Thank you for reaching out on this matter. It appears that the application identity may not have sufficient permissions to view entries within the vault. I recommend assigning the application identity to a user group, then granting that group access to the specific entries in the target vault. You may also want to temporarily grant this group administrative rights to confirm whether the issue is permission-related. Once the appropriate permissions are in place, you should be able to retrieve the entries successfully using the same API request as before. Please let us know if you have any questions or if the issue persists. Best regards,

47

4

avatar

Jacob Lafrenière

avatar

stefansuess

ConnectionType 'SessionTool' or Type 30 only returns empty values

I am trying to get the values of type SessionTool via the API, but it seems that all the values are empty. request path: "/api/v1/vault/{vault_id}/entry/{cred_id}" is it that the return values are currently not defined within the API? We would need this to get the data for automatic start and stop of servers. { "id": "ffffffff-1234-5678-ffff-123456789090", "name": "AZURE_STOPURL - myserver", "description": "", "path": "tenant\\myserver", "type": "SessionTool", "subType": "", "tags": [], "data": { "domain": "", "username": "", "customField1Hidden": false, "customField1Title": "", "customField1Value": "", "customField1ValueSensitive": "", "customField2Hidden": false, "customField2Title": "", "customField2Value": "", "customField2ValueSensitive": "", "customField3Hidden": false, "customField3Title": "", "customField3Value": "", "customField3ValueSensitive": "", "customField4Hidden": false, "customField4Title": "", "customField4Value": "", "customField4ValueSensitive": "", "customField5Hidden": false, "customField5Title": "", "customField5Value": "", "customField5ValueSensitive": "", "customFieldEntities": [] }, "modifiedOn": "2025-09-29T07:55:14", "modifiedBy": "me@mycompany.tld", "createdOn": "2025-09-29T07:54:45", "createdBy": "me@mycompany.tld" }

186

4

avatar

Patrick Ouimet

avatar

damiendaco

REST API - Automation of server entries creation

Hi, We're using Devolutions server version 2025.1.11.0 We're automating the creation of our environments, and we would like to automate the creation of entries (Adding both Windows and Linux servers within our inventory) Our automation tool is Gitlab CI. We can run docker images, Python scripts etc. Is there a way to create entries with Python? I google quite a bit but I'm struggling to find the documentation. Regards, Damien Daco

378

12

avatar

François Dubois

avatar

michaelgauck

Devolutions Server REST API - Create entries in shared vault - error 500

Hello, i have tried using the API of the devolutions server (newest version 2025.1.5.0). We are using a shared vault on MSSQL. I can login, GET the vaults and then GET entries inside that vault but as soon as i want to create entries using POST to /api/v1/vault/{vaultId}/entry, i get error 500 (entires i tried to create were folders and sshconnections). i have tried with different JSONs but i only get this error: "the specified entry type is not supporting on edit" [image] I can not find any information about this error or if i try doing something that is not allowed/supported - any help? :) Best Regards Michael

358

6

avatar

Patrick Ouimet

avatar

mnr

Possible to get RDM REST API access in user context?

Hi all, We are hoping there is a way to get access to the RDM REST API in the current users context and not with a API Key/Secret as this has read/write (depending on role?) permission to all the entries in the vault(s). It seems the documentation about this is a bit lacking ( https://docs.devolutions.net/server/web-interface/utilities/api-documentation ) (https://{ACTUAL-RDM-URL}/api-documentation) Is it possible to get any of the following to work - and if so how do we do that? Get an access token from our IdP (Entra) by OAuth 2.0 (user delegation/auth code/interactive login...?) and use this in a https request header to the API Get an access token from using "Authorisation: Basic user pass" in a https request header to the API login endpoint Get an access token from using the windows login current user credentials somehow (We have also setup SSO with AD and Entra in Devolutions Server) Another way to query the API in a user context? Thanks in advance :)

576

8

avatar

Alexandre Martigny

avatar

Thomas Hofkens

API possibilities

Hi, Our company has decided we want to store our passwords in Delinea password manager while using RDM with DVLS back-end to manage our connections to the customer. We already have the necessary plug-in on DVLS to use Delinea secrets. My goal is to give my colleagues as less administration as possible. That's why I would like to utilize the events in Delinea so that anytime a new entry is added or removed, the DVLS API is called to create a Delinea reference in RDM. That way my colleagues don't have to add an entry in Delinea and create a reference in DVLS manually. I've run into the following issues with the DVLS API: I cannot add a Delinea reference object. If I'm correct, only the following types can be added through the API: PrivateKey Default AccessCode ApiKey AzureServicePrincipal ConnectionString Passkey I can query it partly, though: id : c534906f-17db-457a-8da1-4e3f01832a05 name : TEST - REMOVE ME PLEASE - NO QUESTIONS ASKED description : path : CustomerName\_credentials type : Credential subType : SecretServerRest tags : {} data : @{domain=; username=} modifiedOn : 2025-01-13T15:19:46 modifiedBy : createdOn : 2025-01-13T15:19:46 createdBy : me,myself-and-I It doesn't have the important properties for this type of credential and domain and username in data are empty. Am I correct or missing something I shouldn't? Best regards, Thomas

414

4

avatar

Erica Poirier

avatar

enesgortekin06

Asset Hardware Information via REST API

I want to get asset hardware information via REST API. But All the data I can get is just this. Can I get the Asset Hardware Information of the entry? Is this possible? [image]

336

2

avatar

Erica Poirier

avatar

asharafbhatti199

Resolved

Change password

Hi i am new to this Vpn how to change password

516

5

avatar

broyer

avatar

joleite

Backlog

Update-DSUser always returning "WebApiRedirectToLogin"

Hi, I'm trying to create a script using the devolution PowerShell module to enable or disable user based on a AD group. But before starting with the major sync part I wanted to test with a user in our test environment and it failings all the time the command "Update-DSUser". Bellow is the code I'm using to do this, from what I see everything seems to be ok but, maybe I missed something. Can you help me please? $env:DS_URL= 'https://DVLS.local/dvls' $DVLSUrl = $env:DS_URL $appkey = "XXXXXXXXXXX" $appsecret = "XXXXXXXXXXXXXXXXXXXXXX" $SecPassword = ConvertTo-SecureString $appsecret -AsPlainText -Force $Creds = New-Object System.Management.Automation.PSCredential ($appkey,$SecPassword) $Response = New-DSSession -Credential $Creds -BaseURI $DVLSUrl -AsApplication $UserID = $((Get-DSUser -All).data | where {$_.name -eq 'User name'}).id $enabled = $(Update-DSUser -UserID $UserID -Enabled $true) The error: [image] Kind regards

353

8

avatar

François Dubois

avatar

n02

Resolved

Documentation of the SDK

Helle dear support team, is there a in-depth documentation of the SDK? I've already downloaded it and started to get code working to log in and off, but there seems to be no documentation on how to create a password document. The DVLS_functions.txt file that is included in the source files isn't even up to date and I can't make sense out of simply the code that is provided. Can you give me a simple working example on how to create an entry as a username / password document? It would be great to see how I would go about creating an entry that has a password included. I hope you can help me out with this. best wishes, Niklas Heine

2259

32

avatar

Erica Poirier

avatar

OKI-IT

Resolved

Error COMException

Hello everyone, have the following error. How can I fix it? Error: COMException - Der Server ist nicht funktionstüchtig. at System.DirectoryServices.DirectoryEntry.Bind(Boolean throwIfFail) at System.DirectoryServices.PropertyValueCollection.PopulateList() at System.DirectoryServices.PropertyValueCollection..ctor(DirectoryEntry entry, String propertyName) at System.DirectoryServices.PropertyCollection.get_Item(String propertyName) at System.DirectoryServices.AccountManagement.PrincipalContext.DoLDAPDirectoryInitNoContainer() at System.DirectoryServices.AccountManagement.PrincipalContext.Initialize() at System.DirectoryServices.AccountManagement.AuthZSet.get_CurrentAsPrincipal() at System.DirectoryServices.AccountManagement.FindResultEnumerator`1.get_Current() at Devolutions.Server.ActiveDirectory.Microsoft.PrincipalReader.MsPrincipalGetGroupsByUser.GetGroupsByUser(UserPrincipal userPrincipal, IEnumerable`1 groups, Stopwatch stopwatch) --- DirectoryServices - Error reading authorization groups for the user, XXXXXXX

426

8

avatar

Min Destens

avatar

multileech

Automatic Import of Sessions via PowerShell and Devolution Server

Hello, I would like to inquire if it is possible to use PowerShell for the automatic import of sessions, utilizing Devolution Server as the backend. I understand that this can be done through RD Manager, but I am looking for a seamless and automatic solution. My specific requirements include: The ability to import, update, and remove sessions from VMware using PowerShell or any other automated way. We are working with multiple session types, such as SSH, RDP, etc. Enforcing OTP for every user logging into RDM through Devolution Server, using it as the source. Access to comprehensive documentation on using PowerShell with Devolution Server, particularly focusing on managing the server without the RD Manager. Is this feasible? Lastly, I would appreciate an explanation of the benefits of using Devolution Server compared to directly connecting RDM with MSSQL. What justifies the additional investment? Can i get some person/support to answer my questions and help with setup during the POC? Thank you in advance for your assistance. Best regards,

397

2

avatar

Richard Boisvert

avatar

bvi1998

Getting a password

Hi, I have retrieved the Vault id and would now like to retrieve the password for a user name, but I do not know how to retrieve the entryid required in the command, can you assist me please? I am using the Get-DSEntrySensitiveData <Entry Id guid > command. Thanks, Jen

792

4

avatar

Alexandre Martigny

avatar

bvi1998

Change a password

Hi, Can we use the PS module to change the password for an entity? Thanks

400

2

avatar

Alexandre Martigny

avatar

bvi1998

Error while retreiving tokens

Hi, I am using my domain id to authenticate to the Devolutions Server. I have tried my domain id with and without the domain name. No matter what I do I receive this message. I can authenticate as an application, that works ok. Can someone help me with this issue? New-DSSession: [New-DSSession] There was a problem reaching your DVLS instance. Either you provided a wrong URL or it's not pointing to a DVLS instance. Exception: C:\Windows\System32\WindowsPowerShell\v1.0\Modules\Devolutions.Server\Private\OAuth (WIP)\Request-DSOAuthAccessToken.ps1:25 Line | 25 | throw 'Error while retreiving tokens.' | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | Error while retreiving tokens.

720

4

avatar

bvi1998

avatar

quilleo

creating a new DS entry from an existing entry using the new Devolutions.Server module

Looking at the module and the cmdlets it is not obvious to me how best to create a new DS entry by 'cloning' an existing entry. The RDM module had a concept of using a template to create a new session. I would like all the settings to be maintained in the 'template' entry (can just be a normal entry) and then clone it with a new name and placed in a different group. Any suggestions? Thanks Ed

578

5

avatar

Richard Boisvert

avatar

claudionobili

Create New SShEntry with private key from Vault

Hi, is it possible to create , with api , a new sshentry with a private key that is stored in vault , and not only from file ? Within parameters of NewDSSSHShellEntry api i found only PrivateKeyPath , but this must point to a file containing the private key . If yes how can i do it ? Thanks Claudio

401

3

avatar

claudionobili

avatar

claudionobili

Error using Update-DSSSHShellEntry

Hi, i'm trying to update Shell Entry viA PowerShell with this command : $UpdatedSSHShellEntry = @{ EntryID = $entry.id Description = "Entry Aggiornata via PowerShell" } Update-DSSSHShellEntry @UpdatedSSHShellEntry where $entry.id is the entry id of my ssh entry ( with value 8674d0cc-31d1-4000-9cd9-3e7b3131b65e ) . The command exit with this two errors : Line | 44 | Update-DSSSHShellEntry @UpdatedSSHShellEntry | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | A positional parameter cannot be found that accepts argument '8674d0cc-31d1-4000-9cd9-3e7b3131b65e'. InvalidOperation: C:\Program Files\WindowsPowerShell\Modules\Devolutions.Server\2022.1.10.0\Public\Entries\Update-DSSSHShellEntry.ps1:308:13 Line | 308 | if ($res.isSuccess) { | ~~~~ | The variable '$res' cannot be retrieved because it has not been set. Could you help me ? I

334

6

avatar

claudionobili

avatar

apps

Resolved

Connect to REST API with Python natively

First: Yes I know there is a powershell module. Yes, the python SDK is deprecated. Yes I know there is the CLI. But: For a special project I have to use Python to access the devolutions server REST API and I cant even get past authentication. I tried to reverse the powershell code but I lack the necessary knowledge of encryption to understand fully what is going on. From what I understand,, the PublicKey is grabbed from /api/server-information. A 32 Byte Session Key is generated and encrypted with RSA with this PublicKey. Finally the Application Secret is encrypted with AES CBC using the 32 Byte Session Key. Both are then supplied via REST as hex-strings to the server. But I always end up getting "InvalidUserNameOrPasswordPleaseVerifyYourCredentials". (Same credentials work with PowerShell) Has anyone got authentication working with python? I would reverse the python SDK but it disappeared from github.

930

2

avatar

apps

avatar

Andreas

Implemented

Bug: Invalid Credentials Exception since DVLS Update 2022.1.10.0

Ive updated today to DVLS 2022.1.10.0 and now im not able anymore to authenticate via Powershell Module: [image] Global Var DSSessionToken is set but dont look like its a valid token: [image] [image] The Username and Password set in Credential Manager are 100% correct. Login direct via Web is possible. Report Log: [image] PS Module: 2021.6.4 - I also tried the current Version from GitHub. PowerShell 7.2.1 Best Regards Andreas

451

12

avatar

Richard Boisvert

1 - 25 of 37 items