The latest Elements API release adds new fields to the invitations object returned by the Send new device invitations and List invitations endpoints (POST and GET /invitations/v1/invitations). These fields provide the caller with the urls sent with the invite.

This is an additive, backward-compatible change. Existing integrations continue to work without modification. New fields are populated when they are present in the invitation. The actual urls are invite specific.

New top-level fields

In both service’s responses:

• androidLink (string): Link to the android installer
• iosLink (string): Link to the iOS installer
• windowsLink (string): Link to the Windows installer
• macLink (string): Link to the Mac installer

See the full Elements API specification for details: 

https://connect.withsecure.com/api-reference/elements#get-/invitations/v1/invitations

The latest Elements API release brings a new audit log listing operation.

This service exports the same data as you see in the elements UI when you go to the audit logs section. The data can be localized to all the languages our portal supports.

See the full Elements API specification from here

The latest Elements API release adds new fields to the computer device object returned by the Query devices endpoint (GET /devices/v1/devices). These fields provide richer visibility into device security posture, BitLocker encryption status, and policy configuration.

This is an additive, backward-compatible change. Existing integrations continue to work without modification. New fields are populated when reported by the agent on the device and may be absent on older agents or non-applicable platforms.

New top-level fields

Security policy and tamper protection (reported by the Windows agent):

• allowUsersToTurnOffSecurityFeatures (boolean): Whether users are allowed to turn off security features on the device
• allowUsersToUninstallProduct (boolean): Whether local users are allowed to uninstall the security product
• tamperProtectionEnabled (boolean): Whether tamper protection is enabled
• uninstallationPasswordSet (boolean): Whether an uninstallation password has been configured
• uninstallationPasswordEmpty (boolean): Whether the uninstallation password is empty (not configured or blank)

BitLocker and disk encryption (reported by the Windows agent):

• bitlockerOverallProtectionStatus (string): Overall BitLocker protection status (all, some, or none)
• bitlockerRecoveryKeysCollectionEnabled (boolean): Whether BitLocker recovery key collection is enabled in the device’s policy
• bitlockerRecoveryKeysCollectionSuccess (boolean): Whether the most recent BitLocker recovery key collection completed successfully
• diskEncryptionPolicy (string): Disk encryption policy (profile protection setting) applied to the device
• policyUseTpm (string): Policy setting for using the Trusted Platform Module (TPM)
• policyUseTpmWithStartupPin (string): Policy setting for using TPM with a startup PIN
• tpmAvailable (boolean): Whether a TPM chip is available on the device
• encryptedDrives (array): List of drives and their BitLocker encryption status (see below)

Device lifecycle (reported by the agent):

• lastRestartTime (string, date-time): Date and time of the last device restart (ISO 8601 format)

New fields in encryptedDrives items

Each entry in the encryptedDrives array includes:

• drive (string): Drive letter designation (for example c:)
• driveType (string): Drive type (system, fixed, or removable)
• systemDrive (boolean): Whether this is the system drive
• encryptionStatus (string): Current status (fully_decrypted, fully_encrypted, encryption_in_progress, decryption_in_progress, encryption_paused, or decryption_paused)
• encryptionPercentage (integer): Percentage of the drive that is encrypted (0–100)
• encryptionMethod (string): Encryption algorithm and key size (for example xts_aes_256, aes_128, hardware_encryption)
• protectionStatus (boolean): Whether BitLocker protection is active on the drive
• protectors (array of strings): Key protector types configured (for example tpm, numeric_password, tpm_and_pin)
• bitlockerRecoveryKeyId (string): BitLocker recovery key identifier in Windows GUID format
• autounlock (boolean): Whether auto-unlock is enabled for this drive
• autounlockStored (boolean): Whether an auto-unlock key for another drive is stored on this drive
• pinRequested (boolean): Whether a BitLocker PIN has been requested
• pinPostponed (boolean): Whether the user has postponed setting a BitLocker PIN

See the full Elements API specification for details: Query devices

The latest Elements API release brings new device operations for helping in categorization of devices.

The following new device operations are now supported:

