Execute Fleet Action

post

https://api.edgeiq.io/api/v1/platform/fleets/{id}/actions

Execute a bulk action on all devices in the fleet. The action is processed asynchronously and a bulk_response_id is returned to track progress. For 'issue_command' and 'send_configuration' actions, only eligible devices will receive the command/setting.

Path Params

string

required

The ID that specifies a Fleet

Body Params

action_type

string

enum

required

The type of action to execute on fleet devices.

Allowed:

command_id

string

The ID of a user-defined command to execute. Required for 'issue_command' action when using a user-defined command. Mutually exclusive with 'gateway_command'.

gateway_command

string

The name of a gateway command to execute (e.g., 'reboot', 'update'). Required for 'issue_command' action when using a gateway command. Mutually exclusive with 'command_id'.

tags

metadata

object

Key/value pairs to add to all devices in the fleet. Required for 'add_metadata' action.

heartbeat_period

integer

≥ 1

The heartbeat period in seconds to set on devices. Used for 'update_heartbeat' action.

heartbeat_values

array of strings

An array of heartbeat values to set on devices. Used for 'update_heartbeat' action.

heartbeat_values

configuration_id

string

The configuration ID for validation. Required for 'send_configuration' action.

setting_id

string

The setting ID to send to devices. Required for 'send_configuration' action.

setting_version

integer

Defaults to 0

The setting version to send. Use 0 for the latest version. Used for 'send_configuration' action.

send_command_id

string

The command ID used to send the setting to devices. Required for 'send_configuration' action.

Responses

400

The request was malformed or contained invalid parameters.

401

You are not authorized

403

You are forbidden from accessing this resource

404

The item you were looking for does not exist

500

An unexpected error was encountered.

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

202Action accepted for processing