plannedChangeInstances
Get planned change instance members
Returns the group and device members of the specified planned change instance, identified by InstanceId. Use this endpoint to inspect which devices and groups are in scope for a given planned change.
Get planned change instance members
Submits a request to retrieve the group and device members of the specified planned change instance. Provide the InstanceId in the request body.
Delete a planned change instance
Deletes the specified planned change instance, identified by InstanceId. Optionally pass DeletePlannedChange as true to also remove the parent planned change definition from the system.
Delete a planned change instance
Submits a request to delete a planned change instance. Supply the InstanceId and optionally set DeletePlannedChange to true in the request body to also remove the parent planned change definition.
Remove member from planned change
Removes a specific group or device member from the specified planned change instance, identified by InstanceId. Provide either a GroupName or an AgentDeviceId to identify the member to remove.
Remove member from planned change
Submits a request to remove a group or device member from a planned change instance. Provide the InstanceId and either a GroupName or AgentDeviceId in the request body.
Add a planned change instance
Creates a new planned change instance, optionally associating it with an existing planned change definition by name. Specify member groups or individual devices, set start and end times, and configure periodicity for recurring windows. Returns the created instance details.
Add a planned change instance
Submits a request to create a new planned change instance. Provide the display name, description, member groups, device IDs, and scheduling options in the request body.
Update a planned change instance
Updates properties of an existing planned change instance, identified by InstanceId. You can modify the description, assigned ruleset, member groups, devices, scheduling, and enabled state. Returns the updated instance details.
Update a planned change instance
Submits a request to update an existing planned change instance. Provide the InstanceId and any fields to change in the request body. Returns the updated instance details.
Clone a planned change instance
Creates a copy of an existing planned change instance, identified by InstanceId. Set CloneDefinition to true to also duplicate the associated planned change ruleset definition. Returns the new cloned instance.
Clone a planned change instance
Submits a request to clone an existing planned change instance. Provide the InstanceId and CloneDefinition flag in the request body. Returns the new cloned instance.
Get planned change instance names
Returns a lightweight list of planned change instance names and IDs, filtered by name, ID, member groups, or schedule status. Use this endpoint to populate selection lists without fetching full instance details.
Get planned change instance names
Submits a request to retrieve planned change instance names and IDs. Provide filter criteria such as member groups, display name, and schedule status in the request body.
Add groups to a planned change
Adds one or more groups or individual devices as members to the specified planned change instance, identified by InstanceId. Supply MemberGroups names and/or MemberAgentDeviceIds to assign scope.
Add groups to a planned change
Submits a request to add groups or devices as members to a planned change instance. Provide the InstanceId, MemberGroups, and MemberAgentDeviceIds in the request body.
Add planned change from events
Creates or updates a planned change and its associated instance using the specified events as the basis for generating filter rules. Set PreviewOnly to true to inspect the resulting configuration without persisting it. Returns the planned change instance details, including any inferred rules.
Add planned change from events
Submits a request to create or update a planned change instance derived from the specified events. Provide event selection criteria, rule builder options, and instance configuration in the request body.
Re-evaluate planned change instance events
Triggers re-evaluation of events associated with the specified planned change instance, retrospectively applying the instance's rules to events within the specified UTC time range. Use this endpoint after modifying rules to reclassify historical events.
Re-evaluate planned change instance events
Submits a request to re-evaluate planned change events within a specified time range. Provide the InstanceId and the earliest and latest event timestamps in the request body.
Get planned change instances
Returns a list of planned change instances, optionally filtered by name, ID, member groups, schedule status, and date range. Use OmitPlannedChangeDefinitions to return a lighter payload when full ruleset details are not needed.
Get planned change instances
Submits a request to retrieve planned change instances. Provide filter criteria such as member groups, display name, and date range in the request body.