• Set a custom alias name for a device. This allows you to assign a human-readable name to a device for easier identification
• Set the importance level of devices. This helps prioritize devices based on their criticality to your organization
• Set business context information for a device. This allows you to associate devices with specific business units, departments, or purposes to help with organization and reporting
• Set device labels. This allows to you to caregorize devices with custom labels

See the full Element API specification from here.

The latest Elements API release brings new (WithSecure) Product Security Events.

The following new events are now supported:

• Product has been uninstalled successfully
• Product uninstallation has been canceled
• Product uninstallation has failed due to incorrect uninstallation password
• Product uninstallation has failed due to unknown reason
• Product uninstallation is not allowed

More information with examples is available in the Security Events reference page.

Release Update: New API Endpoints for Managing Elements API Credentials

We’ve introduced new endpoints to automate the management of API keys for the Elements API:

1. Create API Key
POST /api-keys/v1/create

• Generate a new API key for accessing the Elements API.
• Keys can be created at the organisation or Service Organisation Partner (SOP) level.
• By default, keys are read-only for security. Optionally, set readOnly to false for write access.
• Important: clientSecret is returned only once during creation—store it securely.

2. Delete API Key
DELETE /api-keys/v1/api-keys/{clientId}

• Permanently remove an API key by its ID.
• Deleted keys cannot be recovered or used for authentication.

3. List API Keys
GET /api-keys/v1/api-keys

• Retrieve all API keys for the current organisation or specify an organizationId when querying from SOP level.

For full details, including request/response formats and examples, refer to the API documentation.

New response actions to enable new workflows

We’ve added new response action endpoints under POST /response-actions/v1/execute/<name> to expand remote execution capabilities for both device and identity management.

This allows you to automate new workflows that involve acting on the target devices and identities.

This release increases the number of API supported response actions from 8 to 32.

Device response actions

The following device response actions are available:

• Create full memory dump – Uploads a full memory dump from the device
• Delete registry key or value – Deletes a specified Windows registry key or value
• Delete scheduled task – Deletes a specified Windows scheduled task
• Delete Windows service – Deletes a specified Windows service
• Delete WMI persistence objects – Deletes Windows Management Instrumentation (WMI) persistence objects
• Enumerate running processes – Enumerates running processes on the device
• Enumerate WMI persistence mechanisms – Enumerates WMI persistence mechanisms, including event consumers, filters, and bindings
• List file system structure – Lists the file system structure based on path matching patterns
• List registry keys and values – Lists Windows registry keys and values based on path matching patterns
• List scheduled tasks – Lists all Windows scheduled tasks on the device
• Retrieve amcache files – Retrieves the application compatibility cache file from the device
• Retrieve antivirus logs – Retrieves antivirus software log files for security analysis
• Retrieve browser artifacts – Retrieves the browser history from the device
• Retrieve event log tracing files – Retrieves .etl event log tracing files with records of system activities
• Retrieve files from device – Retrieves files from the device based on path matching patterns
• Retrieve jump list files – Retrieves jump lists stored in the AutomaticDestinations and CustomDestinations subfolders
• Retrieve master boot record – Retrieves the master boot record (MBR) from a specified drive
• Retrieve master file table – Retrieves the master file table (MFT) from a specified drive
• Retrieve network connections – Retrieves network connections, routing tables, interface statistics, and related process information
• Retrieve prefetch files – Retrieves Windows prefetch files with evidence of program execution
• Retrieve process memory dump – Retrieves a memory dump of a specific process
• Retrieve RDP cache files – Retrieves remote desktop protocol (RDP) bitmap cache files
• Retrieve recently accessed files – Retrieves information about recently accessed files and folders from user activity artefacts
• Retrieve registry hive files – Retrieves Windows registry hive files
• Retrieve SRUM database – Retrieves the system resource usage monitor (SRUM) database
• Retrieve Windows event log entries – Retrieves Windows event log entries based on specified filters
• Retrieve Windows event log files – Retrieves Windows event log files
• Terminate process – Terminates processes matching the specified patterns
• Terminate thread – Terminates a thread

