endpoints

Creates, updates, deletes, gets or lists an endpoints resource.

Overview

Name	endpoints
Type	Resource
Id	google.ids.endpoints

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Output only. The name of the endpoint.
createTime	string (google-datetime)	Output only. The create time timestamp.
description	string	User-provided description of the endpoint
endpointForwardingRule	string	Output only. The fully qualified URL of the endpoint's ILB Forwarding Rule.
endpointIp	string	Output only. The IP address of the IDS Endpoint's ILB.
labels	object	The labels of the endpoint.
network	string	Required. The fully qualified URL of the network to which the IDS Endpoint is attached.
satisfiesPzi	boolean	Output only. [Output Only] Reserved for future use.
satisfiesPzs	boolean	Output only. [Output Only] Reserved for future use.
severity	string	Required. Lowest threat severity that this endpoint will alert on.
state	string	Output only. Current state of the endpoint.
threatExceptions	array	List of threat IDs to be excepted from generating alerts.
trafficLogs	boolean	Whether the endpoint should report traffic logs in addition to threat logs.
updateTime	string (google-datetime)	Output only. The update time timestamp.

list

Successful response

Name	Datatype	Description
name	string	Output only. The name of the endpoint.
createTime	string (google-datetime)	Output only. The create time timestamp.
description	string	User-provided description of the endpoint
endpointForwardingRule	string	Output only. The fully qualified URL of the endpoint's ILB Forwarding Rule.
endpointIp	string	Output only. The IP address of the IDS Endpoint's ILB.
labels	object	The labels of the endpoint.
network	string	Required. The fully qualified URL of the network to which the IDS Endpoint is attached.
satisfiesPzi	boolean	Output only. [Output Only] Reserved for future use.
satisfiesPzs	boolean	Output only. [Output Only] Reserved for future use.
severity	string	Required. Lowest threat severity that this endpoint will alert on.
state	string	Output only. Current state of the endpoint.
threatExceptions	array	List of threat IDs to be excepted from generating alerts.
trafficLogs	boolean	Whether the endpoint should report traffic logs in addition to threat logs.
updateTime	string (google-datetime)	Output only. The update time timestamp.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, endpointsId		Gets details of a single Endpoint.
list	select	projectsId, locationsId	pageSize, pageToken, filter, orderBy	Lists Endpoints in a given project and location.
create	insert	projectsId, locationsId	endpointId, requestId	Creates a new Endpoint in a given project and location.
patch	update	projectsId, locationsId, endpointsId	updateMask, requestId	Updates the parameters of a single Endpoint.
delete	delete	projectsId, locationsId, endpointsId	requestId	Deletes a single Endpoint.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
endpointsId	string
locationsId	string
projectsId	string
endpointId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
requestId	string
updateMask	string (google-fieldmask)

SELECT examples

get

Gets details of a single Endpoint.

SELECT
name,
createTime,
description,
endpointForwardingRule,
endpointIp,
labels,
network,
satisfiesPzi,
satisfiesPzs,
severity,
state,
threatExceptions,
trafficLogs,
updateTime
FROM google.ids.endpoints
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND endpointsId = '{{ endpointsId }}' -- required;

list

Lists Endpoints in a given project and location.

SELECT
name,
createTime,
description,
endpointForwardingRule,
endpointIp,
labels,
network,
satisfiesPzi,
satisfiesPzs,
severity,
state,
threatExceptions,
trafficLogs,
updateTime
FROM google.ids.endpoints
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';

INSERT examples

create

Creates a new Endpoint in a given project and location.

INSERT INTO google.ids.endpoints (
data__labels,
data__network,
data__description,
data__severity,
data__threatExceptions,
data__trafficLogs,
projectsId,
locationsId,
endpointId,
requestId
)
SELECT 
'{{ labels }}',
'{{ network }}',
'{{ description }}',
'{{ severity }}',
'{{ threatExceptions }}',
{{ trafficLogs }},
'{{ projectsId }}',
'{{ locationsId }}',
'{{ endpointId }}',
'{{ requestId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: endpoints
  props:
    - name: projectsId
      value: string
      description: Required parameter for the endpoints resource.
    - name: locationsId
      value: string
      description: Required parameter for the endpoints resource.
    - name: labels
      value: object
      description: >
        The labels of the endpoint.
        
    - name: network
      value: string
      description: >
        Required. The fully qualified URL of the network to which the IDS Endpoint is attached.
        
    - name: description
      value: string
      description: >
        User-provided description of the endpoint
        
    - name: severity
      value: string
      description: >
        Required. Lowest threat severity that this endpoint will alert on.
        
      valid_values: ['SEVERITY_UNSPECIFIED', 'INFORMATIONAL', 'LOW', 'MEDIUM', 'HIGH', 'CRITICAL']
    - name: threatExceptions
      value: array
      description: >
        List of threat IDs to be excepted from generating alerts.
        
    - name: trafficLogs
      value: boolean
      description: >
        Whether the endpoint should report traffic logs in addition to threat logs.
        
    - name: endpointId
      value: string
    - name: requestId
      value: string

UPDATE examples

patch

Updates the parameters of a single Endpoint.

UPDATE google.ids.endpoints
SET 
data__labels = '{{ labels }}',
data__network = '{{ network }}',
data__description = '{{ description }}',
data__severity = '{{ severity }}',
data__threatExceptions = '{{ threatExceptions }}',
data__trafficLogs = {{ trafficLogs }}
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND endpointsId = '{{ endpointsId }}' --required
AND updateMask = '{{ updateMask}}'
AND requestId = '{{ requestId}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Deletes a single Endpoint.

DELETE FROM google.ids.endpoints
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND endpointsId = '{{ endpointsId }}' --required
AND requestId = '{{ requestId }}';