Method: remoteAgents.list

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

Lists SOAR remote agents.

HTTP request


Path parameters

Parameters
parent

string

Required. The parent, which owns this collection of remote agents. Format: projects/{project}/locations/{location}/instances/{instance}

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of remote agents to return. The service may return fewer than this value. If unspecified, at most 100 remote agents will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken

string

Optional. A page token, received from a previous remoteAgents.list call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to remoteAgents.list must match the call that provided the page token.
filter

string

Optional. Filter to be applied over multiple remote Agent fields. Only the following filters are allowed: name, identifier, state, environments, logging level, primary remote agent identifier, display name.
orderBy

string

Optional. Configures ordering of remote agents in the response. If not specified, remote agents are returned in descending order of their create time. The default ordering is by create time in descending order. The orderBy string is a comma separated list of fields. For example: "createTime desc, updateTime" Supported fields: * order * displayName

Request body

The request body must be empty.

Response body

ListRemoteAgentsResponse contains the list of remote agents.

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

JSON representation 
{
  "remoteAgents": [
    {
      object (RemoteAgent)
    }
  ],
  "totalSize": integer,
  "nextPageToken": string
}
Fields
remoteAgents[]

object (RemoteAgent)

Output only. The list of remote agents, ordered by displayName.
totalSize

integer

Output only. The total number of remote agents.
nextPageToken

string

Output only. A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.