Identity response actions

The following identity response actions are available for Microsoft Entra:

• Block user access in Microsoft Entra – Blocks access for a user to all resources inside the Microsoft Entra ecosystem
• End Microsoft Entra session – Ends the Microsoft Entra session of a user
• Reset Microsoft Entra password – Resets the Microsoft Entra password of a user

Response action results and attachments

Response actions are processed asynchronously: once triggered, you can monitor their progress.A new endpoint is available for retrieving the actual results of response actions that return data (for example, memory dumps or other files):

GET /response-actions/v1/responses/tasks

By using this endpoint, you can download any files or attachments produced by completed response actions. To determine when your action has finished, first poll the state via GET /response-actions/v1/responses. When the action is marked as finished, your attachments are ready for download from the tasks endpoint.

Start building

Full API documentation is available at

https://connect.withsecure.com/api-reference/elements/

New API Endpoint: Get Incident Updates

We have added a new endpoint to the Elements API that provides programmatic access to incident update history.

Endpoint Details

GET /incidents/v1/updates

Description

This endpoint retrieves the complete history of changes made to a specific incident (Broad Context Detection). Each update represents a modification to the incident over its lifecycle, including status changes, detection additions, comments, and other modifications.

Key Capabilities

Update Types Tracked

• Status changes (patch)
• Detection additions, removals, and modifications
• User comments
• Response actions
• Incident merges
• Risk level adjustments
• Category changes
• Threat investigation and validation results

State Tracking

Each update includes stateBefore and stateAfter objects, allowing you to see exactly what changed. This includes status, resolution, risk level, and categories.

Origin Information

Updates include source information indicating whether the change was made by:

• A user (with display name)
• An automated engine
• A response action

Pagination Support

Results can be paginated using anchor-based navigation, with a configurable limit of 1-100 updates per request (default 50).

Filtering

Filter updates by type to retrieve only relevant changes (e.g., only comments or only status changes).

Customer Benefits

1. Complete Audit Trail: Access the full history of incident modifications for compliance and reporting purposes.
2. Accountability: Identify who made specific changes to incidents through origin tracking.
3. Integration Support: Build automated workflows that respond to specific types of incident updates.
4. Change Analysis: Compare before and after states to understand the evolution of an incident.
5. Efficient Data Retrieval: Use type filtering to retrieve only relevant updates, reducing unnecessary data transfer.
6. Scalability: Pagination support allows handling incidents with extensive update histories.

Read more from the Elements API specification page under “Get Incident Updates”.

Elements API: new “restart” remote operations

We have added two new remote operations to the Elements API device operations endpoint that enable programmatic system and agent restarts.

Operations Overview

The new operations “restartSystem” and “restartProduct” are available via the POST /devices/v1/operations endpoint.

New Operations

restartProduct

Restarts the WithSecure agent software on a device without restarting the entire system.

restartSystem

Restarts the entire device (full system reboot).

Batch Capability

Both operations support batch execution on up to 5 devices per request.

Benefits

1. Agent Troubleshooting: Restart the WithSecure agent without disrupting the user’s work by avoiding a full system reboot.
2. Maintenance Automation: Integrate system restarts into automated maintenance workflows following software updates or configuration changes.
3. User Communication: Provide advance notice to users with custom messages before system restarts, improving user experience.
4. Efficient Remediation: Quickly restart multiple devices as part of incident response or troubleshooting procedures.
5. Granular Control: Choose between agent-only or full system restarts based on the specific troubleshooting or maintenance requirement.
6. Operation Tracking: Track restart operations using returned operation IDs to verify execution on remote hosts.

Read more from the Elements API specification under “Trigger remote operations on devices”.

New remote operation (Send Full Status)

We have added API support for the sendFullStatus remote operation, allowing administrators to request a full status report from devices. This operation is available for both computer and mobile devices and requires no additional parameters. After the operation is sent, the target device(s) will asynchronously send their status to the Elements Cloud.

Read more from the api specification page under POST /devices/v1/operations endpoint.