Method: soarNetworks.list

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

Lists SOAR SoarNetworks.

HTTP request


Path parameters

Parameters
parent

string

Required. The instance to list SoarNetworks for. Format: projects/{project}/locations/{location}/instances/{instance}

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of SoarNetworks to return. The service may return fewer than this value. If unspecified, at most 50 SoarNetworks 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 soarNetworks.list call. Provide this to retrieve the subsequent page.

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

string

Optional. A filter to apply to the list of SoarNetworks. Supported filter fields: * displayName: Filter by the user-facing name. Example: filter="displayName eq 'SoarNetwork 1'" * address: Filter by the address. Example: filter="address eq '10.0.0.0/1'" * priority: Filter by the priority. Example: filter="priority eq 2"
orderBy

string

Optional. Configures ordering of SoarNetworks in the response. If not specified, SoarNetworks 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: * address * priority * displayName

Request body

The request body must be empty.

Response body

Response message for soarNetworks.list.

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

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

object (SoarNetwork)

The list of SoarNetworks. Ordered by Id by default.
nextPageToken

string

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

integer

The total number of SoarNetworks matching the request.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.