# REST Resource: projects.locations.appConnections

- [Resource: AppConnection](https://docs.cloud.google.com/beyondcorp/docs/reference/rest/v1/projects.locations.appConnections#AppConnection)
  - [JSON representation](https://docs.cloud.google.com/beyondcorp/docs/reference/rest/v1/projects.locations.appConnections#AppConnection.SCHEMA_REPRESENTATION)
- [Type](https://docs.cloud.google.com/beyondcorp/docs/reference/rest/v1/projects.locations.appConnections#Type)
- [ApplicationEndpoint](https://docs.cloud.google.com/beyondcorp/docs/reference/rest/v1/projects.locations.appConnections#ApplicationEndpoint)
  - [JSON representation](https://docs.cloud.google.com/beyondcorp/docs/reference/rest/v1/projects.locations.appConnections#ApplicationEndpoint.SCHEMA_REPRESENTATION)
- [State](https://docs.cloud.google.com/beyondcorp/docs/reference/rest/v1/projects.locations.appConnections#State)
- [Gateway](https://docs.cloud.google.com/beyondcorp/docs/reference/rest/v1/projects.locations.appConnections#Gateway)
  - [JSON representation](https://docs.cloud.google.com/beyondcorp/docs/reference/rest/v1/projects.locations.appConnections#Gateway.SCHEMA_REPRESENTATION)
- [Type](https://docs.cloud.google.com/beyondcorp/docs/reference/rest/v1/projects.locations.appConnections#Type_1)
- [Methods](https://docs.cloud.google.com/beyondcorp/docs/reference/rest/v1/projects.locations.appConnections#METHODS_SUMMARY)

## Resource: AppConnection

A BeyondCorp AppConnection resource represents a BeyondCorp protected AppConnection to a remote application. It creates all the necessary GCP components needed for creating a BeyondCorp protected AppConnection. Multiple connectors can be authorised for a single AppConnection.

| JSON representation |
|---|
| ``` { "name": string, "createTime": string, "updateTime": string, "labels": { string: string, ... }, "displayName": string, "uid": string, "type": enum (`https://docs.cloud.google.com/beyondcorp/docs/reference/rest/v1/projects.locations.appConnections#Type`), "applicationEndpoint": { object (`https://docs.cloud.google.com/beyondcorp/docs/reference/rest/v1/projects.locations.appConnections#ApplicationEndpoint`) }, "connectors": [ string ], "state": enum (`https://docs.cloud.google.com/beyondcorp/docs/reference/rest/v1/projects.locations.appConnections#State`), "gateway": { object (`https://docs.cloud.google.com/beyondcorp/docs/reference/rest/v1/projects.locations.appConnections#Gateway`) }, "satisfiesPzs": boolean, "satisfiesPzi": boolean } ``` |

| Fields ||
|---|---|
| `name` | `string` Required. Unique resource name of the AppConnection. The name is ignored when creating a AppConnection. |
| `createTime` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` Output only. Timestamp when the resource was created. 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. Timestamp when the resource was last modified. 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. Resource labels to represent user provided metadata. |
| `displayName` | `string` Optional. An arbitrary user-provided name for the AppConnection. Cannot exceed 64 characters. |
| `uid` | `string` Output only. A unique identifier for the instance generated by the system. |
| `type` | ``enum (`https://docs.cloud.google.com/beyondcorp/docs/reference/rest/v1/projects.locations.appConnections#Type`)`` Required. The type of network connectivity used by the AppConnection. |
| `applicationEndpoint` | ``object (`https://docs.cloud.google.com/beyondcorp/docs/reference/rest/v1/projects.locations.appConnections#ApplicationEndpoint`)`` Required. Address of the remote application endpoint for the BeyondCorp AppConnection. |
| `connectors[]` | `string` Optional. List of \[google.cloud.beyondcorp.v1main.Connector.name\] that are authorised to be associated with this AppConnection. |
| `state` | ``enum (`https://docs.cloud.google.com/beyondcorp/docs/reference/rest/v1/projects.locations.appConnections#State`)`` Output only. The current state of the AppConnection. |
| `gateway` | ``object (`https://docs.cloud.google.com/beyondcorp/docs/reference/rest/v1/projects.locations.appConnections#Gateway`)`` Optional. Gateway used by the AppConnection. |
| `satisfiesPzs` | `boolean` Output only. Reserved for future use. |
| `satisfiesPzi` | `boolean` Output only. Reserved for future use. |

## Type

Enum containing list of all possible network connectivity options supported by BeyondCorp AppConnection.

| Enums ||
|---|---|
| `TYPE_UNSPECIFIED` | Default value. This value is unused. |
| `TCP_PROXY` | TCP Proxy based BeyondCorp AppConnection. API will default to this if unset. |

## ApplicationEndpoint

ApplicationEndpoint represents a remote application endpoint.

| JSON representation |
|---|
| ``` { "host": string, "port": integer } ``` |

| Fields ||
|---|---|
| `host` | `string` Required. Hostname or IP address of the remote application endpoint. |
| `port` | `integer` Required. Port of the remote application endpoint. |

## State

Represents the different states of a AppConnection.

| Enums ||
|---|---|
| `STATE_UNSPECIFIED` | Default value. This value is unused. |
| `CREATING` | AppConnection is being created. |
| `CREATED` | AppConnection has been created. |
| `UPDATING` | AppConnection's configuration is being updated. |
| `DELETING` | AppConnection is being deleted. |
| `DOWN` | AppConnection is down and may be restored in the future. This happens when CCFE sends ProjectState = OFF. |

## Gateway

Gateway represents a user facing component that serves as an entrance to enable connectivity.

| JSON representation |
|---|
| ``` { "type": enum (`https://docs.cloud.google.com/beyondcorp/docs/reference/rest/v1/projects.locations.appConnections#Type_1`), "uri": string, "ingressPort": integer, "appGateway": string, "l7psc": string } ``` |

| Fields ||
|---|---|
| `type` | ``enum (`https://docs.cloud.google.com/beyondcorp/docs/reference/rest/v1/projects.locations.appConnections#Type_1`)`` Required. The type of hosting used by the gateway. |
| `uri` | `string` Output only. Server-defined URI for this resource. |
| `ingressPort` | `integer` Output only. Ingress port reserved on the gateways for this AppConnection, if not specified or zero, the default port is 19443. |
| `appGateway` | `string` Required. AppGateway name in following format: `projects/{projectId}/locations/{locationId}/appgateways/{gateway_id}` |
| `l7psc` | `string` Output only. L7 private service connection for this resource. |

## Type

Enum listing possible gateway hosting options.

| Enums ||
|---|---|
| `TYPE_UNSPECIFIED` | Default value. This value is unused. |
| `GCP_REGIONAL_MIG` | Gateway hosted in a GCP regional managed instance group. |

| ## Methods ||
|---|---|
| ### `https://docs.cloud.google.com/beyondcorp/docs/reference/rest/v1/projects.locations.appConnections/create` | Creates a new AppConnection in a given project and location. |
| ### `https://docs.cloud.google.com/beyondcorp/docs/reference/rest/v1/projects.locations.appConnections/delete` | Deletes a single AppConnection. |
| ### `https://docs.cloud.google.com/beyondcorp/docs/reference/rest/v1/projects.locations.appConnections/get` | Gets details of a single AppConnection. |
| ### `https://docs.cloud.google.com/beyondcorp/docs/reference/rest/v1/projects.locations.appConnections/getIamPolicy` | Gets the access control policy for a resource. |
| ### `https://docs.cloud.google.com/beyondcorp/docs/reference/rest/v1/projects.locations.appConnections/list` | Lists AppConnections in a given project and location. |
| ### `https://docs.cloud.google.com/beyondcorp/docs/reference/rest/v1/projects.locations.appConnections/patch` | Updates the parameters of a single AppConnection. |
| ### `https://docs.cloud.google.com/beyondcorp/docs/reference/rest/v1/projects.locations.appConnections/resolve` | Resolves AppConnections details for a given AppConnector. |
| ### `https://docs.cloud.google.com/beyondcorp/docs/reference/rest/v1/projects.locations.appConnections/setIamPolicy` | Sets the access control policy on the specified resource. |
| ### `https://docs.cloud.google.com/beyondcorp/docs/reference/rest/v1/projects.locations.appConnections/testIamPermissions` | Returns permissions that a caller has on the specified resource. |