Discover available commands through URLs

Newly installed ePolicy Orchestrator extensions provide more web API commands. Learn which commands are available to you.

Use the core.help command to learn which commands you can access and the details of specific commands. When used without any arguments, core.help provides a list of available commands.

> curl -k -u ga:ga https://localhost:8443/remote/core.help
Note: The exact list of commands displayed depends on your permissions and the extensions installed.
This command returns a list that looks similar to this example.
OK:
ComputerMgmt.createCustomInstallPackageCmd windowsPackage deployPath [ahId] [fallBackAhId] [useCred] [domain] [username] [password] [rememberDomainCredentials] -
ComputerMgmt.create.Custom.Install.Package.Cmd.short-desc
agentmgmt.listAgentHandlers - List all Agent Handlers
clienttask.export [productId] [fileName] - Exports client tasks
clienttask.find [searchText] - Finds client tasks
clienttask.importClientTask importFileName - Imports client tasks from an XML file.
clienttask.run names productId taskId [retryAttempts] [retryIntervalInSeconds] [abortAfterMinutes] [useAllAgentHandlers] [stopAfterMinutes] [randomizationInterval] - Runs the client task on a supplied list of systems
clienttask.syncShared - Shares client tasks with participating registered servers
commonevent.purgeEvents queryId [unit] [purgeType] - Deletes threat events based on age or a queryId. The query must be table based.
commonevent.purgeProductEvents queryId [unit] [purgeType] - Purge Client Events by Query ID or age.
console.cert.updatecrl console.updateCRL crlFile - cert.update.crl.help.oneline
core.addPermSetsForUser userName permSetName - Adds permission set(s) to specified user
core.addUser userName password [fullName=<>] [email=<>] [phoneNumber=<>] [notes=<>] [disabled=<>] [admin=<>] - Adds a user to the system
core.executeQuery queryId [database=<>] - Executes a SQUID query and returns the results
.
[information deleted]
.
system.report names - Reports the systems in the System Tree
system.runTagCriteria tagID [resetTaggedSystems] - The Run Tag Criteria action evaluates every managed system against the tag's criteria. system.setUserProperties names [description] [customField1] [customField2] [customField3] [customField4] - Sets user properties on the given system
system.transfer names epoServer - Transfers systems to a different ePO server
system.wakeupAgent names [fullProps] [superAgent] [randomMinutes] [forceFullPolicyUpdate] [useAllHandlers] [retryIntervalSeconds] [attempts] [abortAfterMinutes] [includeSubgroups] - Wakes up the agent on a supplied list of systems
tasklog.listMessages taskLogId - Lists the messages for the specified task log entry
tasklog.listSubtasks taskLogId - Lists subtasks of a specified task log entry
tasklog.listTaskHistory [taskName] [taskSource] [maxRows] [age] [unit] - Lists
task log entries, optionally filtered by task name, task ID or task source
tasklog.listTaskSources - Lists the task sources
tasklog.purge [age] [unit] - Purges the Server Task Log beyond a given age and time unit
The Help output displays the:
  • Prefix, for example "core".
  • Command name, for example "help".
  • Required arguments and optional arguments. Optional arguments are enclosed in square brackets ("[" and "]").
    Note: Arguments followed by =<> require the specific argument name and a value. For example, if the command help shows [email=<>] you must provide the argument name and the value, as in email=joe_test@mcafee.com.
  • Brief description of the command.

This extended command example is used to request more detailed information about a specific command.
> curl -k -u ga:ga  https://localhost:8443/remote/core.help?command=core.listQueries
This command displays:
OK:
core.listQueries
Displays all queries that the user is permitted to see. Returns the list of
queries or throws on error.
Requires permission to use queries.