SentinelOne icon

SentinelOne

SentinelOne Management Console API specification.

Actions281

Agents → Get Passphrase

AI-generated

Overview

This node operation retrieves the passphrase for SentinelOne Agents that match specified filters. It is useful for obtaining the passphrase required for SentinelCtl commands and various API operations related to Agents. Users can filter Agents by numerous criteria such as K8S node name, CPU core count, Ranger status, Active Directory queries, and many more to narrow down the results. The node supports returning all matching results or a single page, with options for custom request bodies, headers, query filters, batching, debugging, and pagination.

Use Case Examples

  1. Retrieve the uninstall passphrase for all Agents in a specific account or group.
  2. Filter Agents by OS type and get their passphrases for use in automated scripts.
  3. Use additional filters like 'Core Count Gte' and 'Ranger Statuses' to get passphrases for a targeted set of Agents.

Properties

Name Meaning
Return All Whether to return all results or only a single page. When disabled, no pagination parameters are sent and only one page of results is returned.
Additional Fields Collection of optional filters to narrow down the Agents for which passphrases are retrieved. Includes filters like K8SNode Name Contains, Core Count Lt/Gte, Ranger Statuses, AD User Query Contains, and many others.
Options Additional request options including custom JSON body, custom HTTP headers, query-string filters, batching settings, debug mode, pagination settings, and request timeout.

Output

JSON

  • passphrases - Array of passphrase objects for the filtered Agents
  • debug - Debug information including actual URL, query parameters, headers, and body sent for each API request (if debug option is enabled)

Dependencies

  • An API key credential for SentinelOne Management Console API

Troubleshooting

  • Ensure the API credentials are valid and have the necessary permissions to access Agent passphrases.
  • If the node returns an empty array, verify that the filter criteria match existing Agents.
  • Use the debug option to inspect the actual API request and response for troubleshooting.
  • Check for rate limiting or timeout errors and adjust batching or timeout settings accordingly.

Links

Discussion