canonical: https://jentic.com/apis/googleapis.com/beyondcorp

# Google BeyondCorp API

The BeyondCorp API manages Google Cloud's zero-trust access product, exposing operations to provision and manage app connectors, app gateways, and the application links that connect users to internal applications without a VPN. App connectors report their status and resolve their instance configuration via dedicated endpoints, and the API supports long-running operations for create, patch, and delete flows. The API is the control plane that wires identity-aware proxies into enterprise applications. It does not authenticate end users or evaluate access policies at request time.

## For AI agents

Provision and manage Google Cloud BeyondCorp app connectors and app gateways for zero-trust access to internal applications.

## Scope

Does not authenticate end users, evaluate per-request access policies, or replace Identity-Aware Proxy - use for app connector and gateway lifecycle in BeyondCorp only.

## Capabilities

- Report connector status from a deployed app connector via /v1/{+appConnector}:reportStatus
- Resolve an app connector's instance configuration with /v1/{+appConnector}:resolveInstanceConfig at boot time
- Create, patch, and delete app connectors and app gateways as long-running operations
- List app connectors and app gateways scoped to a project and location
- Cancel a long-running operation via /v1/{+name}:cancel during a stuck rollout
- List BeyondCorp locations available to a project before provisioning

## Use cases

### Zero-Trust Access for Internal Web Apps

Replace a VPN-based access pattern for internal web applications by registering BeyondCorp app connectors and app gateways through the API. Once provisioned, identity-aware proxy policies (configured in IAP) gate user access. The API takes care of the connector lifecycle so admins do not have to script it manually.

Example prompt: POST a new app connector resource to /v1/{parent}/appConnectors and poll the operation until done.

### Connector Health Reporting

Have deployed app connectors report their health back to the control plane on a schedule using the reportStatus endpoint. Combined with resolveInstanceConfig at boot, this gives the BeyondCorp control plane an authoritative view of connector fleet health for use in dashboards and alerts.

Example prompt: POST a status payload to /v1/{appConnector}:reportStatus from the connector VM on a 60-second cadence.

### App Gateway Lifecycle Automation

Create, update, and decommission app gateways from infrastructure-as-code by calling the gateway endpoints. Long-running operations let pipelines wait for provisioning to settle before flipping DNS or load-balancer config to point at the new gateway.

Example prompt: POST an app gateway create request, poll the operation, and PATCH its labels once the gateway reports running.

### AI Agent Connector Registration via Jentic

Use an AI agent to onboard new internal apps by creating a BeyondCorp app connector, waiting for it to come online, and reporting back the resulting resource name. Through Jentic the agent finds operations by intent and runs them with project credentials at execute time, so onboarding can be triggered from a chat interface or ticket.

Example prompt: Use Jentic search for 'create a BeyondCorp app connector', execute it with the requested name and labels, and poll the returned operation until done.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | /v1/{+appConnector}:reportStatus | Report status from an app connector to the control plane |
| GET | /v1/{+appConnector}:resolveInstanceConfig | Resolve an app connector's instance configuration |
| GET | /v1/{+name} | Get an app connector or gateway by resource name |
| PATCH | /v1/{+name} | Update an app connector or gateway |
| DELETE | /v1/{+name} | Delete an app connector or gateway |
| GET | /v1/{+name}/locations | List BeyondCorp locations available to the project |
| POST | /v1/{+name}:cancel | Cancel a long-running BeyondCorp operation |

## Key resources

- **appConnectors** — Connectors that bridge user traffic to internal apps with status reporting
- **appGateways** — Gateways that front internal applications for BeyondCorp
- **operations** — Long-running operations covering create, patch, and delete flows
- **locations** — Regions where BeyondCorp resources can be created

## Why Jentic

- **Setup:** Wiring the BeyondCorp API by hand means configuring Google OAuth2, scoping a service account for connector access, and minting short-lived access tokens across its 23 operations yourself. Through Jentic you install once, import the BeyondCorp API from the API Directory, store the OAuth credential once, and your agent calls it.
- **Permission scoping:** This API puts the connector and resource name in the URL path (/v1/{appConnector}:reportStatus, /v1/{name}), so a rule can pin your agent to one app connector: it can report status and resolve its instance config and nothing else. You choose the operations it may call, so actions like deleting a connector are not included unless you add them.
- **Credential handling:** Your Google Cloud OAuth credential is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'create a BeyondCorp app connector' or 'report connector status', and Jentic returns the matching operation with its input schema so the agent calls the right endpoint without reading the discovery document.

## Related APIs

- **Cloud Identity-Aware Proxy API** — Evaluates per-request access policies for traffic flowing through BeyondCorp
- **Access Context Manager API** — Defines access levels and service perimeters that pair with BeyondCorp
- **Cloud Identity API** — Manages users and groups whose access BeyondCorp gates

## FAQ

### What authentication does the BeyondCorp API use?

The API uses Google OAuth 2.0 with cloud-platform scope. Calls are authorised by IAM roles such as roles/beyondcorp.admin on the project. Through Jentic the service account credential is encrypted in the vault and only short-lived access tokens reach the agent.

### Can I create an app connector through the API?

Yes. POST to /v1/{parent}/appConnectors with the connector spec. The call returns a long-running operation; poll it via GET /v1/{name} on the operation until done is true.

### How do I report connector status from a deployed VM?

POST a status payload to /v1/{appConnector}:reportStatus from inside the connector VM. The endpoint accepts the connector resource name and a status object describing health and version.

### What are the rate limits for the BeyondCorp API?

Numeric limits are not declared in the spec; quotas are enforced per project on beyondcorp.googleapis.com. Check the project's quota dashboard before automating large fleets of connectors.

### How do I onboard a new internal app through Jentic?

Search Jentic for 'create a BeyondCorp app connector'. Jentic returns POST /v1/{parent}/appConnectors with its schema; execute it with the requested name and labels and Jentic supplies the credential from the vault. Then poll the returned operation.

### Does the BeyondCorp API authenticate end users?

No. End-user authentication and per-request access decisions are handled by Identity-Aware Proxy and the broader Cloud IAM stack. This API manages the connector and gateway resources that those policies depend on.

### Can I limit what my agent is allowed to do with the BeyondCorp API?

Yes. Because you run Jentic One yourself, your own rules decide which BeyondCorp operations and which Google Cloud credential your agent may use. Since the API carries the connector and resource name in the URL path, such as /v1/{appConnector}:reportStatus and /v1/{name}, you can pin the agent to a single app connector so it can only report status and resolve its instance config. You pick the operations it may call, so destructive actions like deleting a connector or gateway stay out of reach unless you explicitly grant them.