2024-10-05
▼ ▲ beyondcorp.projects.locations.securityGateways.list
Path : v1/{+parent}/securityGateways
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/securityGateways
HTTP Method : GET
Parameters :
parent
Description : Required. The parent location to which the resources belong. `projects/{project_id}/locations/{location_id}/`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : 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.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. The next_page_token value returned from a previous ListSecurityGatewayRequest, if any.
Location : query
Type : string
filter
Description : Optional. A filter specifying constraints of a list operation. All fields in the SecurityGateway message are supported. For example, the following query will return the SecurityGateway with displayName "test-security-gateway" For more information, please refer to https://google.aip.dev/160.
Location : query
Type : string
orderBy
Description : Optional. Specifies the ordering of results. See [Sorting order](https://cloud.google.com/apis/design/design_patterns#sorting_order) for more information.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists SecurityGateways in a given project and location.
▼ ▲ beyondcorp.projects.locations.securityGateways.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}
HTTP Method : GET
Parameters :
name
Description : Required. The resource name of the PartnerTenant using the form: `projects/{project_id}/locations/{location_id}/securityGateway/{security_gateway_id}`
Pattern : ^projects/[^/]+/locations/[^/]+/securityGateways/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets details of a single SecurityGateway.
▼ ▲ beyondcorp.projects.locations.securityGateways.create
Path : v1/{+parent}/securityGateways
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/securityGateways
HTTP Method : POST
Parameters :
parent
Description : Required. The resource project name of the SecurityGateway location using the form: `projects/{project_id}/locations/{location_id}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
securityGatewayId
Description : Optional. User-settable SecurityGateway resource ID. * Must start with a letter. * Must contain between 4-63 characters from `/a-z-/`. * Must end with a number or letter.
Location : query
Type : string
requestId
Description : 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 request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a new SecurityGateway in a given project and location.
▼ ▲ beyondcorp.projects.locations.securityGateways.patch
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}
HTTP Method : PATCH
Parameters :
name
Description : Identifier. Name of the resource.
Pattern : ^projects/[^/]+/locations/[^/]+/securityGateways/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Required. Mutable fields include: display_name, hubs.
Location : query
Type : string
Format : google-fieldmask
requestId
Description : 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 timed 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).
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates the parameters of a single SecurityGateway.
▼ ▲ beyondcorp.projects.locations.securityGateways.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}
HTTP Method : DELETE
Parameters :
name
Description : Required. BeyondCorp SecurityGateway name using the form: `projects/{project_id}/locations/{location_id}/securityGateways/{security_gateway_id}`
Pattern : ^projects/[^/]+/locations/[^/]+/securityGateways/[^/]+$
Location : path
Required : Yes
Type : string
requestId
Description : 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).
Location : query
Type : string
validateOnly
Description : Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.
Location : query
Type : boolean
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a single SecurityGateway.
▼ ▲ beyondcorp.projects.locations.securityGateways.setPeering
Path : v1/{+securityGateway}:setPeering
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}:setPeering
HTTP Method : POST
Parameters :
securityGateway
Description : Required. BeyondCorp SecurityGateway name using the form: `projects/{project}/locations/{location}/securityGateways/{security_gateway}`
Pattern : ^projects/[^/]+/locations/[^/]+/securityGateways/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : securityGateway
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : This is a custom method to allow customers to create a peering connections between Google network and customer networks. This is enabled only for the allowlisted customers.
▼ ▲ beyondcorp.projects.locations.securityGateways.applications.list
Path : v1/{+parent}/applications
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}/applications
HTTP Method : GET
Parameters :
parent
Description : Required. The parent location to which the resources belong. `projects/{project_id}/locations/global/securityGateways/{security_gateway_id}`
Pattern : ^projects/[^/]+/locations/[^/]+/securityGateways/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : 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.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. The next_page_token value returned from a previous ListApplicationsRequest, if any.
Location : query
Type : string
filter
Description : Optional. A filter specifying constraints of a list operation. All fields in the Application message are supported. For example, the following query will return the Application with displayName "test-application" For more information, please refer to https://google.aip.dev/160.
Location : query
Type : string
orderBy
Description : Optional. Specifies the ordering of results. See [Sorting order](https://cloud.google.com/apis/design/design_patterns#sorting_order) for more information.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists Applications in a given project and location.
▼ ▲ beyondcorp.projects.locations.securityGateways.applications.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}/applications/{applicationsId}
HTTP Method : GET
Parameters :
name
Description : Required. The resource name of the Application using the form: `projects/{project_id}/locations/global/securityGateway/{security_gateway_id}/applications/{application_id}`
Pattern : ^projects/[^/]+/locations/[^/]+/securityGateways/[^/]+/applications/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets details of a single Application.
▼ ▲ beyondcorp.projects.locations.securityGateways.applications.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}/applications/{applicationsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. Name of the resource.
Pattern : ^projects/[^/]+/locations/[^/]+/securityGateways/[^/]+/applications/[^/]+$
Location : path
Required : Yes
Type : string
requestId
Description : 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).
Location : query
Type : string
validateOnly
Description : Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.
Location : query
Type : boolean
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a single Application.
▼ ▲ beyondcorp.projects.locations.global.securityGateways.applications.create
Path : v1/{+parent}/applications
Flat Path : v1/projects/{projectsId}/locations/global/securityGateways/{securityGatewaysId}/applications
HTTP Method : POST
Parameters :
parent
Description : Required. The resource name of the parent SecurityGateway using the form: `projects/{project_id}/locations/global/securityGateways/{security_gateway_id}`
Pattern : ^projects/[^/]+/locations/global/securityGateways/[^/]+$
Location : path
Required : Yes
Type : string
applicationId
Description : Optional. User-settable Application resource ID. * Must start with a letter. * Must contain between 4-63 characters from `/a-z-/`. * Must end with a number or letter.
Location : query
Type : string
requestId
Description : 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 request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a new Application in a given project and location.
▼ ▲ beyondcorp.projects.locations.global.securityGateways.applications.patch
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/global/securityGateways/{securityGatewaysId}/applications/{applicationsId}
HTTP Method : PATCH
Parameters :
name
Description : Identifier. Name of the resource.
Pattern : ^projects/[^/]+/locations/global/securityGateways/[^/]+/applications/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Required. Mutable fields include: display_name.
Location : query
Type : string
Format : google-fieldmask
requestId
Description : 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 timed 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).
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates the parameters of a single Application.
▼ ▲ beyondcorp.projects.locations.securityGateways.list
Path : v1/{+parent}/securityGateways
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/securityGateways
HTTP Method : GET
Parameters :
parent
Description : Required. The parent location to which the resources belong. `projects/{project_id}/locations/{location_id}/`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : 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.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. The next_page_token value returned from a previous ListSecurityGatewayRequest, if any.
Location : query
Type : string
filter
Description : Optional. A filter specifying constraints of a list operation. All fields in the SecurityGateway message are supported. For example, the following query will return the SecurityGateway with displayName "test-security-gateway" For more information, please refer to https://google.aip.dev/160.
Location : query
Type : string
orderBy
Description : Optional. Specifies the ordering of results. See [Sorting order](https://cloud.google.com/apis/design/design_patterns#sorting_order) for more information.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists SecurityGateways in a given project and location.
▼ ▲ beyondcorp.projects.locations.securityGateways.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}
HTTP Method : GET
Parameters :
name
Description : Required. The resource name of the PartnerTenant using the form: `projects/{project_id}/locations/{location_id}/securityGateway/{security_gateway_id}`
Pattern : ^projects/[^/]+/locations/[^/]+/securityGateways/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets details of a single SecurityGateway.
▼ ▲ beyondcorp.projects.locations.securityGateways.create
Path : v1/{+parent}/securityGateways
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/securityGateways
HTTP Method : POST
Parameters :
parent
Description : Required. The resource project name of the SecurityGateway location using the form: `projects/{project_id}/locations/{location_id}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
securityGatewayId
Description : Optional. User-settable SecurityGateway resource ID. * Must start with a letter. * Must contain between 4-63 characters from `/a-z-/`. * Must end with a number or letter.
Location : query
Type : string
requestId
Description : 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 request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a new SecurityGateway in a given project and location.
▼ ▲ beyondcorp.projects.locations.securityGateways.patch
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}
HTTP Method : PATCH
Parameters :
name
Description : Identifier. Name of the resource.
Pattern : ^projects/[^/]+/locations/[^/]+/securityGateways/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Required. Mutable fields include: display_name, hubs.
Location : query
Type : string
Format : google-fieldmask
requestId
Description : 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 timed 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).
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates the parameters of a single SecurityGateway.
▼ ▲ beyondcorp.projects.locations.securityGateways.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}
HTTP Method : DELETE
Parameters :
name
Description : Required. BeyondCorp SecurityGateway name using the form: `projects/{project_id}/locations/{location_id}/securityGateways/{security_gateway_id}`
Pattern : ^projects/[^/]+/locations/[^/]+/securityGateways/[^/]+$
Location : path
Required : Yes
Type : string
requestId
Description : 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).
Location : query
Type : string
validateOnly
Description : Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.
Location : query
Type : boolean
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a single SecurityGateway.
▼ ▲ beyondcorp.projects.locations.securityGateways.setPeering
Path : v1/{+securityGateway}:setPeering
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}:setPeering
HTTP Method : POST
Parameters :
securityGateway
Description : Required. BeyondCorp SecurityGateway name using the form: `projects/{project}/locations/{location}/securityGateways/{security_gateway}`
Pattern : ^projects/[^/]+/locations/[^/]+/securityGateways/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : securityGateway
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : This is a custom method to allow customers to create a peering connections between Google network and customer networks. This is enabled only for the allowlisted customers.
▼ ▲ beyondcorp.projects.locations.securityGateways.applications.list
Path : v1/{+parent}/applications
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}/applications
HTTP Method : GET
Parameters :
parent
Description : Required. The parent location to which the resources belong. `projects/{project_id}/locations/global/securityGateways/{security_gateway_id}`
Pattern : ^projects/[^/]+/locations/[^/]+/securityGateways/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : 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.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. The next_page_token value returned from a previous ListApplicationsRequest, if any.
Location : query
Type : string
filter
Description : Optional. A filter specifying constraints of a list operation. All fields in the Application message are supported. For example, the following query will return the Application with displayName "test-application" For more information, please refer to https://google.aip.dev/160.
Location : query
Type : string
orderBy
Description : Optional. Specifies the ordering of results. See [Sorting order](https://cloud.google.com/apis/design/design_patterns#sorting_order) for more information.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists Applications in a given project and location.
▼ ▲ beyondcorp.projects.locations.securityGateways.applications.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}/applications/{applicationsId}
HTTP Method : GET
Parameters :
name
Description : Required. The resource name of the Application using the form: `projects/{project_id}/locations/global/securityGateway/{security_gateway_id}/applications/{application_id}`
Pattern : ^projects/[^/]+/locations/[^/]+/securityGateways/[^/]+/applications/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets details of a single Application.
▼ ▲ beyondcorp.projects.locations.securityGateways.applications.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}/applications/{applicationsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. Name of the resource.
Pattern : ^projects/[^/]+/locations/[^/]+/securityGateways/[^/]+/applications/[^/]+$
Location : path
Required : Yes
Type : string
requestId
Description : 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).
Location : query
Type : string
validateOnly
Description : Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.
Location : query
Type : boolean
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a single Application.
▼ ▲ beyondcorp.projects.locations.global.securityGateways.applications.create
Path : v1/{+parent}/applications
Flat Path : v1/projects/{projectsId}/locations/global/securityGateways/{securityGatewaysId}/applications
HTTP Method : POST
Parameters :
parent
Description : Required. The resource name of the parent SecurityGateway using the form: `projects/{project_id}/locations/global/securityGateways/{security_gateway_id}`
Pattern : ^projects/[^/]+/locations/global/securityGateways/[^/]+$
Location : path
Required : Yes
Type : string
applicationId
Description : Optional. User-settable Application resource ID. * Must start with a letter. * Must contain between 4-63 characters from `/a-z-/`. * Must end with a number or letter.
Location : query
Type : string
requestId
Description : 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 request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a new Application in a given project and location.
▼ ▲ beyondcorp.projects.locations.global.securityGateways.applications.patch
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/global/securityGateways/{securityGatewaysId}/applications/{applicationsId}
HTTP Method : PATCH
Parameters :
name
Description : Identifier. Name of the resource.
Pattern : ^projects/[^/]+/locations/global/securityGateways/[^/]+/applications/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Required. Mutable fields include: display_name.
Location : query
Type : string
Format : google-fieldmask
requestId
Description : 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 timed 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).
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates the parameters of a single Application.