REST Resource: organizations.locations.firewallEndpoints

Resource: FirewallEndpoint

Message describing Endpoint object.

JSON representation 
{
  "name": string,
  "description": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "state": enum (State),
  "reconciling": boolean,
  "associatedNetworks": [
    string
  ],
  "associations": [
    {
      object (AssociationReference)
    }
  ],
  "wildfireSettings": {
    object (WildfireSettings)
  },
  "billingProjectId": string,
  "explicitPrivateServiceConnectAttachment": string,
  "endpointSettings": {
    object (EndpointSettings)
  },
  "kmsKey": string,
  "satisfiesPzs": boolean,
  "satisfiesPzi": boolean
}
Fields
name

string

Immutable. Identifier. Name of resource.
description

string

Optional. Description of the firewall endpoint. Max length 2048 characters.
createTime

string (Timestamp format)

Output only. Create time stamp.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Output only. Update time stamp

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
labels

map (key: string, value: string)

Optional. Labels as key value pairs

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
state

enum (State)

Output only. Current state of the endpoint.
reconciling

boolean

Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128.
associatedNetworks[]
(deprecated)

string

Output only. Deprecated: List of networks that are associated with this endpoint in the local zone. This is a projection of the FirewallEndpointAssociations pointing at this endpoint. A network will only appear in this list after traffic routing is fully configured. Format: projects/{project}/global/networks/{name}.
associations[]

object (AssociationReference)

Output only. List of FirewallEndpointAssociations that are associated to this endpoint. An association will only appear in this list after traffic routing is fully configured.
wildfireSettings

object (WildfireSettings)

Optional. Settings for WildFire analysis.
billingProjectId

string

Optional. Project to charge for the deployed firewall endpoint. This field must be specified when creating the endpoint in the organization scope, and should be omitted otherwise.
explicitPrivateServiceConnectAttachment

string

Output only. The resource name of the explicit PSC Attachment. Format: projects/{project}/regions/{region}/serviceAttachments/{id}
endpointSettings

object (EndpointSettings)

Optional. Settings for the endpoint.
kmsKey

string

Optional. Immutable. The resource name of the KMS key used for CMEK encryption. If no key is specified, Google-managed encryption keys are used. The key must be in the same region as the endpoint.

Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}
satisfiesPzs

boolean

Output only. [Output Only] Reserved for future use.
satisfiesPzi

boolean

Output only. [Output Only] Reserved for future use.

State

Endpoint state.

Enums
STATE_UNSPECIFIED Not set.
CREATING Being created.
ACTIVE Processing configuration updates.
DELETING Being deleted.
INACTIVE Down or in an error state.

AssociationReference

This is a subset of the FirewallEndpointAssociation message, containing fields to be used by the consumer.

JSON representation 
{
  "name": string,
  "network": string
}
Fields
name

string

Output only. The resource name of the FirewallEndpointAssociation. Format: projects/{project}/locations/{location}/firewallEndpointAssociations/{id}
network

string

Output only. The VPC network associated. Format: projects/{project}/global/networks/{name}.

WildfireSettings

Settings for WildFire analysis.

JSON representation 
{
  "enabled": boolean,
  "wildfireRegion": enum (WildfireRegion),
  "wildfireRealtimeLookupDuration": string,
  "wildfireRealtimeLookupTimeoutAction": enum (WildfireRealtimeSignatureLookupTimeoutAction),
  "wildfireInlineCloudAnalysisSettings": {
    object (WildfireInlineCloudAnalysisSettings)
  }
}
Fields
enabled

boolean

Optional. Indicates whether WildFire analysis is enabled. Default value is false.
wildfireRegion

enum (WildfireRegion)

Optional. The region where WildFire analysis will be performed. PAN supports regions: https://docs.paloaltonetworks.com/advanced-wildfire/administration/advanced-wildfire-overview/advanced-wildfire-deployments/advanced-wildfire-global-cloud
wildfireRealtimeLookupDuration

string (Duration format)

Optional. Duration in milliseconds on a file being held while the WildFire real time signature cloud performs a signature lookup. Value between 1 to 5000 is valid. Default value is 1000.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
wildfireRealtimeLookupTimeoutAction

enum (WildfireRealtimeSignatureLookupTimeoutAction)

Optional. Action to take on WildFire real time signature lookup timeout. Default value is ALLOW.
wildfireInlineCloudAnalysisSettings

object (WildfireInlineCloudAnalysisSettings)

Optional. Settings for WildFire inline cloud analysis.

WildfireRegion

Available WildFire regions for analysis.

Enums
WILDFIRE_REGION_UNSPECIFIED WildFire region not specified.
CANADA Canada cloud portal: ca.wildfire.paloaltonetworks.com
UNITED_STATES United States cloud portal: us-native.wildfire.paloaltonetworks.com
JAPAN Japan cloud portal: jp.wildfire.paloaltonetworks.com
SINGAPORE Singapore cloud portal: sg.wildfire.paloaltonetworks.com
UNITED_KINGDOM United Kingdom cloud portal: uk.wildfire.paloaltonetworks.com
AUSTRALIA Australia cloud portal: au.wildfire.paloaltonetworks.com
GERMANY Germany cloud portal: de.wildfire.paloaltonetworks.com
INDIA India cloud portal: in.wildfire.paloaltonetworks.com
SWITZERLAND Switzerland cloud portal: ch.wildfire.paloaltonetworks.com
POLAND Poland cloud portal: pl.wildfire.paloaltonetworks.com
INDONESIA Indonesia cloud portal: id.wildfire.paloaltonetworks.com
TAIWAN Taiwan cloud portal: tw.wildfire.paloaltonetworks.com
FRANCE France cloud portal: fr.wildfire.paloaltonetworks.com
QATAR Qatar cloud portal: qatar.wildfire.paloaltonetworks.com
SOUTH_KOREA South Korea cloud portal: kr.wildfire.paloaltonetworks.com
ISRAEL Israel cloud portal: il.wildfire.paloaltonetworks.com
SAUDI_ARABIA Saudi Arabia cloud portal: sa.wildfire.paloaltonetworks.com
SPAIN Spain cloud portal: es.wildfire.paloaltonetworks.com

