CIPP icon

CIPP

Interact with CIPP API

Actions129

Overview

This node operation allows users to add a scheduled item to the CIPP system. It is useful for automating tasks by scheduling commands to be executed at specific times, optionally with recurrence patterns. For example, a user can schedule a maintenance script to run nightly or a report generation command to execute weekly.

Use Case Examples

  1. Schedule a command to run a data backup every day at midnight.
  2. Add a scheduled task to execute a security scan weekly with specific parameters.

Properties

Name Meaning
Tenant Filter The tenant ID or domain name to filter the scheduled item for.
Name The name of the scheduled item to be added.
Command The command that will be executed when the scheduled item runs.
Parameters JSON object containing parameters for the command.
Scheduled Time The date and time when the scheduled item should be executed.
Recurrence Optional recurrence pattern for the scheduled item.
Disallow Duplicate Name Boolean flag to prevent adding scheduled items with duplicate names.
Request Options Settings for request behavior such as batching, SSL certificate validation, proxy, and timeout.

Output

JSON

  • id - The unique identifier of the newly created scheduled item.
  • name - The name of the scheduled item.
  • command - The command that will be executed.
  • parameters - Parameters passed to the command.
  • scheduledTime - The scheduled execution time of the item.
  • recurrence - The recurrence pattern if specified.
  • status - The status of the scheduled item after creation.

Dependencies

  • An API key credential for authenticating with the CIPP API

Troubleshooting

  • Ensure the tenantFilter is correctly specified as tenant ID or domain name; incorrect values may cause failures.
  • If disallowDuplicateName is true, attempts to add a scheduled item with an existing name will fail; choose unique names or disable this option.
  • Timeout errors may occur if the server is slow or unreachable; increase the timeout setting if needed.
  • SSL certificate validation errors can be bypassed by enabling 'Ignore SSL Issues' but this reduces security.

Discussion