Methods

createFirewall

Parameter

Parameter

protocols

object

A map of protocol to port range. The keys
of the object refer to a protocol (e.g. tcp, udp) and the value for
the key are the ports/port-ranges that are allowed to make a connection.
If a true value, that means all ports on that protocol will be opened.
If false, all traffic on that protocol will be blocked.

ranges

Array of string

The IP address blocks that this rule
applies to, expressed in
CIDR
format.

createRule

Parameter

Parameter

ip

Optional

string

The single IP address this forwarding rule will
match against. All traffic that matches the IP address, protocol, and
ports of this forwarding rule will be handled by this rule. If specified,
the IP address must be a static external IP address. To create a new
ephemeral external IP address for the forwarding rule, leave this field
empty. (Alias for config.IPAddress)

A single port or single contiguous port
range, ranging from low to high for which this forwarding rule matches.
Packets of the specified protocol sent to these ports will be forwarded
on to the appropriate target pool or target instance. If this field is
left empty, then the forwarding matches traffic for all ports for the
specified protocol. (Alias for config.portRange)

Parameter

Example

getAddresses

Get a list of addresses. For a detailed description of method's options see
API reference.

Parameter

options

Optional

object

Address search options.

Values in options have the following properties:

Parameter

autoPaginate

boolean

Have pagination handled
automatically. Default: true.

filter

string

Search filter in the format of
{name} {comparison} {filterString}.

- **`name`**: the name of the field to compare
- **`comparison`**: the comparison operator, `eq` (equal) or `ne`
(not equal)
- **`filterString`**: the string to filter to. For string fields, this
can be a regular expression.

maxApiCalls

number

Maximum number of API calls to make.

maxResults

number

Maximum number of addresses to return.

pageToken

string

A previously-returned page token
representing part of the larger set of results to view.

getAutoscalers

Get a list of autoscalers. For a detailed description of this method's
options, see the API reference.

Parameter

options

Optional

object

Address search options.

Values in options have the following properties:

Parameter

autoPaginate

boolean

Have pagination handled
automatically. Default: true.

filter

string

Search filter in the format of
{name} {comparison} {filterString}.

- **`name`**: the name of the field to compare
- **`comparison`**: the comparison operator, `eq` (equal) or `ne`
(not equal)
- **`filterString`**: the string to filter to. For string fields, this
can be a regular expression.

maxApiCalls

number

Maximum number of API calls to make.

maxResults

number

Maximum number of addresses to return.

pageToken

string

A previously-returned page token
representing part of the larger set of results to view.

getDisks

Parameter

Parameter

autoPaginate

boolean

Have pagination handled
automatically. Default: true.

filter

string

Search filter in the format of
{name} {comparison} {filterString}.

- **`name`**: the name of the field to compare
- **`comparison`**: the comparison operator, `eq` (equal) or `ne`
(not equal)
- **`filterString`**: the string to filter to. For string fields, this
can be a regular expression.

maxApiCalls

number

Maximum number of API calls to make.

maxResults

number

Maximum number of disks to return.

pageToken

string

A previously-returned page token
representing part of the larger set of results to view.

getFirewalls

Parameter

Parameter

autoPaginate

boolean

Have pagination handled
automatically. Default: true.

filter

string

Search filter in the format of
{name} {comparison} {filterString}.

- **`name`**: the name of the field to compare
- **`comparison`**: the comparison operator, `eq` (equal) or `ne`
(not equal)
- **`filterString`**: the string to filter to. For string fields, this
can be a regular expression.

maxApiCalls

number

Maximum number of API calls to make.

maxResults

number

Maximum number of firewalls to return.

pageToken

string

A previously-returned page token
representing part of the larger set of results to view.

getHealthChecks

Parameter

Parameter

autoPaginate

boolean

Have pagination handled
automatically. Default: true.

filter

string

Search filter in the format of
{name} {comparison} {filterString}.

- **`name`**: the name of the field to compare
- **`comparison`**: the comparison operator, `eq` (equal) or `ne`
(not equal)
- **`filterString`**: the string to filter to. For string fields, this
can be a regular expression.

https

boolean

List only HTTPs health checks. Default:
false.

maxApiCalls

number

Maximum number of API calls to make.

maxResults

number

Maximum number of networks to return.

pageToken

string

A previously-returned page token
representing part of the larger set of results to view.

getImages

Parameter

Parameter

autoPaginate

boolean

Have pagination handled
automatically. Default: true.

filter

string

Search filter in the format of
{name} {comparison} {filterString}.

- **`name`**: the name of the field to compare
- **`comparison`**: the comparison operator, `eq` (equal) or `ne`
(not equal)
- **`filterString`**: the string to filter to. For string fields, this
can be a regular expression.

maxApiCalls

number

Maximum number of API calls to make.

maxResults

number

Maximum number of images to return.

pageToken

string

A previously-returned page token
representing part of the larger set of results to view.

getInstanceGroups

Parameter

Parameter

autoPaginate

boolean

Have pagination handled
automatically. Default: true.

filter

string

Search filter in the format of
{name} {comparison} {filterString}.

- **`name`**: the name of the field to compare
- **`comparison`**: the comparison operator, `eq` (equal) or `ne`
(not equal)
- **`filterString`**: the string to filter to. For string fields, this
can be a regular expression.

maxApiCalls

number

Maximum number of API calls to make.

maxResults

number

Maximum number of instance groups to
return.

pageToken

string

A previously-returned page token
representing part of the larger set of results to view.

getMachineTypes

Parameter

Parameter

autoPaginate

boolean

Have pagination handled
automatically. Default: true.

filter

string

