Method: remoteAgents.connectorValidRemoteAgents

Full name: projects.locations.instances.remoteAgents.connectorValidRemoteAgents

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

HTTP request


Path parameters

Parameters
parent

string

Required. Format: projects/{project}/locations/{location}/instances/{instance}

Query parameters

Parameters
environment

string

Required. The environment of the connector.
integration

string

Required. The integration of the connector.
type

enum (ConnectorType)

Required. The connector type of the connector.

Request body

The request body must be empty.

Response body

Response message for the remoteAgents.connectorValidRemoteAgents method.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "remoteAgentConnectorAvailabilities": [
    {
      object (RemoteAgentConnectorAvailability)
    }
  ]
}
Fields
remoteAgentConnectorAvailabilities[]

object (RemoteAgentConnectorAvailability)

Output only. List of RemoteAgentConnectorAvailability

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

ConnectorType

This indicates whether the user requests the available remote agents for a connector of type Template (IDE page) or Instance (Ingestion page).

Enums
CONNECTOR_TYPE_UNSPECIFIED Connector type is unspecified.
TEMPLATE This type of connector refers to the IDE page on which a new connector template item is configured.
INSTANCE This type of connector refers to the ingestion page on which a new connector instance is configured.

RemoteAgentConnectorAvailability

Information about remote agent - Chronicle SOAR remote agent with connector availability state.

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

string

Output only. The name of the remote agent to delete. Format: projects/{project}/locations/{location}/instances/{instance}/remoteAgents/{remoteAgent}
displayName

string

Output only. The display name of the remote agent.
identifier

string

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

string

Output only. List of remote agent logical environments in the platform.
agentState

enum (AgentState)

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

enum (RemoteAgentLogLevel)

Output only. Current logging level in the remote agent.
primaryRemoteAgentIdentifier

string

Output only. 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. Unique GUID identifier of the remote agent
certificate

string

Output only. The certificate of the remote agent.
remoteAgentAvailabilityConnectorState

enum (AgentAvailabilityConnectorState)

Output only. Indicates if a remote agent is available for use with the connector.

AgentAvailabilityConnectorState

Remote agent connector availability state.

Enums
AGENT_AVAILABILITY_CONNECTOR_STATE_UNSPECIFIED Remote agent connector availability state is unspecified.
AVAILABLE Remote agent connector availability state is available for the connector.
MISCONFIGURATION_ERROR Remote agent connector availability state is misconfigured - integration is not installed on the remote agent .
CONNECTION_ERROR Remote agent connector availability state is connection error.
NON_AVAILABLE_FOR_IDE Integration version is not supported for this remote agent.