2024-03-06
▼ ▲ networksecurity.projects.locations.firewallEndpointAssociations.list
Path: v1/{+parent}/firewallEndpointAssociations
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/firewallEndpointAssociations
HTTP Method: GET
Parameters:
parent
Description: Required. Parent value for ListAssociationsRequest
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Location: query
Type: integer
Format: int32
pageToken
Description: A token identifying a page of results the server should return.
Location: query
Type: string
filter
Description: Optional. Filtering results
Location: query
Type: string
orderBy
Description: Hint for how to order the results
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists Associations in a given project and location.
▼ ▲ networksecurity.projects.locations.firewallEndpointAssociations.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/firewallEndpointAssociations/{firewallEndpointAssociationsId}
HTTP Method: GET
Parameters:
name
Description: Required. Name of the resource
Pattern: ^projects/[^/]+/locations/[^/]+/firewallEndpointAssociations/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets details of a single FirewallEndpointAssociation.
▼ ▲ networksecurity.projects.locations.firewallEndpointAssociations.create
Path: v1/{+parent}/firewallEndpointAssociations
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/firewallEndpointAssociations
HTTP Method: POST
Parameters:
parent
Description: Required. Value for parent.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
firewallEndpointAssociationId
Description: Optional. Id of the requesting object. If auto-generating Id server-side, remove this field and firewall_endpoint_association_id from the method_signature of Create RPC.
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 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).
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates a new FirewallEndpointAssociation in a given project and location.
▼ ▲ networksecurity.projects.locations.firewallEndpointAssociations.delete
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/firewallEndpointAssociations/{firewallEndpointAssociationsId}
HTTP Method: DELETE
Parameters:
name
Description: Required. Name of the resource
Pattern: ^projects/[^/]+/locations/[^/]+/firewallEndpointAssociations/[^/]+$
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
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a single FirewallEndpointAssociation.
▼ ▲ networksecurity.projects.locations.firewallEndpointAssociations.patch
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/firewallEndpointAssociations/{firewallEndpointAssociationsId}
HTTP Method: PATCH
Parameters:
name
Description: Immutable. Identifier. name of resource
Pattern: ^projects/[^/]+/locations/[^/]+/firewallEndpointAssociations/[^/]+$
Location: path
Required: Yes
Type: string
updateMask
Description: Required. Field mask is used to specify the fields to be overwritten in the Association resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
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 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).
Location: query
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Update a single FirewallEndpointAssociation.
▼ ▲ networksecurity.organizations.locations.firewallEndpoints.list
Path: v1/{+parent}/firewallEndpoints
Flat Path: v1/organizations/{organizationsId}/locations/{locationsId}/firewallEndpoints
HTTP Method: GET
Parameters:
parent
Description: Required. Parent value for ListEndpointsRequest
Pattern: ^organizations/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Location: query
Type: integer
Format: int32
pageToken
Description: A token identifying a page of results the server should return.
Location: query
Type: string
filter
Description: Optional. Filtering results
Location: query
Type: string
orderBy
Description: Hint for how to order the results
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists FirewallEndpoints in a given project and location.
▼ ▲ networksecurity.organizations.locations.firewallEndpoints.get
Path: v1/{+name}
Flat Path: v1/organizations/{organizationsId}/locations/{locationsId}/firewallEndpoints/{firewallEndpointsId}
HTTP Method: GET
Parameters:
name
Description: Required. Name of the resource
Pattern: ^organizations/[^/]+/locations/[^/]+/firewallEndpoints/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets details of a single Endpoint.
▼ ▲ networksecurity.organizations.locations.firewallEndpoints.create
Path: v1/{+parent}/firewallEndpoints
Flat Path: v1/organizations/{organizationsId}/locations/{locationsId}/firewallEndpoints
HTTP Method: POST
Parameters:
parent
Description: Required. Value for parent.
Pattern: ^organizations/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
firewallEndpointId
Description: Required. Id of the requesting object. If auto-generating Id server-side, remove this field and firewall_endpoint_id from the method_signature of Create RPC.
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 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).
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates a new FirewallEndpoint in a given project and location.
▼ ▲ networksecurity.organizations.locations.firewallEndpoints.delete
Path: v1/{+name}
Flat Path: v1/organizations/{organizationsId}/locations/{locationsId}/firewallEndpoints/{firewallEndpointsId}
HTTP Method: DELETE
Parameters:
name
Description: Required. Name of the resource
Pattern: ^organizations/[^/]+/locations/[^/]+/firewallEndpoints/[^/]+$
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
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a single Endpoint.
▼ ▲ networksecurity.organizations.locations.firewallEndpoints.patch
Path: v1/{+name}
Flat Path: v1/organizations/{organizationsId}/locations/{locationsId}/firewallEndpoints/{firewallEndpointsId}
HTTP Method: PATCH
Parameters:
name
Description: Immutable. Identifier. name of resource
Pattern: ^organizations/[^/]+/locations/[^/]+/firewallEndpoints/[^/]+$
Location: path
Required: Yes
Type: string
updateMask
Description: Required. Field mask is used to specify the fields to be overwritten in the Endpoint resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
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 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).
Location: query
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Update a single Endpoint.
▼ ▲ networksecurity.organizations.locations.securityProfileGroups.list
Path: v1/{+parent}/securityProfileGroups
Flat Path: v1/organizations/{organizationsId}/locations/{locationsId}/securityProfileGroups
HTTP Method: GET
Parameters:
parent
Description: Required. The project or organization and location from which the SecurityProfileGroups should be listed, specified in the format `projects|organizations/*/locations/{location}`.
Pattern: ^organizations/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Maximum number of SecurityProfileGroups to return per call.
Location: query
Type: integer
Format: int32
pageToken
Description: The value returned by the last `ListSecurityProfileGroupsResponse` Indicates that this is a continuation of a prior `ListSecurityProfileGroups` call, and that the system should return the next page of data.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists SecurityProfileGroups in a given organization and location.
▼ ▲ networksecurity.organizations.locations.securityProfileGroups.get
Path: v1/{+name}
Flat Path: v1/organizations/{organizationsId}/locations/{locationsId}/securityProfileGroups/{securityProfileGroupsId}
HTTP Method: GET
Parameters:
name
Description: Required. A name of the SecurityProfileGroup to get. Must be in the format `projects|organizations/*/locations/{location}/securityProfileGroups/{security_profile_group}`.
Pattern: ^organizations/[^/]+/locations/[^/]+/securityProfileGroups/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets details of a single SecurityProfileGroup.
▼ ▲ networksecurity.organizations.locations.securityProfileGroups.create
Path: v1/{+parent}/securityProfileGroups
Flat Path: v1/organizations/{organizationsId}/locations/{locationsId}/securityProfileGroups
HTTP Method: POST
Parameters:
parent
Description: Required. The parent resource of the SecurityProfileGroup. Must be in the format `projects|organizations/*/locations/{location}`.
Pattern: ^organizations/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
securityProfileGroupId
Description: Required. Short name of the SecurityProfileGroup resource to be created. This value should be 1-63 characters long, containing only letters, numbers, hyphens, and underscores, and should not start with a number. E.g. "security_profile_group1".
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates a new SecurityProfileGroup in a given organization and location.
▼ ▲ networksecurity.organizations.locations.securityProfileGroups.patch
Path: v1/{+name}
Flat Path: v1/organizations/{organizationsId}/locations/{locationsId}/securityProfileGroups/{securityProfileGroupsId}
HTTP Method: PATCH
Parameters:
name
Description: Immutable. Identifier. Name of the SecurityProfileGroup resource. It matches pattern `projects|organizations/*/locations/{location}/securityProfileGroups/{security_profile_group}`.
Pattern: ^organizations/[^/]+/locations/[^/]+/securityProfileGroups/[^/]+$
Location: path
Required: Yes
Type: string
updateMask
Description: Required. Field mask is used to specify the fields to be overwritten in the SecurityProfileGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask.
Location: query
Type: string
Format: google-fieldmask
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Updates the parameters of a single SecurityProfileGroup.
▼ ▲ networksecurity.organizations.locations.securityProfileGroups.delete
Path: v1/{+name}
Flat Path: v1/organizations/{organizationsId}/locations/{locationsId}/securityProfileGroups/{securityProfileGroupsId}
HTTP Method: DELETE
Parameters:
name
Description: Required. A name of the SecurityProfileGroup to delete. Must be in the format `projects|organizations/*/locations/{location}/securityProfileGroups/{security_profile_group}`.
Pattern: ^organizations/[^/]+/locations/[^/]+/securityProfileGroups/[^/]+$
Location: path
Required: Yes
Type: string
etag
Description: Optional. If client provided etag is out of date, delete will return FAILED_PRECONDITION error.
Location: query
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a single SecurityProfileGroup.
▼ ▲ networksecurity.organizations.locations.securityProfiles.list
Path: v1/{+parent}/securityProfiles
Flat Path: v1/organizations/{organizationsId}/locations/{locationsId}/securityProfiles
HTTP Method: GET
Parameters:
parent
Description: Required. The project or organization and location from which the SecurityProfiles should be listed, specified in the format `projects|organizations/*/locations/{location}`.
Pattern: ^organizations/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Maximum number of SecurityProfiles to return per call.
Location: query
Type: integer
Format: int32
pageToken
Description: The value returned by the last `ListSecurityProfilesResponse` Indicates that this is a continuation of a prior `ListSecurityProfiles` call, and that the system should return the next page of data.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists SecurityProfiles in a given organization and location.
▼ ▲ networksecurity.organizations.locations.securityProfiles.get
Path: v1/{+name}
Flat Path: v1/organizations/{organizationsId}/locations/{locationsId}/securityProfiles/{securityProfilesId}
HTTP Method: GET
Parameters:
name
Description: Required. A name of the SecurityProfile to get. Must be in the format `projects|organizations/*/locations/{location}/securityProfiles/{security_profile_id}`.
Pattern: ^organizations/[^/]+/locations/[^/]+/securityProfiles/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets details of a single SecurityProfile.
▼ ▲ networksecurity.organizations.locations.securityProfiles.create
Path: v1/{+parent}/securityProfiles
Flat Path: v1/organizations/{organizationsId}/locations/{locationsId}/securityProfiles
HTTP Method: POST
Parameters:
parent
Description: Required. The parent resource of the SecurityProfile. Must be in the format `projects|organizations/*/locations/{location}`.
Pattern: ^organizations/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
securityProfileId
Description: Required. Short name of the SecurityProfile resource to be created. This value should be 1-63 characters long, containing only letters, numbers, hyphens, and underscores, and should not start with a number. E.g. "security_profile1".
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates a new SecurityProfile in a given organization and location.
▼ ▲ networksecurity.organizations.locations.securityProfiles.patch
Path: v1/{+name}
Flat Path: v1/organizations/{organizationsId}/locations/{locationsId}/securityProfiles/{securityProfilesId}
HTTP Method: PATCH
Parameters:
name
Description: Immutable. Identifier. Name of the SecurityProfile resource. It matches pattern `projects|organizations/*/locations/{location}/securityProfiles/{security_profile}`.
Pattern: ^organizations/[^/]+/locations/[^/]+/securityProfiles/[^/]+$
Location: path
Required: Yes
Type: string
updateMask
Description: Required. Field mask is used to specify the fields to be overwritten in the SecurityProfile resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask.
Location: query
Type: string
Format: google-fieldmask
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Updates the parameters of a single SecurityProfile.
▼ ▲ networksecurity.organizations.locations.securityProfiles.delete
Path: v1/{+name}
Flat Path: v1/organizations/{organizationsId}/locations/{locationsId}/securityProfiles/{securityProfilesId}
HTTP Method: DELETE
Parameters:
name
Description: Required. A name of the SecurityProfile to delete. Must be in the format `projects|organizations/*/locations/{location}/securityProfiles/{security_profile_id}`.
Pattern: ^organizations/[^/]+/locations/[^/]+/securityProfiles/[^/]+$
Location: path
Required: Yes
Type: string
etag
Description: Optional. If client provided etag is out of date, delete will return FAILED_PRECONDITION error.
Location: query
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a single SecurityProfile.