## Resource: FirewallEndpoint

Message describing a firewall endpoint.

| JSON representation |
|---|
| ``` { "name": string, "description": string, "createTime": string, "updateTime": string, "labels": { string: string, ... }, "state": enum (`https://docs.cloud.google.com/firewall/docs/reference/network-security/rest/v1/organizations.locations.firewallEndpoints#FirewallEndpoint.State`), "reconciling": boolean, "associatedNetworks": [ string ], "associations": [ { object (`https://docs.cloud.google.com/firewall/docs/reference/network-security/rest/v1/organizations.locations.firewallEndpoints#FirewallEndpoint.AssociationReference`) } ], "wildfireSettings": { object (`https://docs.cloud.google.com/firewall/docs/reference/network-security/rest/v1/organizations.locations.firewallEndpoints#FirewallEndpoint.WildfireSettings`) }, "billingProjectId": string, "endpointSettings": { object (`https://docs.cloud.google.com/firewall/docs/reference/network-security/rest/v1/organizations.locations.firewallEndpoints#FirewallEndpoint.EndpointSettings`) }, "satisfiesPzs": boolean, "satisfiesPzi": boolean } ``` |

| Fields ||
|---|---|
| `name` | `string` Immutable. Identifier. The name of the resource. |
| `description` | `string` Optional. Description of the firewall endpoint. The maximum length is 2048 characters. |
| `createTime` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` Output only. Create timestamp. 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 (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` Output only. Update timestamp. 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 (`https://docs.cloud.google.com/firewall/docs/reference/network-security/rest/v1/organizations.locations.firewallEndpoints#FirewallEndpoint.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` > [!WARNING] > This item is deprecated! Output only. Deprecated: Use the `network` field in the `associations` message instead. List of networks that are associated with this endpoint in the local zone. This is a projection of the firewall endpoint association resources pointing at this endpoint. A network only appears in this list after traffic routing is fully configured. Format: `projects/{project}/global/networks/{name}`. |
| `associations[]` | ``object (`https://docs.cloud.google.com/firewall/docs/reference/network-security/rest/v1/organizations.locations.firewallEndpoints#FirewallEndpoint.AssociationReference`)`` Output only. List of firewall endpoint association resources that are associated with this endpoint. An association only appears in this list after traffic routing is fully configured. |
| `wildfireSettings` | ``object (`https://docs.cloud.google.com/firewall/docs/reference/network-security/rest/v1/organizations.locations.firewallEndpoints#FirewallEndpoint.WildfireSettings`)`` Optional. Settings for Advanced malware sandbox (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. |
| `endpointSettings` | ``object (`https://docs.cloud.google.com/firewall/docs/reference/network-security/rest/v1/organizations.locations.firewallEndpoints#FirewallEndpoint.EndpointSettings`)`` Optional. Settings for the endpoint. |
| `satisfiesPzs` | `boolean` Output only. Reserved for future use. |
| `satisfiesPzi` | `boolean` 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

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 associated VPC network. Format: `projects/{project}/global/networks/{name}`. |

### WildfireSettings

Settings for Advanced malware sandbox analysis.

| JSON representation |
|---|
| ``` { "enabled": boolean, "wildfireRegion": enum (`https://docs.cloud.google.com/firewall/docs/reference/network-security/rest/v1/organizations.locations.firewallEndpoints#FirewallEndpoint.WildfireRegion`), "wildfireRealtimeLookupDuration": string, "wildfireRealtimeLookupTimeoutAction": enum (`https://docs.cloud.google.com/firewall/docs/reference/network-security/rest/v1/organizations.locations.firewallEndpoints#FirewallEndpoint.WildfireRealtimeSignatureLookupTimeoutAction`), "wildfireInlineCloudAnalysisSettings": { object (`https://docs.cloud.google.com/firewall/docs/reference/network-security/rest/v1/organizations.locations.firewallEndpoints#FirewallEndpoint.WildfireInlineCloudAnalysisSettings`) } } ``` |

| Fields ||
|---|---|
| `enabled` | `boolean` Optional. Indicates whether Advanced malware sandbox analysis is enabled. The default value is `false`. |
| `wildfireRegion` | ``enum (`https://docs.cloud.google.com/firewall/docs/reference/network-security/rest/v1/organizations.locations.firewallEndpoints#FirewallEndpoint.WildfireRegion`)`` Optional. The region where Advanced malware sandbox analysis is performed. For a list of Palo Alto Networks supported regions, see [Advanced WildFire global cloud](https://docs.paloaltonetworks.com/advanced-wildfire/administration/advanced-wildfire-overview/advanced-wildfire-deployments/advanced-wildfire-global-cloud). |
| `wildfireRealtimeLookupDuration` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#duration` format)`` Optional. The duration that a file is held while the Advanced malware sandbox real-time signature cloud performs a signature lookup. Valid values are from 1 to 5000 milliseconds. In canonical JSON encoding, this is represented as a string ending in `s` (for example, `"0.001s"` to `"5s"`). The default value is `1000` milliseconds (`"1s"` in JSON). A duration in seconds with up to nine fractional digits, ending with '`s`'. Example: `"3.5s"`. |
| `wildfireRealtimeLookupTimeoutAction` | ``enum (`https://docs.cloud.google.com/firewall/docs/reference/network-security/rest/v1/organizations.locations.firewallEndpoints#FirewallEndpoint.WildfireRealtimeSignatureLookupTimeoutAction`)`` Optional. The action to take on an Advanced malware sandbox real-time signature lookup timeout. The default value is `ALLOW`. |
| `wildfireInlineCloudAnalysisSettings` | ``object (`https://docs.cloud.google.com/firewall/docs/reference/network-security/rest/v1/organizations.locations.firewallEndpoints#FirewallEndpoint.WildfireInlineCloudAnalysisSettings`)`` Optional. Settings for Advanced malware sandbox inline cloud analysis. |

### WildfireRegion

Available Advanced malware sandbox 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

The available actions to take on an Advanced malware sandbox real-time signature lookup timeout.

| Enums ||
|---|---|
| `WILDFIRE_REALTIME_SIGNATURE_LOOKUP_TIMEOUT_ACTION_UNSPECIFIED` | Advanced malware sandbox real-time signature lookup timeout action not specified. |
| `ALLOW` | Files that time out during the signature lookup are allowed to transmit. |
| `DENY` | Files that time out during the signature lookup are not allowed to transmit. |

### WildfireInlineCloudAnalysisSettings

Settings for Advanced malware sandbox inline cloud analysis.

| JSON representation |
|---|
| ``` { "maxAnalysisDuration": string, "timeoutAction": enum (`https://docs.cloud.google.com/firewall/docs/reference/network-security/rest/v1/organizations.locations.firewallEndpoints#FirewallEndpoint.WildfireInlineCloudAnalysisTimeoutAction`), "submissionTimeoutLoggingDisabled": boolean } ``` |

| Fields ||
|---|---|
| `maxAnalysisDuration` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#duration` format)`` Optional. The timeout that a file is held while Advanced malware sandbox inline cloud analysis is performed. Valid values are from 1 to 240000 milliseconds. In canonical JSON encoding, this is represented as a string ending in `s` (for example, `"0.001s"` to `"240s"`). The default value is `30000` milliseconds (`"30s"` in JSON). A duration in seconds with up to nine fractional digits, ending with '`s`'. Example: `"3.5s"`. |
| `timeoutAction` | ``enum (`https://docs.cloud.google.com/firewall/docs/reference/network-security/rest/v1/organizations.locations.firewallEndpoints#FirewallEndpoint.WildfireInlineCloudAnalysisTimeoutAction`)`` Optional. The action to take when Advanced malware sandbox inline cloud analysis times out. The default value is `ALLOW`. |
| `submissionTimeoutLoggingDisabled` | `boolean` Optional. Whether to disable Advanced malware sandbox submission log generation for files that time out during Advanced malware sandbox inline cloud analysis. |

### WildfireInlineCloudAnalysisTimeoutAction

The available actions to take on an Advanced malware sandbox inline cloud analysis timeout.

| Enums ||
|---|---|
| `WILDFIRE_INLINE_CLOUD_ANALYSIS_TIMEOUT_ACTION_UNSPECIFIED` | Advanced malware sandbox inline cloud analysis timeout action not specified. |
| `ALLOW` | Files that time out are allowed to transmit. |
| `DENY` | Files that time out are not allowed to transmit. |

### EndpointSettings

Settings for the endpoint.

| JSON representation |
|---|
| ``` { "jumboFramesEnabled": boolean, "contentCloudRegion": enum (`https://docs.cloud.google.com/firewall/docs/reference/network-security/rest/v1/organizations.locations.firewallEndpoints#FirewallEndpoint.ContentCloudRegion`), "httpPartialResponseBlocked": boolean } ``` |

| Fields ||
|---|---|
| `jumboFramesEnabled` | `boolean` Optional. Immutable. Indicates whether jumbo frames are enabled. The default value is `false`. |
| `contentCloudRegion` | ``enum (`https://docs.cloud.google.com/firewall/docs/reference/network-security/rest/v1/organizations.locations.firewallEndpoints#FirewallEndpoint.ContentCloudRegion`)`` Optional. The content cloud region of the endpoint. |
| `httpPartialResponseBlocked` | `boolean` Optional. Whether to block HTTP partial responses for the endpoint. When set to `true`, the firewall blocks the resumption of HTTP file downloads. Setting this to `false` provides maximum availability, while `true` provides maximum security. |

### ContentCloudRegion

Available Palo Alto Networks content cloud regions.

| Enums ||
|---|---|
| `CONTENT_CLOUD_REGION_UNSPECIFIED` | Palo Alto Networks content cloud region not specified. |
| `US_CENTRAL` | US Central content cloud portal: `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 ||
|---|---|
| ### `https://docs.cloud.google.com/firewall/docs/reference/network-security/rest/v1/organizations.locations.firewallEndpoints/create` | Creates a new firewall endpoint in a given organization and location. |
| ### `https://docs.cloud.google.com/firewall/docs/reference/network-security/rest/v1/organizations.locations.firewallEndpoints/delete` | Deletes a single organization endpoint. |
| ### `https://docs.cloud.google.com/firewall/docs/reference/network-security/rest/v1/organizations.locations.firewallEndpoints/get` | Gets details of a single organization endpoint. |
| ### `https://docs.cloud.google.com/firewall/docs/reference/network-security/rest/v1/organizations.locations.firewallEndpoints/list` | Lists firewall endpoints in a given organization and location. |
| ### `https://docs.cloud.google.com/firewall/docs/reference/network-security/rest/v1/organizations.locations.firewallEndpoints/patch` | Updates a single organization endpoint. |