API documentation

You can find detailed instructions for the Devolutions Server REST API in the API documentation section of the Devolutions Server web interface.

Utilities – API documentation
Utilities – API documentation

To connect and use the REST API, refer to the sample bash script below. For each API call to the server, ensure you:

  • Replace "https://url" with your specific Devolutions Server URL.
  • Replace "GUID-OF-VAULT" and "GUID-OF-ENTRY" with their corresponding GUIDs.
# Log in and get token
authResponse=$(curl -s -X POST "https://url/api/v1/login" \
    -H "Content-Type: application/json" \
    -d '{
        "appKey": "appkey",
        "appSecret": "appsecret"
token=$(echo $authResponse | jq -r '.tokenId')

# Check if token was successfully obtained
if [ -z "$token" ] || [ "$token" = "null" ]; then
  echo "Failed to login or obtain token."
  exit 1

# Request data using the token
response=$(curl -s -X GET "https://url/api/v1/vault/GUID-OF-VAULT/entry/GUID-OF-ENTRY" \
    -H "Content-Type: application/json" \
    -H "tokenId: $token")

echo $response | jq

# Log out
curl -s -X POST "https://url/api/v1/logout" \
    -H "Content-Type: application/json" \
    -H "tokenId: $token" \
    -H "Content-Length: 0"
Give us Feedback