Google BeyondCorp API
Browse all Google APIs42
AI ReadinessFoundational (D-)42/100
Official vendor OpenAPI document · agent-readyIdentity AuthAuthorizationoauth223 EndpointsREST
For Agents
Provision and manage Google Cloud BeyondCorp app connectors and app gateways for zero-trust access to internal applications.
Use for: I need to register a new BeyondCorp app connector for an internal HR app, List every app connector in my organisation and its current state, Resolve the instance config for an app connector starting up in a VM, Patch an app gateway to update its display name and labels
Not supported: 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.
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.
Install Jentic One Beta
Connect the BeyondCorp API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the BeyondCorp API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fgoogleapis.com%2Fbeyondcorp" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fgoogleapis.com%2Fbeyondcorp" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with BeyondCorp API.
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
Patterns agents use BeyondCorp API for, with concrete tasks.
★ 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.
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.
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.
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.
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
23 endpoints — 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.
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
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
Jentic AI Readiness Score
This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.
B
BeyondCorp API
- Foundational (D-)42/100
61
Foundational Compliance56
Developer Experience & Jentic Compatibility19
AI-Readiness & Agent Experience94
Agent Usability63
Security67
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
61
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: B-Signals: 4
71%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
0%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
75%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
56
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: CSignals: 4
0%
Example Density
How richly the API is illustrated with examples.
100%
Example Validity
Percentage of examples that conform to their schemas.
25%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
100%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
19
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: FSignals: 4
76%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
0%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
0%
Summary Coverage
Coverage of summaries across operations/tags/info.
94
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: A+Signals: 1
94%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
63
Security
Trust, risk posture, and security compliance.
Grade: B-Signals: 1
62%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
67
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: B+Signals: 1
67%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
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 isolation
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.
Intent-based discovery
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
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using BeyondCorp API through Jentic.
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.
GET STARTED