REST Resource: projects.locations.instances.remoteAgents

Resource: RemoteAgent

This service is available for customers who migrated SOAR to a customer managed project and have the Chronicle API enabled. Remote agent - Chronicle SOAR remote agent.

JSON representation 
{
  "name": string,
  "displayName": string,
  "identifier": string,
  "environments": string,
  "agentState": enum (AgentState),
  "loggingLevel": enum (RemoteAgentLogLevel),
  "installerLink": string,
  "primaryRemoteAgentId": string,
  "certificate": string
}
Fields
name

string

Identifier. The unique name of the remote agent. Format: projects/{project}/locations/{location}/instances/{instance}/agents/{agent}
displayName

string

Required. The display name of the remote agent.
identifier

string

Output only. Unique GUID Identifier of the remote agent.
environments

string

Required. A list of remote agent logical environments in the platform.
agentState

enum (AgentState)

Optional. Remote agent current state - this refers to the general state of the remote agent.
loggingLevel

enum (RemoteAgentLogLevel)

Required. Current logging level in the remote agent.
primaryRemoteAgentId

string

Optional. If a remote agent has a primary remote agent identifier different from null, it means that it acts as a backup remote agent in case something happens to the primary remote agent.
certificate

string

Output only. The public certificate of the remote agent.

AgentState

Remote agent state - this refers to the general state of the remote agent.

Enums
AGENT_STATE_UNSPECIFIED Remote agent state is unspecified.
ACTIVE If the remote agent's current state is active, it means it can communicate with the system.
SUSPENDED If the remote agent's current state is 'suspended', it means the user can re-enable it in the future.

RemoteAgentLogLevel

Remote agent logging level.

Enums
REMOTE_AGENT_LOG_LEVEL_UNSPECIFIED Remote agent logging level is unspecified.
ERROR Remote agent logging level is error.
WARNING Remote agent logging level is warning.
INFO Remote agent logging level is information.
DEBUG Remote agent logging level is debug.

Methods

connectorValidRemoteAgents

 Returns a list of all remote agents, including their availability state with respect to this specific connector.

create

 Creates a SOAR remote agent.

delete

 Deletes a SOAR remote agent.

fetchEditableRemoteAgents

 Returns a list of all the remote agents that the user can edit.

fetchInstallationCommand

 Fetches the installation command of the remote agent.

fetchInstallerFile

 Returns the installer file of the remote agent.

fetchRedeployStatus

 Returns the redeploy status of the integrations in the remote agent.

fetchRemoteAgentsCompatibleWithJobs

 Return a list of all the remote agents with availability status for jobs on specific integration.

fetchRemoteAgentsInformation

 Returns a list of all remote agents, including their advanced information.

get

 Gets a SOAR remote agent.

list

 Lists SOAR remote agents.

migrateConnectors

 Migrates legacy connector from remote to local scheduling.

patch

 Updates an existing remote agent.

redeployRemoteAgent

 Redeploys remote agent from an already existing remote agent.

sendRemoteAgentInstaller

 Sends the remote agent installer to the recipients.

upgradeRemoteAgent

 Upgrades remote agent to the latest version.