Skip to main content

Create operations

POST 
/v2/organizations/:organization_id/operations

Create one or more operations based on the provided scope and goals.

Currently available operation types: execute_microservice, delete_workspaces, force_update_custom_fields, shutdown_workspaces, restart_workspaces, suspend_workspaces, power_off_workspaces, force_restart_workspaces, wake_on_lan_workspaces, send_popup, send_flexxible_notification, disconnect_sessions, logoff_sessions, force_logoff_sessions, collect_agent_logs, change_reporting_group, windows_service_action and close_notification, get_installed_patches, get_pending_patches and get_plug_and_play_devices.

Returns the operation resources created using the same canonical contract for querying by id.

Partial Execution

Operations are only created for eligible targets. Ineligible targets don't block the request: they are returned in not_supported_devices, grouped by reason. If all targets are omitted, the response is still 201 with data empty. Organization authorization failures and global request validations return 4xx and don't create any operation.

Supported Targets by Type

  • Only sessions: disconnect_sessions, logoff_sessions and force_logoff_sessions.
  • workspaces or sessions: execute_microservice, send_popup and send_flexxible_notification.
  • Only workspaces: all other types.
  • windows_service_action supports exactly one target per request.

payload Content by Type

payload is an object whose content depends on type. Unsu... fields for the sent type are rejected with 400. See request examples for each form.

  • execute_microservice: microservice_id (required) and parameters (optional).
  • shutdown_workspaces and restart_workspaces: scheduled_at (optional).
  • wake_on_lan_workspaces: intermediate_workspace_id (required). Must be a connected Workspace acting as intermediary.
  • send_popup: message (required).
  • send_flexxible_notification: message, start_date, end_date, level_type (informative, maintenance or issue), blink, ask_for_acknowledgement, disable_minimize and timezone (required); tooltip and link (optional).
  • collect_agent_logs: start_time (required); end_time and filter_files (optional).
  • change_reporting_group: reporting_group_id (required). The request is rejected when exceeding 100 non-eligible Workspaces.
  • windows_service_action: action (start, stop or restart) and services_name (required). The FlexxAgent service can't be stopped or restarted.
  • delete_workspaces, force_update_custom_fields, suspend_workspaces, power_off_workspaces, force_restart_workspaces, disconnect_sessions, logoff_sessions and force_logoff_sessions: don't support payload.

Parameter Compatibility for execute_microservice

payload.parameters is only applicable to PowerShell microservice executions on Windows and is only supported on devices with the new agent installed.

Values in payload.parameters are sent as text (string). Type interpretation depends on parameter definitions and parsing implemented in the microservice script.

For that context, recommended parameter data types:

  • string, integer, double, decimal and datetime.
  • For double and decimal, use decimal point notation (.).
  • For datetime, use ISO 8601 format (e.g., 2026-07-09T10:30:00Z).
  • When executing at the target, datetime values may be represented in local time.
  • Successful execution also depends on the quality and validations of the script.

Request​

Responses​

Operations created successfully.