# REST Resource: organizations.locations.firewallEndpoints

- [Resource: FirewallEndpoint](https://docs.cloud.google.com/service-mesh/v1.23/docs/reference/network-security/rest/v1beta1/organizations.locations.firewallEndpoints#FirewallEndpoint)
  - [JSON representation](https://docs.cloud.google.com/service-mesh/v1.23/docs/reference/network-security/rest/v1beta1/organizations.locations.firewallEndpoints#FirewallEndpoint.SCHEMA_REPRESENTATION)
- [State](https://docs.cloud.google.com/service-mesh/v1.23/docs/reference/network-security/rest/v1beta1/organizations.locations.firewallEndpoints#State)
- [AssociationReference](https://docs.cloud.google.com/service-mesh/v1.23/docs/reference/network-security/rest/v1beta1/organizations.locations.firewallEndpoints#AssociationReference)
  - [JSON representation](https://docs.cloud.google.com/service-mesh/v1.23/docs/reference/network-security/rest/v1beta1/organizations.locations.firewallEndpoints#AssociationReference.SCHEMA_REPRESENTATION)
- [Methods](https://docs.cloud.google.com/service-mesh/v1.23/docs/reference/network-security/rest/v1beta1/organizations.locations.firewallEndpoints#METHODS_SUMMARY)

## Resource: FirewallEndpoint

Message describing Endpoint object

| JSON representation |
|---|
| ``` { "name": string, "description": string, "createTime": string, "updateTime": string, "labels": { string: string, ... }, "state": enum (`https://docs.cloud.google.com/service-mesh/v1.23/docs/reference/network-security/rest/v1beta1/organizations.locations.firewallEndpoints#State`), "reconciling": boolean, "associatedNetworks": [ string ], "associations": [ { object (`https://docs.cloud.google.com/service-mesh/v1.23/docs/reference/network-security/rest/v1beta1/organizations.locations.firewallEndpoints#AssociationReference`) } ], "billingProjectId": string } ``` |

| Fields ||
|---|---|
| `name` | `string` Immutable. Identifier. name of resource |
| `description` | `string` Optional. Description of the firewall endpoint. Max length 2048 characters. |
| `createTime` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` Output only. Create time stamp A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: `"2014-10-02T15:01:23Z"` and `"2014-10-02T15:01:23.045123456Z"`. |
| `updateTime` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` Output only. Update time stamp A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: `"2014-10-02T15:01:23Z"` and `"2014-10-02T15:01:23.045123456Z"`. |
| `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/service-mesh/v1.23/docs/reference/network-security/rest/v1beta1/organizations.locations.firewallEndpoints#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] > Output only. Use the `network` field in the `associations` message instead. Output only. 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 (`https://docs.cloud.google.com/service-mesh/v1.23/docs/reference/network-security/rest/v1beta1/organizations.locations.firewallEndpoints#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. |
| `billingProjectId` | `string` Required. Project to bill on endpoint uptime usage. |

## 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}. |

| ## Methods ||
|---|---|
| ### `https://docs.cloud.google.com/service-mesh/v1.23/docs/reference/network-security/rest/v1beta1/organizations.locations.firewallEndpoints/create` | Creates a new FirewallEndpoint in a given project and location. |
| ### `https://docs.cloud.google.com/service-mesh/v1.23/docs/reference/network-security/rest/v1beta1/organizations.locations.firewallEndpoints/delete` | Deletes a single Endpoint. |
| ### `https://docs.cloud.google.com/service-mesh/v1.23/docs/reference/network-security/rest/v1beta1/organizations.locations.firewallEndpoints/get` | Gets details of a single Endpoint. |
| ### `https://docs.cloud.google.com/service-mesh/v1.23/docs/reference/network-security/rest/v1beta1/organizations.locations.firewallEndpoints/list` | Lists FirewallEndpoints in a given project and location. |
| ### `https://docs.cloud.google.com/service-mesh/v1.23/docs/reference/network-security/rest/v1beta1/organizations.locations.firewallEndpoints/patch` | Update a single Endpoint. |