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

KnowledgeBaseArticles → Download knowledge base article

AI-generated

Summary

Download a knowledge base article by its article ID from the NinjaOne API, optionally handling pagination and customizing request parameters.

Inputs

  • articleId (required) — The numeric ID of the article to download.
  • returnAll — Boolean flag to determine whether to return all paginated results or only the first page.
  • options — Additional optional settings including custom JSON body, HTTP headers, query-string filters, batching options, debug flag for request details, pagination configuration, and request timeout in milliseconds.

Output shape

A single API response representing the downloaded knowledge base article, which may be paginated depending on the returnAll and pagination settings.

Supports pagination with configurable modes and parameters; when debug is enabled, includes request details in the output under a debug entry; batching applied if specified in options to manage request rate limiting.

Examples

Example 1: Downloading a single knowledge base article by ID without pagination or extra options.

Set 'articleId' to the desired number and leave 'returnAll' and 'options' at their defaults.

Example 2: Downloading all pages of results with custom query filters and headers.

Set 'returnAll' to true, add filters in 'queryFilters', add headers in 'headerFilters', and configure pagination options as needed.

Links

Discussion