Search filter in the format of
{name} {comparison} {filterString}.

- **`name`**: the name of the field to compare
- **`comparison`**: the comparison operator, `eq` (equal) or `ne`
(not equal)
- **`filterString`**: the string to filter to. For string fields, this
can be a regular expression.

maxApiCalls

number

Maximum number of API calls to make.

maxResults

number

Maximum number of machineTypes to
return.

pageToken

string

A previously-returned page token
representing part of the larger set of results to view.

getNetworks

Parameter

Parameter

autoPaginate

boolean

Have pagination handled
automatically. Default: true.

filter

string

Search filter in the format of
{name} {comparison} {filterString}.

- **`name`**: the name of the field to compare
- **`comparison`**: the comparison operator, `eq` (equal) or `ne`
(not equal)
- **`filterString`**: the string to filter to. For string fields, this
can be a regular expression.

maxApiCalls

number

Maximum number of API calls to make.

maxResults

number

Maximum number of networks to return.

pageToken

string

A previously-returned page token
representing part of the larger set of results to view.

getOperations

Parameter

Parameter

autoPaginate

boolean

Have pagination handled
automatically. Default: true.

filter

string

Search filter in the format of
{name} {comparison} {filterString}.

- **`name`**: the name of the field to compare
- **`comparison`**: the comparison operator, `eq` (equal) or `ne`
(not equal)
- **`filterString`**: the string to filter to. For string fields, this
can be a regular expression.

maxApiCalls

number

Maximum number of API calls to make.

maxResults

number

Maximum number of operations to return.

pageToken

string

A previously-returned page token
representing part of the larger set of results to view.

getRegions

Parameter

Parameter

autoPaginate

boolean

Have pagination handled
automatically. Default: true.

filter

string

Search filter in the format of
{name} {comparison} {filterString}.

- **`name`**: the name of the field to compare
- **`comparison`**: the comparison operator, `eq` (equal) or `ne`
(not equal)
- **`filterString`**: the string to filter to. For string fields, this
can be a regular expression.

maxApiCalls

number

Maximum number of API calls to make.

maxResults

number

Maximum number of instances to return.

pageToken

string

A previously-returned page token
representing part of the larger set of results to view.

getRules

Parameter

Parameter

autoPaginate

boolean

Have pagination handled
automatically. Default: true.

filter

string

Search filter in the format of
{name} {comparison} {filterString}.

- **`name`**: the name of the field to compare
- **`comparison`**: the comparison operator, `eq` (equal) or `ne`
(not equal)
- **`filterString`**: the string to filter to. For string fields, this
can be a regular expression.

maxApiCalls

number

Maximum number of API calls to make.

maxResults

number

Maximum number of rules to return.

pageToken

string

A previously-returned page token
representing part of the larger set of results to view.

getServices

Parameter

Parameter

autoPaginate

boolean

Have pagination handled
automatically. Default: true.

filter

string

Search filter in the format of
{name} {comparison} {filterString}.

- **`name`**: the name of the field to compare
- **`comparison`**: the comparison operator, `eq` (equal) or `ne`
(not equal)
- **`filterString`**: the string to filter to. For string fields, this
can be a regular expression.

maxApiCalls

number

Maximum number of API calls to make.

maxResults

number

Maximum number of snapshots to return.

pageToken

string

A previously-returned page token
representing part of the larger set of results to view.

getSnapshots

Parameter

Parameter

autoPaginate

boolean

Have pagination handled
automatically. Default: true.

filter

string

Search filter in the format of
{name} {comparison} {filterString}.

- **`name`**: the name of the field to compare
- **`comparison`**: the comparison operator, `eq` (equal) or `ne`
(not equal)
- **`filterString`**: the string to filter to. For string fields, this
can be a regular expression.

maxApiCalls

number

Maximum number of API calls to make.

maxResults

number

Maximum number of snapshots to return.

pageToken

string

A previously-returned page token
representing part of the larger set of results to view.

getSubnetworks

Parameter

Parameter

autoPaginate

boolean

Have pagination handled
automatically. Default: true.

filter

string

Search filter in the format of
{name} {comparison} {filterString}.

- **`name`**: the name of the field to compare
- **`comparison`**: the comparison operator, `eq` (equal) or `ne`
(not equal)
- **`filterString`**: the string to filter to. For string fields, this
can be a regular expression.

maxApiCalls

number

Maximum number of API calls to make.

maxResults

number

Maximum number of subnetworks to return.

pageToken

string

A previously-returned page token
representing part of the larger set of results to view.

getVMs

Parameter

Parameter

autoPaginate

boolean

Have pagination handled
automatically. Default: true.

filter

string

Search filter in the format of
{name} {comparison} {filterString}.

- **`name`**: the name of the field to compare
- **`comparison`**: the comparison operator, `eq` (equal) or `ne`
(not equal)
- **`filterString`**: the string to filter to. For string fields, this
can be a regular expression.

maxApiCalls

number

Maximum number of API calls to make.

maxResults

number

Maximum number of instances to return.

pageToken

string

A previously-returned page token
representing part of the larger set of results to view.

getZones

Parameter

Parameter

autoPaginate

boolean

Have pagination handled
automatically. Default: true.

filter

string

Search filter in the format of
{name} {comparison} {filterString}.

- **`name`**: the name of the field to compare
- **`comparison`**: the comparison operator, `eq` (equal) or `ne`
(not equal)
- **`filterString`**: the string to filter to. For string fields, this
can be a regular expression.

maxApiCalls

number

Maximum number of API calls to make.

maxResults

number

Maximum number of instances to return.

pageToken

string

A previously-returned page token
representing part of the larger set of results to view.