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

Management → Device link

AI-generated

Summary

Retrieve the dashboard URL for a specific device by its identifier from the NinjaOne Management API, optionally following redirects.

Inputs

  • id (required) — The numeric identifier of the target device whose dashboard URL you want to retrieve.
  • returnAll — Boolean flag to indicate if all paginated results should be returned, or only a single page.
  • redirect — Boolean flag to specify whether to return the redirect response instead of the URL directly.
  • customBody — Optional JSON object to send arbitrary data in the request body, which will override other fields if conflicts arise.
  • headerFilters — Optional HTTP headers to include in the API request as key-value pairs.
  • queryFilters — Optional query-string parameters to filter or modify the API request.
  • batching — Settings to batch multiple input items for sequential requests, with controls for batch size and delay.
  • debug — Boolean flag to include debug information about the HTTP request (URL, headers, body) in the output.
  • pagination — Settings to control pagination behavior including mode, parameter names, limits, and intervals.
  • timeout — Milliseconds to wait before timing out the server response, defaulting to 300000 (5 minutes).

Output shape

a single object containing the dashboard URL or redirect response data for the specified device

By default, returns data for only one page unless 'returnAll' is true. Debug info is included only if enabled. Pagination settings affect list operations but here usually only one device ID is processed per call.

Examples

Example 1: Retrieve dashboard URL for device ID 123

Set id=123, leave other options default (no redirect, no pagination).

Links

Discussion