WildfireRealtimeSignatureLookupTimeoutAction

Available action to take on WildFire real time signature lookup timeout.

Enums
WILDFIRE_REALTIME_SIGNATURE_LOOKUP_TIMEOUT_ACTION_UNSPECIFIED WildFire real time signature lookup timeout action not specified.
ALLOW The files that timed out in the signature lookup will be allowed to transmit.
DENY The files that timed out in the signature lookup will be denied to transmit.

WildfireInlineCloudAnalysisSettings

Settings for WildFire inline cloud analysis.

JSON representation 
{
  "maxAnalysisDuration": string,
  "timeoutAction": enum (WildfireInlineCloudAnalysisTimeoutAction),
  "submissionTimeoutLoggingDisabled": boolean
}
Fields
maxAnalysisDuration

string (Duration format)

Optional. Timeout in milliseconds on a file being held while WildFire inline cloud analysis is performed. Value between 1 to 240000 is valid. Default value is 30000.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
timeoutAction

enum (WildfireInlineCloudAnalysisTimeoutAction)

Optional. Action to take when WildFire inline cloud analysis times out. Default value is ALLOW.
submissionTimeoutLoggingDisabled

boolean

Optional. Whether to disable WildFire submission log generation for files that timeout during WildFire inline cloud analysis.

WildfireInlineCloudAnalysisTimeoutAction

Available action to take on WildFire inline cloud analysis timeout.

Enums
WILDFIRE_INLINE_CLOUD_ANALYSIS_TIMEOUT_ACTION_UNSPECIFIED WildFire inline cloud analysis timeout action not specified.
ALLOW The files that timed out will be allowed to transmit.
DENY The files that timed out will be denied to transmit.

EndpointSettings

Settings for the endpoint.

JSON representation 
{
  "jumboFramesEnabled": boolean,
  "contentCloudRegion": enum (ContentCloudRegion),
  "httpPartialResponseBlocked": boolean
}
Fields
jumboFramesEnabled

boolean

Optional. Immutable. Indicates whether Jumbo Frames are enabled. Default value is false.
contentCloudRegion

enum (ContentCloudRegion)

Optional. The content cloud region of the endpoint.
httpPartialResponseBlocked

boolean

Optional. Whether to block HTTP partial responses for the endpoint. When this is true, resumption of blocked malicious HTTP file downloads will be blocked by the firewall. False provides maximum availability, true provides maximum security.

ContentCloudRegion

Available PAN content cloud regions.

Enums
CONTENT_CLOUD_REGION_UNSPECIFIED PAN content cloud region not specified.
US_CENTRAL us.hawkeye.services-edge.paloaltonetworks.com
APAC APAC content cloud portal: apac.hawkeye.services-edge.paloaltonetworks.com
INDIA India content cloud portal: in.hawkeye.services-edge.paloaltonetworks.com
UK UK content cloud portal: uk.hawkeye.services-edge.paloaltonetworks.com
FRANCE France content cloud portal: fr.hawkeye.services-edge.paloaltonetworks.com
JAPAN Japan content cloud portal: jp.hawkeye.services-edge.paloaltonetworks.com
AUSTRALIA Australia content cloud portal: au.hawkeye.services-edge.paloaltonetworks.com
CANADA Canada content cloud portal: ca.hawkeye.services-edge.paloaltonetworks.com
SWITZERLAND Switzerland content cloud portal: ch.hawkeye.services-edge.paloaltonetworks.com
NETHERLANDS Netherlands content cloud portal: nl.hawkeye.services-edge.paloaltonetworks.com
INDONESIA Indonesia content cloud portal: id.hawkeye.services-edge.paloaltonetworks.com
QATAR Qatar content cloud portal: qa.hawkeye.services-edge.paloaltonetworks.com
TAIWAN Taiwan content cloud portal: tw.hawkeye.services-edge.paloaltonetworks.com
POLAND Poland content cloud portal: pl.hawkeye.services-edge.paloaltonetworks.com
SOUTH_KOREA South Korea content cloud portal: kr.hawkeye.services-edge.paloaltonetworks.com
SAUDI_ARABIA Saudi Arabia content cloud portal: sa.hawkeye.services-edge.paloaltonetworks.com
ITALY Italy content cloud portal: it.hawkeye.services-edge.paloaltonetworks.com

Methods

create

 Creates a new FirewallEndpoint in a given organization and location.

delete

 Deletes a single org Endpoint.

get

 Gets details of a single org Endpoint.

list

 Lists FirewallEndpoints in a given organization and location.

patch

 Update a single org Endpoint.