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

 Lists all RemoteAgents that are valid and compatible with a specific connector.

create

 Creates a new RemoteAgent.

delete

 Deletes a RemoteAgent.

fetchEditableRemoteAgents

 Lists all RemoteAgents that the requesting user has permissions to edit.

fetchInstallationCommand

 Retrieves the specific command string required to install a RemoteAgent.

fetchInstallerFile

 Retrieves a download link for the RemoteAgent's installer file.

fetchRedeployStatus

 Returns the redeployment status for integrations on a RemoteAgent.

fetchRemoteAgentsCompatibleWithJobs

 Lists all RemoteAgents compatible with executing jobs for a specific integration.

fetchRemoteAgentsInformation

 Retrieves detailed information for a list of RemoteAgents.

get

 Gets a single RemoteAgent.

list

 Lists RemoteAgents.

migrateConnectors

 Migrates legacy connectors on a RemoteAgent from remote to local scheduling.

patch

 Updates an existing RemoteAgent.

redeployRemoteAgent

 Redeploys configuration from one RemoteAgent to another.

sendRemoteAgentInstaller

 Sends the RemoteAgent installer via email.

upgradeRemoteAgent

 Upgrades a RemoteAgent to the latest available version.