NinjaOne icon

NinjaOne

Ninja One Public API documentation. <br><br>See also: <br> <a href="https://resources.ninjarmm.com/API/Ninja+RMM+Public+API+v2.0.5+Device+Filter+Syntax.pdf">Device Filter syntax</a><br><a href="https://app.ninjarmm.com/apidocs-beta/core-resources/articles/webhooks/overview">Webhooks</a>

Actions309

ChecklistTemplates → Archive a checklist template

AI-generated

Summary

Archive one or more checklist templates in NinjaOne by providing their IDs.

Inputs

  • checklistTemplateIds (required) — An array of checklist template IDs to be archived. This is specified in JSON format within the 'Additional Fields' parameter collection.
  • customBody — Optionally provide arbitrary JSON to include in the request body, which will override other body fields if there are conflicts.
  • headerFilters — Add custom HTTP headers for the archive request, specified as key-value pairs.
  • queryFilters — Add custom query parameters to filter or modify the request.
  • batching — Configure batching to control how many checklist templates are archived per request and the interval between batches.
  • debug — Enable to include detailed information about the HTTP request sent, useful for troubleshooting.
  • timeout — Set the timeout in milliseconds to wait for the server response before aborting the request.

Output shape

a single JSON object representing the archive operation response from the NinjaOne API, typically including status and any relevant metadata about the archived checklist templates.

The operation accepts multiple checklist template IDs as a JSON array to archive multiple templates at once. Custom body and headers are deeply merged into the request if provided. If batching is enabled, multiple requests may be made sequentially according to the batch settings. Debug information includes the fully composed URL, headers, query parameters, and request body sent.

Examples

Example 1: Archive checklist templates with specific IDs.

Pass a JSON array of checklistTemplateIds like ["id1", "id2"] to archive those templates.

Links

Discussion