APIHub
Back to Explore

BeyondCorp API

Beyondcorp Enterprise provides identity and context aware access controls for enterprise resources and enables zero-trust access. Using the Beyondcorp Enterprise APIs, enterprises can set up multi-cloud and on-prem connectivity solutions.

Analytics
OAuth
HTTPS
CORS: Unknown
Visit official documentation

Latency

Not monitored yet

Uptime

Not monitored yet

Playground

Verified

live

Endpoints

REST · JSON
POST

/v1/{appConnector}:reportStatus

Report status for a given connector.

  • appConnector (path, required) — Required. BeyondCorp Connector name using the form: `projects/{project_id}/locations/{location_id}/connectors/{connector}`
GET

/v1/{appConnector}:resolveInstanceConfig

Gets instance configuration for a given AppConnector. An internal method called by a AppConnector to get its container config.

  • appConnector (path, required) — Required. BeyondCorp AppConnector name using the form: `projects/{project_id}/locations/{location_id}/appConnectors/{app_connector}`
DELETE

/v1/{name}

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

  • name (path, required) — The name of the operation resource to be deleted.
  • requestId (query) — Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
  • validateOnly (query) — Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.
GET

/v1/{name}

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

  • name (path, required) — The name of the operation resource.
GET

/v1/{parent}/appConnections:resolve

Resolves AppConnections details for a given AppConnector. An internal method called by a connector to find AppConnections to connect to.

  • parent (path, required) — Required. The resource name of the AppConnection location using the form: `projects/{project_id}/locations/{location_id}`
  • appConnectorId (query) — Required. BeyondCorp Connector name of the connector associated with those AppConnections using the form: `projects/{project_id}/locations/{location_id}/appConnectors/{app_connector_id}`
  • pageSize (query, limit) — Optional. The maximum number of items to return. If not specified, a default value of 50 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more instances left to be queried.
  • pageToken (query) — Optional. The next_page_token value returned from a previous ResolveAppConnectionsResponse, if any.
PATCH

/v1/{name}

Updates the parameters of a single AppConnector.

  • name (path, required) — Required. Unique resource name of the AppConnector. The name is ignored when creating a AppConnector.
  • requestId (query) — Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
  • updateMask (query) — Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from [BeyondCorp.AppConnector]: * `labels` * `display_name`
  • validateOnly (query) — Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.
GET

/v1/{name}/locations

Lists information about the supported locations for this service.

  • name (path, required) — The resource that owns the locations collection, if applicable.
  • filter (query) — A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
  • pageSize (query, limit) — The maximum number of results to return. If not set, the service selects a default.
  • pageToken (query) — A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
GET

/v1/{name}/operations

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

  • name (path, required) — The name of the operation's parent resource.
  • filter (query) — The standard list filter.
  • pageSize (query, limit) — The standard list page size.
  • pageToken (query) — The standard list page token.
POST

/v1/{name}:cancel

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.

  • name (path, required) — The name of the operation resource to be cancelled.
GET

/v1/{parent}/appConnections

Lists AppConnections in a given project and location.

  • parent (path, required) — Required. The resource name of the AppConnection location using the form: `projects/{project_id}/locations/{location_id}`
  • filter (query) — Optional. A filter specifying constraints of a list operation.
  • orderBy (query) — Optional. Specifies the ordering of results. See [Sorting order](https://cloud.google.com/apis/design/design_patterns#sorting_order) for more information.
  • pageSize (query, limit) — Optional. The maximum number of items to return. If not specified, a default value of 50 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more instances left to be queried.
  • pageToken (query) — Optional. The next_page_token value returned from a previous ListAppConnectionsRequest, if any.
POST

/v1/{parent}/appConnections

Creates a new AppConnection in a given project and location.

  • parent (path, required) — Required. The resource project name of the AppConnection location using the form: `projects/{project_id}/locations/{location_id}`
  • appConnectionId (query) — Optional. User-settable AppConnection resource ID. * Must start with a letter. * Must contain between 4-63 characters from `/a-z-/`. * Must end with a number or a letter.
  • requestId (query) — Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
  • validateOnly (query) — Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.
POST

/v1/{resource}:testIamPermissions

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

  • resource (path, required) — REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
GET

/v1/{parent}/appConnectors

Lists AppConnectors in a given project and location.

  • parent (path, required) — Required. The resource name of the AppConnector location using the form: `projects/{project_id}/locations/{location_id}`
  • filter (query) — Optional. A filter specifying constraints of a list operation.
  • orderBy (query) — Optional. Specifies the ordering of results. See [Sorting order](https://cloud.google.com/apis/design/design_patterns#sorting_order) for more information.
  • pageSize (query, limit) — Optional. The maximum number of items to return. If not specified, a default value of 50 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more instances left to be queried.
  • pageToken (query) — Optional. The next_page_token value returned from a previous ListAppConnectorsRequest, if any.
POST

/v1/{parent}/appConnectors

Creates a new AppConnector in a given project and location.

  • parent (path, required) — Required. The resource project name of the AppConnector location using the form: `projects/{project_id}/locations/{location_id}`
  • appConnectorId (query) — Optional. User-settable AppConnector resource ID. * Must start with a letter. * Must contain between 4-63 characters from `/a-z-/`. * Must end with a number or a letter.
  • requestId (query) — Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
  • validateOnly (query) — Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.
GET

/v1/{parent}/appGateways

Lists AppGateways in a given project and location.

  • parent (path, required) — Required. The resource name of the AppGateway location using the form: `projects/{project_id}/locations/{location_id}`
  • filter (query) — Optional. A filter specifying constraints of a list operation.
  • orderBy (query) — Optional. Specifies the ordering of results. See [Sorting order](https://cloud.google.com/apis/design/design_patterns#sorting_order) for more information.
  • pageSize (query, limit) — Optional. The maximum number of items to return. If not specified, a default value of 50 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more instances left to be queried.
  • pageToken (query) — Optional. The next_page_token value returned from a previous ListAppGatewaysRequest, if any.
POST

/v1/{parent}/appGateways

Creates a new AppGateway in a given project and location.

  • parent (path, required) — Required. The resource project name of the AppGateway location using the form: `projects/{project_id}/locations/{location_id}`
  • appGatewayId (query) — Optional. User-settable AppGateway resource ID. * Must start with a letter. * Must contain between 4-63 characters from `/a-z-/`. * Must end with a number or a letter.
  • requestId (query) — Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
  • validateOnly (query) — Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.
GET

/v1/{resource}:getIamPolicy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

  • resource (path, required) — REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
  • options.requestedPolicyVersion (query) — Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
POST

/v1/{resource}:setIamPolicy

Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

  • resource (path, required) — REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

18 endpoints auto-detected

Authentication

This API requires authentication: OAuth.

curl -X POST \
  "https://beyondcorp.googleapis.com/v1/{appConnector}:reportStatus"

beyondcorp.googleapis.com · HTTPS only