alert.v1
Available Services
arista/alert.v1/alert.proto
Alert
Alert is the current status of the alert system
| Field Name | Type | Description |
|---|---|---|
| configuration_errors | ConfigErrors | configuration_errors contain any configuration errors reported by the backend |
| endpoint_errors | EndpointErrors | endpoint_errors contain any failed attempts to send alerts |
| last_modified_at | google.protobuf.Timestamp | last_modified_at is the time at which the configuration was last modified |
| last_modified_by | google.protobuf.StringValue | last_modified_by is the user who last modified the configuration |
AlertConfig
AlertConfig is the configuration for sending alerts
| Field Name | Type | Description |
|---|---|---|
| settings | Settings | settings is the global default settings for various endpoints used in broadcast groups. Can be overwritten in individual endpoint settings |
| rules | Rules | rules define how we route alerts to broadcast groups |
| broadcast_groups | BroadcastGroups | broadcast_groups are groups of endpoints that alerts are sent to |
AzureOAuth
AzureOAuth contains the settings for the sending of emails on Azure smtp server
| Field Name | Type | Description |
|---|---|---|
| client_id | google.protobuf.StringValue | client_id of the Azure environment |
| tenant_id | google.protobuf.StringValue | tenant_id of the Azure environment |
| client_secret | google.protobuf.StringValue | client_secret is a user generated secret key used for auth |
| auth_uri | google.protobuf.StringValue | auth_uri is the URI used for OAuth this should always be https://login.microsoftonline.com/ unless using a very custom set up, where the Azure enviroment is not running on microsoft servers |
| scopes | fmp.RepeatedString | scopes are the scopes that auth is granted for |
BroadcastGroup
BroadcastGroup is a series of endpoints that alerts are sent to if routed there by a rule No restriction on the number of types of endpoints that can be defined
| Field Name | Type | Description |
|---|---|---|
| EmailEndpoints | email is a set of email endpoints to send alerts to as part of this group | |
| webhook | WebhookEndpoints | webhook is a set of webhook endpoints to send alerts to as part of this group |
| slack | SlackEndpoints | slack is a set of slack endpoints to send alerts to as part of this group |
| opsgenie | OpsgenieEndpoints | opsgenie is a set of opsgenie endpoints to send alerts to as part of this group |
| pushover | PushoverEndpoints | pushover is a set of pushover endpoints to send alerts to as part of this group |
| pagerduty | PagerdutyEndpoints | pagerduty is a set of pagerduty endpoints to send alerts to as part of this group |
| victorops | VictorOpsEndpoints | victorops is a set of victorops endpoints to send alerts to as part of this group |
| gchat | GoogleChatEndpoints | gchat is a set of google chat endpoints to send alerts to as part of this group |
| msteams | MsTeamsEndpoints | msteams is a set of MS teams endpoints to send alerts to as part of this group |
| sendgrid | SendgridEndpoints | sendgrid is a set of sendgrid endpoints to send alerts to as part of this group |
| syslog | SyslogEndpoints | syslog is a set of syslog endpoints to send alerts to as part of this group |
| snmp | SNMPEndpoints | snmp is a set of snmp endpoints to send alerts to as part of this group |
| cue_syslog | CueSyslogEndpoints | cue_syslog is a set of cue syslog endpoints to send alerts to as part of this group |
| cue_snmp | CueSnmpEndpoints | cue_snmp is a set of cue snmp endpoints to send alerts to as part of this group |
| cue_sendgrid | CueSendgridEndpoints | cue_sendgrid is a set of cue sendgrid endpoints to send alerts to as part of this group |
| zoom | ZoomEndpoints | zoom is a set of zoom endpoints to send alerts to as part of this group |
| ms_graph_send_mail | MsGraphSendMailEndpoints | ms_graph_send_mail is a set of Microsoft Graph sendMail endpoints to send alerts to as part of this group |
BroadcastGroups
BroadcastGroups is a collection of named broadcast groups
| Field Name | Type | Description |
|---|---|---|
| values | BroadcastGroups.ValuesEntry[...] | values is a map of user defined ids to broadcast groups. No restrictions to naming applies |
BroadcastGroups.ValuesEntry
| Field Name | Type | Description |
|---|---|---|
| key | string | |
| value | BroadcastGroup |
ConfigError
ConfigError is an error caused by an invalid config being rejected by the backend
| Field Name | Type | Description |
|---|---|---|
| path | google.protobuf.StringValue | path is the 'path' to the invalid config element, eg: path.userPathName.email_configs[1].to = the 'to' field of the second email config of the 'userPathName' broadcast_group |
| error_type | ConfigErrorType | error_type is the type of error, this allows custom handling of different error types |
| error | google.protobuf.StringValue | error is a user-friendly error message |
ConfigErrors
ConfigErrors is a list of configuration-related errors
| Field Name | Type | Description |
|---|---|---|
| values | ConfigError[...] | values is a list of errors |
CueData
CueData contains additional cue-specific data
| Field Name | Type | Description |
|---|---|---|
| values | CueData.ValuesEntry[...] | values can contain some additional data which is required by the cue specific provider |
CueData.ValuesEntry
| Field Name | Type | Description |
|---|---|---|
| key | string | |
| value | string |
CueSNMPAuth
CueSNMPAuth is the authentication
| Field Name | Type | Description |
|---|---|---|
| community | google.protobuf.StringValue | community is the community string used for authentication in SNMPv1 and v2c required if version < 3 |
| username | google.protobuf.StringValue | username the username for SNMPv3 auth |
| security_level | SNMPSecurityLevel | security_level the security level for SNMPv3 |
| authentication_protocol | CueSNMPAuthProtocol | authentication_protocol is the protocol to use for authentication in SNMPv3 required for AUTH_NO_PRIV/AUTH_PRIV security levels |
| authentication_passphrase | google.protobuf.StringValue | authentication_passphrase is the passphrase to use for authentication in SNMPv3 required for AUTH_NO_PRIV/AUTH_PRIV security levels |
| privacy_protocol | CueSNMPPrivProtocol | privacy_protocol is the protocol to use for privacy in SNMPv3 required for AUTH_PRIV security level |
| privacy_passphrase | google.protobuf.StringValue | privacy_passphrase is the passphrase to use for privacy in SNMPv3 required for AUTH_PRIV security level |
CueSNMPEndpoint
CueSNMPEndpoint contains the required information for an alert to be sent to a cue SNMP endpoint
| Field Name | Type | Description |
|---|---|---|
| send_resolved | google.protobuf.BoolValue | send_resolved send alerts when events are resolved along with when they are triggered |
| settings_override | CueSNMPSettings | settings_override is the override for the cue snmp global endpoint settings |
CueSNMPSettings
CueSNMPSettings contain the settings for sending cue alerts with SNMP
| Field Name | Type | Description |
|---|---|---|
| target | google.protobuf.StringValue | target is an ipv4 address to send messages to |
| port | google.protobuf.Int32Value | port is the network port to target |
| transport | google.protobuf.StringValue | transport is the transport protocol to use ("udp" or "tcp"); if unset "udp" will be used |
| version | google.protobuf.Int32Value | version is the SNMP version, v2c and v3 are supported and can be set with 2 and 3 respectively |
| auth | CueSNMPAuth | auth is the optional authentication settings |
| data | CueData | data is additional data that maybe required for constructing the message or sending it |
CueSendgridEndpoint
CueSendgridEndpoint contains the required information for an alert to be sent to a cue sendgrid endpoint
| Field Name | Type | Description |
|---|---|---|
| send_resolved | google.protobuf.BoolValue | send_resolved send alerts when events are resolved along with when they are triggered |
| to | google.protobuf.StringValue | to address to send email to |
| http_override | HttpSettings | http_override is the override of the global http settings This overrides the value used in Settings message in the global alert config |
CueSendgridEndpoints
CueSendgridEndpoints is a set of cue sendgrid endpoints
| Field Name | Type | Description |
|---|---|---|
| values | CueSendgridEndpoint[...] | values are the elements of the set |
CueSendgridSettings
CueSendgridSettings contain the settings for sending cue alerts to sendgrid
| Field Name | Type | Description |
|---|---|---|
| api_key | google.protobuf.StringValue | api_key is the key used to connect to the sendgrid APIs |
| from | google.protobuf.StringValue | from is the sender's address in the email sent |
CueSnmpEndpoints
CueSnmpEndpoints is a set of cue SNMP endpoints
| Field Name | Type | Description |
|---|---|---|
| values | CueSNMPEndpoint[...] | values are the elements of the set |
CueSyslogEndpoint
CueSyslogEndpoint contains the required information for an alert to be sent to a cue syslog endpoint
| Field Name | Type | Description |
|---|---|---|
| send_resolved | google.protobuf.BoolValue | send_resolved send alerts when events are resolved along with when they are triggered |
| settings_override | CueSyslogSettings | settings_override is the override for the cue syslog global endpoint settings |
CueSyslogEndpoints
CueSyslogEndpoints is a set of cue syslog endpoints
| Field Name | Type | Description |
|---|---|---|
| values | CueSyslogEndpoint[...] | values are the elements of the set |
CueSyslogSettings
CueSyslogSettings contain the settings for sending alerts with syslog for cue
| Field Name | Type | Description |
|---|---|---|
| network | google.protobuf.StringValue | network is the network protocol to use, default is "udp", options also include: tcp,tcp4,tcp6,udp4,udp6 |
| address | google.protobuf.StringValue | address is the ip address to send syslog messages to |
| port | google.protobuf.Int32Value | port is server's port to connect to |
| message_format | CueSyslogMessageFormat | message_format defines the message format to use |
| append_bom_header | google.protobuf.BoolValue | append_bom_header if true a BOM( Byte Order Mark ) will be appended to the outgoing message BOM will tell the server that is receiving the messages, that the format is UTF8. |
| data | CueData | data is additional data that maybe required for constructing the message or sending it |
DefaultTemplate
DefaultTemplate is the system default template which is used when no user template has been set
| Field Name | Type | Description |
|---|---|---|
| key | TemplateKey | key identifies which template the configuration is for |
| template | google.protobuf.StringValue | template is the string template value to be used Templates need to be compatible with their respective parsers Message templates are read and parsed by https://golang.org/pkg/text/template/ Html templates are read and parsed by https://golang.org/pkg/html/template/ Templates must output valid JSON for certain templates Templates must not fail for any valid input |
| multi_alert | google.protobuf.BoolValue | multi_alert is true if this template uses a multiple alert context and false if a single alert context is used. |
| description | google.protobuf.StringValue | description is a description of the template. |
| external_documentation | google.protobuf.StringValue | external_documentation is a url to any relevant external documentation, or "" if there is no relevant documentation. |
| output_format | TemplateOutput | output_format is the expected output format of this template Any submitted template will be expected to output text with valid formatting for any input or may fail validation. |
| display_name | google.protobuf.StringValue | display_name is the name that can be displayed to the user for this particular template type |
EmailEndpoint
EmailEndpoint contains the required information for an alert to be sent to an email endpoint
| Field Name | Type | Description |
|---|---|---|
| send_resolved | google.protobuf.BoolValue | send_resolved send alerts when events are resolved along with when they are triggered |
| to | google.protobuf.StringValue | to address to send email to Email does not have a http override Email does not have a settings override |
EmailEndpoints
EmailEndpoints is a set of email endpoints
| Field Name | Type | Description |
|---|---|---|
| values | EmailEndpoint[...] | values are the elements of the set |
EmailSettings
EmailSettings contain the settings for the sending of emails
| Field Name | Type | Description |
|---|---|---|
| from | google.protobuf.StringValue | from is the email address to send from |
| smarthost | google.protobuf.StringValue | smarthost is the hostname and port of the SMTP server |
| auth_username | google.protobuf.StringValue | auth_username the username to use when sending emails required for all auth methods |
| auth_password | google.protobuf.StringValue | auth_password the password to use when sending emails |
| require_tls | google.protobuf.BoolValue | require_tls always use TLS connections when sending emails |
| single_alert_per_email | google.protobuf.BoolValue | single_alert_per_email configures the Alerter such that each alert generates a separate email notification, the email will only have a single notification, the format will also be different |
| azure_o_auth | AzureOAuth | azure_o_auth used for auth when using an Azure smtp server uses auth_username, scopes is not required as we use https://outlook.office365.com/.default |
EndpointError
EndpointError is an error caused by a failure to send alert(s) for any reason
| Field Name | Type | Description |
|---|---|---|
| endpoint_type | google.protobuf.StringValue | endpoint_type indicates the type of endpoint which failed, or unknown if not endpoint-specific (eg: slack, opsgenie) |
| broadcast_group_name | google.protobuf.StringValue | broadcast_group_name is the name of the broadcast group which was being used, empty string if not group specific |
| config_index | google.protobuf.Int32Value | config_index is the index of the config on the broadcast group or -1 if not applicable eg: if there are two email config in one broadcast group, then the indices for each are 0 and 1 note that these are done per type, so only counting email/slack/... |
| error_type | EndpointErrorType | error_type is the type of error, this allows custom handling of different error types |
| error | google.protobuf.StringValue | error is a user-friendly error message |
EndpointErrors
EndpointErrors is a set of errors related to sending of alerts
| Field Name | Type | Description |
|---|---|---|
| values | EndpointError[...] | values is the list of errors |
EventIdentifier
EventIdentifier consists of the minimal information required to uniquely match which event triggered an alert and due to which rule.
| Field Name | Type | Description |
|---|---|---|
| key | google.protobuf.StringValue | key is the event key. |
| time | google.protobuf.Timestamp | time is the time of event generation. |
| alerter_rule_index | google.protobuf.Int32Value | alerter_rule_index is the index of an alerter rule (don't confuse with generation rule) that was used to match the receiver and event. The rule index changes dynamically whenever a config change is issued. |
| firing | google.protobuf.BoolValue | firing is true if event is ongoing and false if event has finished. |
EventIdentifiers
EventIdentifiers is a list of EventIdentifier messages.
| Field Name | Type | Description |
|---|---|---|
| values | EventIdentifier[...] | values is a list of event identifiers. |
EventList
EventList is a list of event types
| Field Name | Type | Description |
|---|---|---|
| event_types | fmp.RepeatedString | event_types contain the event types |
GoogleChatEndpoint
GoogleChatEndpoint contains the required information for an alert to be sent to a google chat endpoint
| Field Name | Type | Description |
|---|---|---|
| send_resolved | google.protobuf.BoolValue | send_resolved send alerts when events are resolved along with when they are triggered |
| http_override | HttpSettings | http_override is the override of the global http settings |
| settings_override | GoogleChatSettings | settings_override is the override for the google chat global endpoint settings |
GoogleChatEndpoints
GoogleChatEndpoints is a set of googleChat endpoints
| Field Name | Type | Description |
|---|---|---|
| values | GoogleChatEndpoint[...] | values are the elements of the set |
GoogleChatSettings
GoogleChatSettings contain the settings for sending alerts to google chat
| Field Name | Type | Description |
|---|---|---|
| url | google.protobuf.StringValue | url is the url of the webhook to send alerts to |
HeaderValues
HeaderValues is a set of values for this header
| Field Name | Type | Description |
|---|---|---|
| values | string[...] | values is the header values |
HttpHeaders
HttpHeaders is a set of http headers
| Field Name | Type | Description |
|---|---|---|
| values | HttpHeaders.ValuesEntry[...] | values is a map of http header names to values |
HttpHeaders.ValuesEntry
| Field Name | Type | Description |
|---|---|---|
| key | string | |
| value | HeaderValues |
HttpSettings
HttpSettings are the settings to be used when sending various message over a http connection
| Field Name | Type | Description |
|---|---|---|
| username | google.protobuf.StringValue | username is the username to use when connecting to the http proxy |
| password | google.protobuf.StringValue | password is the password to use when connecting to the http proxy |
| proxy_url | google.protobuf.StringValue | proxy_url is the url for the http proxy |
| custom_headers | HttpHeaders | custom_headers is custom http headers to be used along with the default headers |
InhibitionSettings
InhibitionSettings allows certain event types to be suppressed while other event types are active
| Field Name | Type | Description |
|---|---|---|
| values | InhibitionSettings.ValuesEntry[...] | values is a map where the keys are event type which when active will suppress any events with event types in the related EventList |
InhibitionSettings.ValuesEntry
| Field Name | Type | Description |
|---|---|---|
| key | string | |
| value | EventList |
Matches
Matches is a set of restrictions that must be satisfied for a rule to be matched Empty fields are ignored for matching purposes. Condition contents are OR'd and then AND'd with the other criteria
| Field Name | Type | Description |
|---|---|---|
| severities | fmp.RepeatedString | severities is a list of severities to filter on, if an event does not have one of these severities, it will not match Valid values are DEBUG, INFO, WARNING, ERROR and CRITICAL |
| devices | fmp.RepeatedString | devices is a list of device IDs to filter on, if an event does not belong to one of these devices, it will not match |
| event_types | fmp.RepeatedString | event_types is a list of event types to filter on, if an event does not have one of these event types, it will not match |
| device_tags | google.protobuf.StringValue | device_tags is a string tag query that is used to match on the event's device tags |
| intf_tags | google.protobuf.StringValue | intf_tags is a string tag query that is used to match on the event's interface tags |
| rule_ids | fmp.RepeatedString | rule_ids is a list of rule IDs to filter on, if an event does not have one of these rule IDs, it will not match |
MsGraphSendMailEndpoint
MsGraphSendMailEndpoint contains the required information for an alert to be sent to the microsft graph send mail api
| Field Name | Type | Description |
|---|---|---|
| send_resolved | google.protobuf.BoolValue | send_resolved send alerts when events are resolved along with when they are triggered |
| to | google.protobuf.StringValue | to address to send email to |
| http_override | HttpSettings | http_override is the override of the global http settings |
| settings_override | MsGraphSendMailSettings | settings_override is the override for the microsoft graph send mail global endpoint settings |
MsGraphSendMailEndpoints
MsGraphSendMailEndpoints is a set of microsoft graph send mail endpoints
| Field Name | Type | Description |
|---|---|---|
| values | MsGraphSendMailEndpoint[...] | values are the elements of the set |
MsGraphSendMailSettings
MsGraphSendMailSettings contain the settings for sending alerts to a Microsoft Graph sendMail
| Field Name | Type | Description |
|---|---|---|
| single_alert_per_email | google.protobuf.BoolValue | single_alert_per_email configures the Alerter such that each alert generates a separate email notification, the email will only have a single notification, the format will also be different |
| azure_o_auth | AzureOAuth | azure_o_auth used for auth when using an Azure smtp server uses auth_username |
| user_principal_name | google.protobuf.StringValue | user_principal_name is the user used to send from |
MsTeamsEndpoint
MsTeamsEndpoint contains the required information for an alert to be sent to an ms teams endpoint
| Field Name | Type | Description |
|---|---|---|
| send_resolved | google.protobuf.BoolValue | send_resolved send alerts when events are resolved along with when they are triggered |
| http_override | HttpSettings | http_override is the override of the global http settings |
| settings_override | MsTeamsSettings | settings_override is the override for the microsoft teams global endpoint settings |
MsTeamsEndpoints
MsTeamsEndpoints is a set of ms teams endpoints
| Field Name | Type | Description |
|---|---|---|
| values | MsTeamsEndpoint[...] | values are the elements of the set |
MsTeamsSettings
MsTeamsSettings contain the settings for sending alerts to MS Teams
| Field Name | Type | Description |
|---|---|---|
| url | google.protobuf.StringValue | url is the url of the webhook to send alerts to |
OpsgenieEndpoint
OpsgenieEndpoint contains the required information for an alert to be sent to an opsgenie endpoint
| Field Name | Type | Description |
|---|---|---|
| send_resolved | google.protobuf.BoolValue | send_resolved send alerts when events are resolved along with when they are triggered |
| http_override | HttpSettings | http_override is the override of the global http settings |
| settings_override | OpsgenieSettings | settings_override is the override for the opsgenie global endpoint settings |
OpsgenieEndpoints
OpsgenieEndpoints is a set of opsgenie endpoints
| Field Name | Type | Description |
|---|---|---|
| values | OpsgenieEndpoint[...] | values are the elements of the set |
OpsgenieSettings
OpsgenieSettings contain the settings for sending alerts to opsgenie
| Field Name | Type | Description |
|---|---|---|
| key | google.protobuf.StringValue | key is the API key to use when talking to the OpsGenie API |
| url | google.protobuf.StringValue | url is the url to use when sending alerts to opsgenie |
PagerdutyEndpoint
PagerdutyEndpoint contains the required information for an alert to be sent to a pagerduty endpoint
| Field Name | Type | Description |
|---|---|---|
| send_resolved | google.protobuf.BoolValue | send_resolved send alerts when events are resolved along with when they are triggered |
| routing_key | google.protobuf.StringValue | routing_key is the routing key for sending pagerduty alerts |
| http_override | HttpSettings | http_override is the override of the global http settings |
| settings_override | PagerdutySettings | settings_override is the override for the pagerduty global endpoint settings |
PagerdutyEndpoints
PagerdutyEndpoints is a set of pagerduty endpoints
| Field Name | Type | Description |
|---|---|---|
| values | PagerdutyEndpoint[...] | values are the elements of the set |
PagerdutySettings
PagerdutySettings contain the settings for sending alerts to pagerduty
| Field Name | Type | Description |
|---|---|---|
| url | google.protobuf.StringValue | url is the url to use when sending alerts to pagerduty |
Priorities
Priorities is a mapping of CV event severities to syslog severities
| Field Name | Type | Description |
|---|---|---|
| critical | google.protobuf.Int32Value | critical priority, default = 2 (Critical) |
| error | google.protobuf.Int32Value | error priority, default = 3 (Error) |
| warn | google.protobuf.Int32Value | warn priority, default = 4 (Warning) |
| info | google.protobuf.Int32Value | info priority, default = 6 (Informational) |
PushoverEndpoint
PushoverEndpoint contains the required information for an alert to be sent to a pushover endpoint
| Field Name | Type | Description |
|---|---|---|
| send_resolved | google.protobuf.BoolValue | send_resolved send alerts when events are resolved along with when they are triggered |
| token | google.protobuf.StringValue | token is the user's registered application's API token, see https://pushover.net/apps |
| user_key | google.protobuf.StringValue | user_key is the user's user key |
| http_override | HttpSettings | http_override is the override of the global http settings Pushover does not have a settings override |
PushoverEndpoints
PushoverEndpoints is a set of pushover endpoints
| Field Name | Type | Description |
|---|---|---|
| values | PushoverEndpoint[...] | values are the elements of the set |
Rule
Rule is a rule to send to a certain broadcast group
| Field Name | Type | Description |
|---|---|---|
| sends_to | google.protobuf.StringValue | sends_to is the name of the broadcast group top send matching alerts to |
| match_criteria | Matches | match_criteria is the criteria that an alert must match to be sent to the broadcast group |
| continue_checks | google.protobuf.BoolValue | continue_checks if true, causes alerts matching this rule's criteria to continue checking against other rules, allowing for additional matches. If false, alerts matching this rule will not proceed with checking |
| comment | google.protobuf.StringValue | comment is a comment to include that will be displayed in the alert |
| suppress_for | google.protobuf.Duration | suppress_for is a time duration that a rule will be debounced for after being called |
Rules
Rules is a list of rules which dictates which events generate alerts for which broadcast groups
| Field Name | Type | Description |
|---|---|---|
| values | Rule[...] | values contains the rules |
SNMPAuth
SNMPAuth contain authentication information for SNMP
| Field Name | Type | Description |
|---|---|---|
| community | google.protobuf.StringValue | community is the community string used for authentication in SNMPv1 and v2c required if version < 3 |
| username | google.protobuf.StringValue | username the username for SNMPv3 auth |
| security_level | SNMPSecurityLevel | security_level the security level for SNMPv3 |
| authentication_protocol | SNMPAuthProtocol | authentication_protocol is the protocol to use for authentication in SNMPv3 required for AUTH_NO_PRIV/AUTH_PRIV security levels |
| authentication_passphrase | google.protobuf.StringValue | authentication_passphrase is the passphrase to use for authentication in SNMPv3 required for AUTH_NO_PRIV/AUTH_PRIV security levels |
| privacy_protocol | SNMPPrivProtocol | privacy_protocol is the protocol to use for privacy in SNMPv3 required for AUTH_PRIV security level |
| privacy_passphrase | google.protobuf.StringValue | privacy_passphrase is the passphrase to use for privacy in SNMPv3 required for AUTH_PRIV security level |
SNMPEndpoint
SNMPEndpoint contains the required information for an alert to be sent to an SNMP endpoint
| Field Name | Type | Description |
|---|---|---|
| send_resolved | google.protobuf.BoolValue | send_resolved send alerts when events are resolved along with when they are triggered |
| settings_override | SNMPSettings | settings_override is the override for the microsoft teams global endpoint settings |
SNMPEndpoints
SNMPEndpoints is a set of SNMP endpoints
| Field Name | Type | Description |
|---|---|---|
| values | SNMPEndpoint[...] | values are the elements of the set |
SNMPSettings
SNMPSettings contain the settings for sending alerts with SNMP
| Field Name | Type | Description |
|---|---|---|
| target | google.protobuf.StringValue | target is an ipv4 address to send messages to |
| port | google.protobuf.Int32Value | port is the network port to target |
| transport | google.protobuf.StringValue | transport is the transport protocol to use ("udp" or "tcp"); if unset "udp" will be used |
| version | google.protobuf.Int32Value | version is the SNMP version, v1, v2c and v3 are supported and can be set with 1, 2 and 3 respectively |
| auth | SNMPAuth | auth is optional authentication settings |
| engine_id | google.protobuf.StringValue | engine_id is the engine ID that will be used by the Alerter This should be a hexadecimal string, colon separators between bytes will be accepted when writing, but will be absent when reading optional: if excluded or left blank, this will be automatically generated |
SenderStatus
SenderStatus provides information about the status of particular send.
| Field Name | Type | Description |
|---|---|---|
| key | SenderStatusKey | key uniquely identifies the instance of sender status. |
| success | google.protobuf.BoolValue | success indicates whether the send succeeded or not. |
| config_index | google.protobuf.Int32Value | config_index is the index of the config on the broadcast group or -1 if not applicable e.g.: if there are two email configs in one broadcast group, then the indices for each are 0 and 1. Config indices are counted per type. |
| remaining_retries | google.protobuf.UInt32Value | remaining_retries is the number of remaining attempts to send a particular alert. |
| error_type | EndpointErrorType | error_type is the type of error. This allows custom handling of different error types. |
| error_message | google.protobuf.StringValue | error_message is a user-friendly error message. |
| events | EventIdentifiers | events is a list of events triggering the alert. |
SenderStatusKey
SenderStatusKey defines the unique key for SenderStatus.
| Field Name | Type | Description |
|---|---|---|
| broadcast_group_name | google.protobuf.StringValue | broadcast_group_name is the name of the broadcast group which was being used, empty string if not group specific. |
| endpoint_type | EndpointType | endpoint_type indicates the target to which an attempt to send an alert was made or is "unknown" if not endpoint-specific (eg: slack, opsgenie). |
SendgridEndpoint
SendgridEndpoint contains the required information for an alert to be sent to a sendgrid endpoint
| Field Name | Type | Description |
|---|---|---|
| send_resolved | google.protobuf.BoolValue | send_resolved send alerts when events are resolved along with when they are triggered |
| to | google.protobuf.StringValue | to address to send email to |
| http_override | HttpSettings | http_override is the override of the global http settings |
SendgridEndpoints
SendgridEndpoints is a set of sendgrid endpoints
| Field Name | Type | Description |
|---|---|---|
| values | SendgridEndpoint[...] | values are the elements of the set |
SendgridSettings
SendgridSettings contain the settings for sending emails via sendgrid
| Field Name | Type | Description |
|---|---|---|
| api_key | google.protobuf.StringValue | api_key is the api key to use |
| from | google.protobuf.StringValue | from is the email address to send from |
Settings
Settings portion of config, a list of default global settings used by broadcast groups
| Field Name | Type | Description |
|---|---|---|
| EmailSettings | email is the global default settings for email | |
| http | HttpSettings | http is the global default settings for http |
| slack | SlackSettings | slack is the global default settings for slack |
| victorops | VictoropsSettings | victorops is the global default settings for victorops |
| pagerduty | PagerdutySettings | pagerduty is the global default settings for pagerduty |
| opsgenie | OpsgenieSettings | opsgenie is the global default settings for opsgenie |
| gchat | GoogleChatSettings | gchat is the global default settings for google chat |
| msteams | MsTeamsSettings | msteams is the global default settings for ms teams |
| inhibition | InhibitionSettings | inhibition defines the inhibition rules for alerts, allowing events of certain types to be suppressed while another event type is active |
| base_url | google.protobuf.StringValue | base_url is the root address of your CloudVision app. Used to generate links in notifications. |
| timezone | google.protobuf.StringValue | timezone is used for formatting event times in notifications. E.g. 'UTC', 'US/Pacific' |
| syslog | SyslogSettings | syslog is the global default settings for syslog |
| snmp | SNMPSettings | snmp is the global default settings for snmp |
| sendgrid | SendgridSettings | sendgrid is the global default settings for sendgrid |
| cue_syslog | CueSyslogSettings | cue_syslog is the global default settings for cue syslog |
| cue_snmp | CueSNMPSettings | cue_snmp is the global default settings for cue snmp |
| cue_sendgrid | CueSendgridSettings | cue_sendgrid is the global default settings for cue sendgrid |
| hide_tags | google.protobuf.BoolValue | hide_tags is used to by the alerting system to omit tags and other "superfluous" values from the notifications that are sent out by the system |
| zoom | ZoomSettings | zoom is the global default settings for zoom |
| webhook | WebhookSettings | webhook is the auth settings for webhook |
| ms_graph_send_mail | MsGraphSendMailSettings | ms_graph_send_mail is the settings for Microsoft Graph sendMail |
SlackEndpoint
SlackEndpoint contains the required information for an alert to be sent to a slack endpoint
| Field Name | Type | Description |
|---|---|---|
| send_resolved | google.protobuf.BoolValue | send_resolved send alerts when events are resolved along with when they are triggered |
| http_override | HttpSettings | http_override is the override of the global http settings |
| settings_override | SlackSettings | settings_override is the override for the slack global endpoint settings |
SlackEndpoints
SlackEndpoints is a set of slack endpoints
| Field Name | Type | Description |
|---|---|---|
| values | SlackEndpoint[...] | values are the elements of the set |
SlackSettings
SlackSettings contain the settings for sending alerts to slack
| Field Name | Type | Description |
|---|---|---|
| url | google.protobuf.StringValue | url is the url of the slack webhook to use |
SyslogEndpoint
SyslogEndpoint contains the required information for an alert to be sent to a syslog endpoint
| Field Name | Type | Description |
|---|---|---|
| send_resolved | google.protobuf.BoolValue | send_resolved send alerts when events are resolved along with when they are triggered |
| settings_override | SyslogSettings | settings_override is the override for the microsoft teams global endpoint settings |
SyslogEndpoints
SyslogEndpoints is a set of syslog endpoints
| Field Name | Type | Description |
|---|---|---|
| values | SyslogEndpoint[...] | values are the elements of the set |
SyslogSettings
SyslogSettings contain the settings for sending alerts with syslog
| Field Name | Type | Description |
|---|---|---|
| network | google.protobuf.StringValue | network is the network protocol to use, default is "udp", options also include: tcp,tcp4,tcp6,udp4,udp6 |
| address | google.protobuf.StringValue | address is the network address to send syslog messages to |
| facility | google.protobuf.Int32Value | facility is the syslog facility 0-23 inc. This is the syslog facility as defined in RFC-3164 |
| priorities | Priorities | priorities describes how CVP severity maps to syslog priority priority is a number between 0-7 inc. as defined in RFC-3164 |
| tag | google.protobuf.StringValue | tag is the syslog TAG as described in RFC-3164, it is the prefix to all syslog messages |
| per_device | google.protobuf.BoolValue | per_device allows message to optionally be sent per device, if an event concerns two devices the behaviour is changed based on this option: true: two messages are sent, one for each device false: a single message is sent |
| use_tls | google.protobuf.BoolValue | use_tls determines if the connection to the server should be secured with TLS |
TemplateConfig
TemplateConfig represents a template configuration
| Field Name | Type | Description |
|---|---|---|
| key | TemplateKey | key identifies which template the configuration is for |
| template | google.protobuf.StringValue | template is the string template value to be used Templates need to be compatible with their respective parsers Message templates are read and parsed by https://golang.org/pkg/text/template/ Html templates are read and parsed by https://golang.org/pkg/html/template/ Templates must output valid JSON for certain templates Templates must not fail for any valid input |
TemplateKey
TemplateKey is used to identify templates for event notifications
| Field Name | Type | Description |
|---|---|---|
| template_type | TemplateType | template_type is the enum value to match with the template |
VictorOpsEndpoint
VictorOpsEndpoint contains the required information for an alert to be sent to a victorOps endpoint
| Field Name | Type | Description |
|---|---|---|
| send_resolved | google.protobuf.BoolValue | send_resolved send alerts when events are resolved along with when they are triggered |
| routing_key | google.protobuf.StringValue | routing_key is the PagerDuty integration key |
| http_override | HttpSettings | http_override is the override of the global http settings |
| settings_override | VictoropsSettings | settings_override is the override for the victorops global endpoint settings |
VictorOpsEndpoints
VictorOpsEndpoints is a set of victorOps endpoints
| Field Name | Type | Description |
|---|---|---|
| values | VictorOpsEndpoint[...] | values are the elements of the set |
VictoropsSettings
VictoropsSettings contain the settings for sending alerts to victorops
| Field Name | Type | Description |
|---|---|---|
| key | google.protobuf.StringValue | key is the API key to use when talking to the VictorOps API |
| url | google.protobuf.StringValue | url is the victorops url to use (without integration or routing key default: https://alert.victorops.com/integrations/generic/20131114/alert/ |
WebhookEndpoint
WebhookEndpoint contains the required information for an alert to be sent to a webhook endpoint
| Field Name | Type | Description |
|---|---|---|
| send_resolved | google.protobuf.BoolValue | send_resolved send alerts when events are resolved along with when they are triggered |
| url | google.protobuf.StringValue | url is the url |
| http_override | HttpSettings | http_override is the override of the global http settings |
| simple_output | google.protobuf.BoolValue | simple_output is a boolean flag to control the JSON structure of the webhook body. When false the output mimics the old alertmanager format. When true the output is a simple array of json objects which each represent an event. |
| single_alert | google.protobuf.BoolValue | single_alert is a boolean flag that will cause an individual webhook message to be sent per alert when true. |
| settings_override | WebhookSettings | settings_override is the override for the webhook global endpoint settings |
WebhookEndpoints
WebhookEndpoints is a set of webhook endpoints
| Field Name | Type | Description |
|---|---|---|
| values | WebhookEndpoint[...] | values are the elements of the set |
WebhookSettings
WebhookSettings contain the settings for sending alerts to a Webhook
| Field Name | Type | Description |
|---|---|---|
| azure_o_auth | AzureOAuth | azure_o_auth used for auth when using an Azure smtp server uses auth_username |
ZoomEndpoint
ZoomEndpoint contains the required information for an alert to be sent to a zoom endpoint
| Field Name | Type | Description |
|---|---|---|
| send_resolved | google.protobuf.BoolValue | send_resolved send alerts when events are resolved along with when they are triggered |
| http_override | HttpSettings | http_override is the override of the global http settings |
| settings_override | ZoomSettings | settings_override is the override for the zoom global endpoint settings |
ZoomEndpoints
ZoomEndpoints is a set of zoom endpoints
| Field Name | Type | Description |
|---|---|---|
| values | ZoomEndpoint[...] | values are the elements of the set |
ZoomSettings
ZoomSettings contain the settings for sending alerts to zoom
| Field Name | Type | Description |
|---|---|---|
| url | google.protobuf.StringValue | url is the zoom incoming webhook URL to send messages to |
| verification_token | google.protobuf.StringValue | verification_token is the verification token to authenticate with |
ConfigErrorType
ConfigErrorType describes the set of possible config error types
| Name | Number | Description |
|---|---|---|
| CONFIG_ERROR_TYPE_UNSPECIFIED | 0 | CONFIG_ERROR_TYPE_UNSPECIFIED is the unspecified enum value |
| CONFIG_ERROR_TYPE_INVALID_FORMAT | 2 | CONFIG_ERROR_TYPE_INVALID_FORMAT is caused by invalid format for value (eg: url) |
| CONFIG_ERROR_TYPE_INVALID_SYNTAX | 3 | CONFIG_ERROR_TYPE_INVALID_SYNTAX is caused by invalid syntax for value (eg: regex) |
| CONFIG_ERROR_TYPE_TEMPLATE_INVALID | 4 | CONFIG_ERROR_TYPE_TEMPLATE_INVALID is caused by failure to parse a template |
| CONFIG_ERROR_TYPE_ILLEGAL_VALUE | 5 | CONFIG_ERROR_TYPE_ILLEGAL_VALUE is caused by a value outside of its bounds |
| CONFIG_ERROR_TYPE_MISSING_REQUIRED | 6 | CONFIG_ERROR_TYPE_MISSING_REQUIRED is caused by a missing required attribute |
| CONFIG_ERROR_TYPE_INVALID_TYPE | 7 | CONFIG_ERROR_TYPE_INVALID_TYPE is caused by the wrong type found in backing store |
CueSNMPAuthProtocol
CueSNMPAuthProtocol represents the authentication protocol to be used
| Name | Number | Description |
|---|---|---|
| CUE_SNMP_AUTH_PROTOCOL_UNSPECIFIED | 0 | CUE_SNMP_AUTH_PROTOCOL_UNSPECIFIED is the unspecified enum value |
| CUE_SNMP_AUTH_PROTOCOL_MD5 | 1 | CUE_SNMP_AUTH_PROTOCOL_MD5 use the md5 protocol |
| CUE_SNMP_AUTH_PROTOCOL_SHA | 2 | CUE_SNMP_AUTH_PROTOCOL_SHA use the sha protocol |
CueSNMPPrivProtocol
CueSNMPPrivProtocol represents the privacy protocol to be used
| Name | Number | Description |
|---|---|---|
| CUE_SNMP_PRIV_PROTOCOL_UNSPECIFIED | 0 | CUE_SNMP_PRIV_PROTOCOL_UNSPECIFIED is the unspecified enum value |
| CUE_SNMP_PRIV_PROTOCOL_DES | 1 | CUE_SNMP_PRIV_PROTOCOL_DES use the des protocol |
| CUE_SNMP_PRIV_PROTOCOL_AES | 2 | CUE_SNMP_PRIV_PROTOCOL_AES use the aes protocol |
CueSyslogMessageFormat
CueSyslogMessageFormat is the message format for cue syslog messages
| Name | Number | Description |
|---|---|---|
| CUE_SYSLOG_MESSAGE_FORMAT_UNSPECIFIED | 0 | CUE_SYSLOG_MESSAGE_FORMAT_UNSPECIFIED is the unspecified enum value |
| CUE_SYSLOG_MESSAGE_FORMAT_PLAIN | 1 | CUE_SYSLOG_MESSAGE_FORMAT_PLAIN format uses the text format for constructing the syslog message |
| CUE_SYSLOG_MESSAGE_FORMAT_IDMEF | 2 | CUE_SYSLOG_MESSAGE_FORMAT_IDMEF uses IDMEF message format as described here: |
EndpointErrorType
EndpointErrorType describes the set of possible endpoint error types.
| Name | Number | Description |
|---|---|---|
| ENDPOINT_ERROR_TYPE_UNSPECIFIED | 0 | ENDPOINT_ERROR_TYPE_UNSPECIFIED is the unspecified enum value |
| ENDPOINT_ERROR_TYPE_HTTP_POST_ERROR | 1 | ENDPOINT_ERROR_TYPE_HTTP_POST_ERROR an error in sending HTTP request or reading a HTTP response |
| ENDPOINT_ERROR_TYPE_JSON_MARSHAL_ERROR | 2 | ENDPOINT_ERROR_TYPE_JSON_MARSHAL_ERROR is caused by errors while encoding json |
| ENDPOINT_ERROR_TYPE_INVALID_CONFIG_ERROR | 3 | ENDPOINT_ERROR_TYPE_INVALID_CONFIG_ERROR is an error caused by invalid config (missing, bad format, etc) |
| ENDPOINT_ERROR_TYPE_TEMPLATE_ERROR | 4 | ENDPOINT_ERROR_TYPE_TEMPLATE_ERROR is caused by errors while executing templates |
| ENDPOINT_ERROR_TYPE_BAD_RESPONSE_ERROR | 5 | ENDPOINT_ERROR_TYPE_BAD_RESPONSE_ERROR is caused by receiving a negative response from an endpoint indicating that the alert was not sent |
| ENDPOINT_ERROR_TYPE_SMTP_ERROR | 6 | ENDPOINT_ERROR_TYPE_SMTP_ERROR is caused by errors with SMTP |
| ENDPOINT_ERROR_TYPE_CONNECTION_ERROR | 7 | ENDPOINT_ERROR_TYPE_CONNECTION_ERROR is caused by errors with a connection |
| ENDPOINT_ERROR_TYPE_TIMEOUT_ERROR | 8 | ENDPOINT_ERROR_TYPE_TIMEOUT_ERROR is caused by errors with a connection |
| ENDPOINT_ERROR_TYPE_RATE_LIMIT_ERROR | 9 | ENDPOINT_ERROR_TYPE_RATE_LIMIT_ERROR is caused by an Alerter rate limit being exceeded |
| ENDPOINT_ERROR_TYPE_ALERT_CAP_ERROR | 10 | ENDPOINT_ERROR_TYPE_ALERT_CAP_ERROR is caused by the number of alerts sent to a sender exceeding the built-in limit |
| ENDPOINT_ERROR_TYPE_O_AUTH_ERROR | 11 | ENDPOINT_ERROR_TYPE_O_AUTH_ERROR is caused when we failed authenticating using the OAuth apis |
EndpointType
EndpointType describes the set of possible endpoint types.
| Name | Number | Description |
|---|---|---|
| ENDPOINT_TYPE_UNSPECIFIED | 0 | ENDPOINT_TYPE_UNSPECIFIED represents the unspecified enum value. |
| ENDPOINT_TYPE_EMAIL | 1 | ENDPOINT_TYPE_EMAIL represents the email endpoint type. |
| ENDPOINT_TYPE_SLACK | 2 | ENDPOINT_TYPE_SLACK represents the Slack endpoint type. |
| ENDPOINT_TYPE_VICTOROPS | 3 | ENDPOINT_TYPE_VICTOROPS represents the VictorOps endpoint type. |
| ENDPOINT_TYPE_PAGERDUTY | 4 | ENDPOINT_TYPE_PAGERDUTY represents the PagerDuty endpoint type. |
| ENDPOINT_TYPE_PUSHOVER | 5 | ENDPOINT_TYPE_PUSHOVER represents the Pushover endpoint type. |
| ENDPOINT_TYPE_OPSGENIE | 6 | ENDPOINT_TYPE_OPSGENIE represents the Opsgenie endpoint type. |
| ENDPOINT_TYPE_GOOGLE_CHAT | 7 | ENDPOINT_TYPE_GOOGLE_CHAT represents the Google Chat endpoint type. |
| ENDPOINT_TYPE_MICROSOFT_TEAMS | 8 | ENDPOINT_TYPE_MICROSOFT_TEAMS represents the Microsft Teams endpoint type. |
| ENDPOINT_TYPE_WEBHOOK | 9 | ENDPOINT_TYPE_WEBHOOK represents the Webhook endpoint type. |
| ENDPOINT_TYPE_SYSLOG | 10 | ENDPOINT_TYPE_SYSLOG represents the Syslog endpoint type. |
| ENDPOINT_TYPE_CUE_SYSLOG | 11 | ENDPOINT_TYPE_CUE_SYSLOG represents the Cue Syslog endpoint type. |
| ENDPOINT_TYPE_SENDGRID | 12 | ENDPOINT_TYPE_SENDGRID represents the Sendgrid endpoint type. |
| ENDPOINT_TYPE_CUE_SENDGRID | 13 | ENDPOINT_TYPE_CUE_SENDGRID represents the Cue Sendgrid endpoint type. |
| ENDPOINT_TYPE_SNMP | 14 | ENDPOINT_TYPE_SNMP represents the SNMP endpoint type. |
| ENDPOINT_TYPE_CUE_SNMP | 15 | ENDPOINT_TYPE_CUE_SNMP represents the Cue SNMP endpoint type. |
| ENDPOINT_TYPE_ZOOM | 16 | ENDPOINT_TYPE_ZOOM represents the Zoom endpoint type. |
| ENDPOINT_TYPE_MS_GRAPH_SEND_MAIL | 17 | ENDPOINT_TYPE_MS_GRAPH_SEND_MAIL represents the Microsoft Graph sendMail endpoint type. |
SNMPAuthProtocol
SNMPAuthProtocol represents the authentication protocol to be used
| Name | Number | Description |
|---|---|---|
| SNMP_AUTH_PROTOCOL_UNSPECIFIED | 0 | SNMP_AUTH_PROTOCOL_UNSPECIFIED is the unspecified enum value |
| SNMP_AUTH_PROTOCOL_MD5 | 1 | SNMP_AUTH_PROTOCOL_MD5 use the md5 protocol |
| SNMP_AUTH_PROTOCOL_SHA | 2 | SNMP_AUTH_PROTOCOL_SHA use the sha protocol |
| SNMP_AUTH_PROTOCOL_SHA_224 | 3 | SNMP_AUTH_PROTOCOL_SHA_224 use the sha224 protocol |
| SNMP_AUTH_PROTOCOL_SHA_256 | 4 | SNMP_AUTH_PROTOCOL_SHA_256 use the sha256 protocol |
| SNMP_AUTH_PROTOCOL_SHA_384 | 5 | SNMP_AUTH_PROTOCOL_SHA_384 use the sha384 protocol |
| SNMP_AUTH_PROTOCOL_SHA_512 | 6 | SNMP_AUTH_PROTOCOL_SHA_512 use the sha512 protocol |
SNMPPrivProtocol
SNMPPrivProtocol represents the privacy protocol to be used
| Name | Number | Description |
|---|---|---|
| SNMP_PRIV_PROTOCOL_UNSPECIFIED | 0 | SNMP_PRIV_PROTOCOL_UNSPECIFIED is the unspecified enum value |
| SNMP_PRIV_PROTOCOL_DES | 1 | SNMP_PRIV_PROTOCOL_DES use the des protocol |
| SNMP_PRIV_PROTOCOL_AES | 2 | SNMP_PRIV_PROTOCOL_AES use the aes protocol |
| SNMP_PRIV_PROTOCOL_AES_192 | 3 | SNMP_PRIV_PROTOCOL_AES_192 use the aes192 protocol |
| SNMP_PRIV_PROTOCOL_AES_256 | 4 | SNMP_PRIV_PROTOCOL_AES_256 use the aes256 protocol |
| SNMP_PRIV_PROTOCOL_AES_192C | 5 | SNMP_PRIV_PROTOCOL_AES_192C use the aes192c protocol |
| SNMP_PRIV_PROTOCOL_AES_256C | 6 | SNMP_PRIV_PROTOCOL_AES_256C use the aes256c protocol |
SNMPSecurityLevel
SNMPSecurityLevel indicates what level of security should be used
| Name | Number | Description |
|---|---|---|
| SNMP_SECURITY_LEVEL_UNSPECIFIED | 0 | SNMP_SECURITY_LEVEL_UNSPECIFIED is the unspecified enum value |
| SNMP_SECURITY_LEVEL_NO_AUTH_NO_PRIV | 1 | SNMP_SECURITY_LEVEL_NO_AUTH_NO_PRIV use no security |
| SNMP_SECURITY_LEVEL_AUTH_NO_PRIV | 2 | SNMP_SECURITY_LEVEL_AUTH_NO_PRIV use authentication without privacy |
| SNMP_SECURITY_LEVEL_AUTH_PRIV | 3 | SNMP_SECURITY_LEVEL_AUTH_PRIV use both authentication and privacy |
TemplateOutput
TemplateOutput is an enum of all of the possible output formats for templates
| Name | Number | Description |
|---|---|---|
| TEMPLATE_OUTPUT_UNSPECIFIED | 0 | TEMPLATE_OUTPUT_UNSPECIFIED is the unspecfied value. |
| TEMPLATE_OUTPUT_TEXT | 1 | TEMPLATE_OUTPUT_TEXT indicates the the template outputs plain text. |
| TEMPLATE_OUTPUT_JSON | 2 | TEMPLATE_OUTPUT_JSON indicates the the template outputs JSON. |
| TEMPLATE_OUTPUT_HTML | 3 | TEMPLATE_OUTPUT_HTML indicates the the template outputs HTML. This also indicates that "html/templates" will be used instead of "text/templates" so that html characters are automatically escaped from input. |
TemplateType
TemplateType describes the types of Templates that are usable
| Name | Number | Description |
|---|---|---|
| TEMPLATE_TYPE_UNSPECIFIED | 0 | TEMPLATE_TYPE_UNSPECIFIED is the unspecified enum value |
| TEMPLATE_TYPE_EMAIL_HTML | 1 | TEMPLATE_TYPE_EMAIL_HTML is the key of the html template for sent emails |
| TEMPLATE_TYPE_EMAIL_TEXT | 2 | TEMPLATE_TYPE_EMAIL_TEXT is the key of the text template for sent emails |
| TEMPLATE_TYPE_SLACK_MESSAGE | 3 | TEMPLATE_TYPE_SLACK_MESSAGE is the key of the message template for sent slack messages |
| TEMPLATE_TYPE_PUSHOVER_MESSAGE | 4 | TEMPLATE_TYPE_PUSHOVER_MESSAGE is the key of the message template for sent pushover messages |
| TEMPLATE_TYPE_PAGERDUTY_SUMMARY | 5 | TEMPLATE_TYPE_PAGERDUTY_SUMMARY is the key of the summary template for sent pagerduty messages |
| TEMPLATE_TYPE_VICTOROPS_DISPLAY_NAME | 6 | TEMPLATE_TYPE_VICTOROPS_DISPLAY_NAME is the key of the display name template for sent victorops messages |
| TEMPLATE_TYPE_VICTOROPS_STATE_MESSAGE | 7 | TEMPLATE_TYPE_VICTOROPS_STATE_MESSAGE is the key of the state message template for sent victorops messages |
| TEMPLATE_TYPE_GOOGLE_CHAT_MESSAGE | 8 | TEMPLATE_TYPE_GOOGLE_CHAT_MESSAGE is the key of the message template for sent Google chat messages |
| TEMPLATE_TYPE_MICROSOFT_TEAMS_MESSAGE | 9 | TEMPLATE_TYPE_MICROSOFT_TEAMS_MESSAGE is the key of the message template for sent Microsoft teams messages |
| TEMPLATE_TYPE_EMAIL_SUBJECT | 10 | TEMPLATE_TYPE_EMAIL_SUBJECT is the key of the subject line template of a sent email |
| TEMPLATE_TYPE_SYSLOG_MESSAGE | 11 | TEMPLATE_TYPE_SYSLOG_MESSAGE is the key of the message template for a syslog message part |
| TEMPLATE_TYPE_OPSGENIE_MESSAGE | 12 | TEMPLATE_TYPE_OPSGENIE_MESSAGE is the key of the message template for a opsgenie alert |
| TEMPLATE_TYPE_ZOOM_MESSAGE | 13 | TEMPLATE_TYPE_ZOOM_MESSAGE is the key of the message template for sent Zoom messages |
| TEMPLATE_TYPE_EMAIL_SINGLE_HTML | 14 | TEMPLATE_TYPE_EMAIL_SINGLE_HTML is the key of the html template for sent emails when the single alert per email option is selected |
| TEMPLATE_TYPE_EMAIL_SINGLE_TEXT | 15 | TEMPLATE_TYPE_EMAIL_SINGLE_TEXT is the key of the text template for sent emails when the single alert per email option is selected |
| TEMPLATE_TYPE_EMAIL_SINGLE_SUBJECT | 16 | TEMPLATE_TYPE_EMAIL_SINGLE_SUBJECT is the key of the subject line template of a sent email when the single alert per email option is selected |
| TEMPLATE_TYPE_WEBHOOK_SINGLE | 17 | TEMPLATE_TYPE_WEBHOOK_SINGLE is the key of the template for webhook message body when the single_alert option is true |
| TEMPLATE_TYPE_WEBHOOK_MULTIPLE | 18 | TEMPLATE_TYPE_WEBHOOK_MULTIPLE is the key of the template for webhook message body when the single_alert option is false |
arista/alert.v1/services.gen.proto
AlertConfigRequest
| Field Name | Type | Description |
|---|---|---|
| time | google.protobuf.Timestamp | Time indicates the time for which you are interested in the data. If no time is given, the server will use the time at which it makes the request. |
AlertConfigResponse
| Field Name | Type | Description |
|---|---|---|
| value | AlertConfig | Value is the value requested. This structure will be fully-populated as it exists in the datastore. If optional fields were not given at creation, these fields will be empty or set to default values. |
| time | google.protobuf.Timestamp | Time carries the (UTC) timestamp of the last-modification of the AlertConfig instance in this response. |
AlertConfigSetRequest
| Field Name | Type | Description |
|---|---|---|
| value | AlertConfig | AlertConfig carries the value to set into the datastore. See the documentation on the AlertConfig struct for which fields are required. |
AlertConfigSetResponse
| Field Name | Type | Description |
|---|---|---|
| value | AlertConfig | Value carries all the values given in the AlertConfigSetRequest as well as any server-generated values. |
| time | google.protobuf.Timestamp | Time indicates the (UTC) timestamp at which the system recognizes the creation. The only guarantees made about this timestamp are: - it is after the time the request was received - a time-ranged query with StartTime==CreatedAt will include this instance. |
AlertConfigStreamRequest
| Field Name | Type | Description |
|---|---|---|
| time | arista.time.TimeBounds | TimeRange allows limiting response data to within a specified time window. If this field is populated, at least one of the two time fields are required. For GetAll, the fields start and end can be used as follows: * end: Returns the state of each AlertConfig at end. * Each AlertConfig response is fully-specified (all fields set). * start: Returns the state of each AlertConfig at start, followed by updates until now. * Each AlertConfig response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each AlertConfig at start, followed by updates until end. * Each AlertConfig response at start is fully-specified, but updates until end may be partial. This field is not allowed in the Subscribe RPC. |
AlertConfigStreamResponse
| Field Name | Type | Description |
|---|---|---|
| value | AlertConfig | Value is a value deemed relevant to the initiating request. This structure will always have its key-field populated. Which other fields are populated, and why, depends on the value of Operation and what triggered this notification. |
| time | google.protobuf.Timestamp | Time holds the timestamp of this AlertConfig's last modification. |
| type | arista.subscriptions.Operation | Operation indicates how the AlertConfig value in this response should be considered. Under non-subscribe requests, this value should always be INITIAL. In a subscription, once all initial data is streamed and the client begins to receive modification updates, you should not see INITIAL again. |
AlertRequest
| Field Name | Type | Description |
|---|---|---|
| time | google.protobuf.Timestamp | Time indicates the time for which you are interested in the data. If no time is given, the server will use the time at which it makes the request. |
AlertResponse
| Field Name | Type | Description |
|---|---|---|
| value | Alert | Value is the value requested. This structure will be fully-populated as it exists in the datastore. If optional fields were not given at creation, these fields will be empty or set to default values. |
| time | google.protobuf.Timestamp | Time carries the (UTC) timestamp of the last-modification of the Alert instance in this response. |
AlertStreamRequest
| Field Name | Type | Description |
|---|---|---|
| time | arista.time.TimeBounds | TimeRange allows limiting response data to within a specified time window. If this field is populated, at least one of the two time fields are required. For GetAll, the fields start and end can be used as follows: * end: Returns the state of each Alert at end. * Each Alert response is fully-specified (all fields set). * start: Returns the state of each Alert at start, followed by updates until now. * Each Alert response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each Alert at start, followed by updates until end. * Each Alert response at start is fully-specified, but updates until end may be partial. This field is not allowed in the Subscribe RPC. |
AlertStreamResponse
| Field Name | Type | Description |
|---|---|---|
| value | Alert | Value is a value deemed relevant to the initiating request. This structure will always have its key-field populated. Which other fields are populated, and why, depends on the value of Operation and what triggered this notification. |
| time | google.protobuf.Timestamp | Time holds the timestamp of this Alert's last modification. |
| type | arista.subscriptions.Operation | Operation indicates how the Alert value in this response should be considered. Under non-subscribe requests, this value should always be INITIAL. In a subscription, once all initial data is streamed and the client begins to receive modification updates, you should not see INITIAL again. |
DefaultTemplateBatchedStreamRequest
| Field Name | Type | Description |
|---|---|---|
| time | arista.time.TimeBounds | TimeRange allows limiting response data to within a specified time window. If this field is populated, at least one of the two time fields are required. For GetAll, the fields start and end can be used as follows: * end: Returns the state of each DefaultTemplate at end. * Each DefaultTemplate response is fully-specified (all fields set). * start: Returns the state of each DefaultTemplate at start, followed by updates until now. * Each DefaultTemplate response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each DefaultTemplate at start, followed by updates until end. * Each DefaultTemplate response at start is fully-specified, but updates until end may be partial. This field is not allowed in the Subscribe RPC. |
| max_messages | google.protobuf.UInt32Value | MaxMessages limits the maximum number of messages that can be contained in one batch. MaxMessages is required to be at least 1. The maximum number of messages in a batch is min(max_messages, INTERNAL_BATCH_LIMIT) INTERNAL_BATCH_LIMIT is set based on the maximum message size. |
DefaultTemplateBatchedStreamResponse
| Field Name | Type | Description |
|---|---|---|
| responses | DefaultTemplateStreamResponse[...] | Values are the values deemed relevant to the initiating request. The length of this structure is guaranteed to be between (inclusive) 1 and min(req.max_messages, INTERNAL_BATCH_LIMIT). |
DefaultTemplateRequest
| Field Name | Type | Description |
|---|---|---|
| key | TemplateKey | Key uniquely identifies a DefaultTemplate instance to retrieve. This value must be populated. |
| time | google.protobuf.Timestamp | Time indicates the time for which you are interested in the data. If no time is given, the server will use the time at which it makes the request. |
DefaultTemplateResponse
| Field Name | Type | Description |
|---|---|---|
| value | DefaultTemplate | Value is the value requested. This structure will be fully-populated as it exists in the datastore. If optional fields were not given at creation, these fields will be empty or set to default values. |
| time | google.protobuf.Timestamp | Time carries the (UTC) timestamp of the last-modification of the DefaultTemplate instance in this response. |
DefaultTemplateSomeRequest
| Field Name | Type | Description |
|---|---|---|
| keys | TemplateKey[...] | |
| time | google.protobuf.Timestamp | Time indicates the time for which you are interested in the data. If no time is given, the server will use the time at which it makes the request. |
DefaultTemplateSomeResponse
| Field Name | Type | Description |
|---|---|---|
| value | DefaultTemplate | Value is the value requested. This structure will be fully-populated as it exists in the datastore. If optional fields were not given at creation, these fields will be empty or set to default values. |
| error | google.protobuf.StringValue | Error is an optional field. It should be filled when there is an error in the GetSome process. |
| time | google.protobuf.Timestamp |
DefaultTemplateStreamRequest
| Field Name | Type | Description |
|---|---|---|
| time | arista.time.TimeBounds | TimeRange allows limiting response data to within a specified time window. If this field is populated, at least one of the two time fields are required. For GetAll, the fields start and end can be used as follows: * end: Returns the state of each DefaultTemplate at end. * Each DefaultTemplate response is fully-specified (all fields set). * start: Returns the state of each DefaultTemplate at start, followed by updates until now. * Each DefaultTemplate response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each DefaultTemplate at start, followed by updates until end. * Each DefaultTemplate response at start is fully-specified, but updates until end may be partial. This field is not allowed in the Subscribe RPC. |
DefaultTemplateStreamResponse
| Field Name | Type | Description |
|---|---|---|
| value | DefaultTemplate | Value is a value deemed relevant to the initiating request. This structure will always have its key-field populated. Which other fields are populated, and why, depends on the value of Operation and what triggered this notification. |
| time | google.protobuf.Timestamp | Time holds the timestamp of this DefaultTemplate's last modification. |
| type | arista.subscriptions.Operation | Operation indicates how the DefaultTemplate value in this response should be considered. Under non-subscribe requests, this value should always be INITIAL. In a subscription, once all initial data is streamed and the client begins to receive modification updates, you should not see INITIAL again. |
MetaResponse
| Field Name | Type | Description |
|---|---|---|
| time | google.protobuf.Timestamp | Time holds the timestamp of the last item included in the metadata calculation. |
| type | arista.subscriptions.Operation | Operation indicates how the value in this response should be considered. Under non-subscribe requests, this value should always be INITIAL. In a subscription, once all initial data is streamed and the client begins to receive modification updates, you should not see INITIAL again. |
| count | google.protobuf.UInt32Value | Count is the number of items present under the conditions of the request. |
SenderStatusBatchedStreamRequest
| Field Name | Type | Description |
|---|---|---|
| partial_eq_filter | SenderStatus[...] | PartialEqFilter provides a way to server-side filter a GetAll/Subscribe. This requires all provided fields to be equal to the response. While transparent to users, this field also allows services to optimize internal subscriptions if filter(s) are sufficiently specific. |
| time | arista.time.TimeBounds | TimeRange allows limiting response data to within a specified time window. If this field is populated, at least one of the two time fields are required. For GetAll, the fields start and end can be used as follows: * end: Returns the state of each SenderStatus at end. * Each SenderStatus response is fully-specified (all fields set). * start: Returns the state of each SenderStatus at start, followed by updates until now. * Each SenderStatus response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each SenderStatus at start, followed by updates until end. * Each SenderStatus response at start is fully-specified, but updates until end may be partial. This field is not allowed in the Subscribe RPC. |
| max_messages | google.protobuf.UInt32Value | MaxMessages limits the maximum number of messages that can be contained in one batch. MaxMessages is required to be at least 1. The maximum number of messages in a batch is min(max_messages, INTERNAL_BATCH_LIMIT) INTERNAL_BATCH_LIMIT is set based on the maximum message size. |
SenderStatusBatchedStreamResponse
| Field Name | Type | Description |
|---|---|---|
| responses | SenderStatusStreamResponse[...] | Values are the values deemed relevant to the initiating request. The length of this structure is guaranteed to be between (inclusive) 1 and min(req.max_messages, INTERNAL_BATCH_LIMIT). |
SenderStatusRequest
| Field Name | Type | Description |
|---|---|---|
| key | SenderStatusKey | Key uniquely identifies a SenderStatus instance to retrieve. This value must be populated. |
| time | google.protobuf.Timestamp | Time indicates the time for which you are interested in the data. If no time is given, the server will use the time at which it makes the request. |
SenderStatusResponse
| Field Name | Type | Description |
|---|---|---|
| value | SenderStatus | Value is the value requested. This structure will be fully-populated as it exists in the datastore. If optional fields were not given at creation, these fields will be empty or set to default values. |
| time | google.protobuf.Timestamp | Time carries the (UTC) timestamp of the last-modification of the SenderStatus instance in this response. |
SenderStatusSomeRequest
| Field Name | Type | Description |
|---|---|---|
| keys | SenderStatusKey[...] | |
| time | google.protobuf.Timestamp | Time indicates the time for which you are interested in the data. If no time is given, the server will use the time at which it makes the request. |
SenderStatusSomeResponse
| Field Name | Type | Description |
|---|---|---|
| value | SenderStatus | Value is the value requested. This structure will be fully-populated as it exists in the datastore. If optional fields were not given at creation, these fields will be empty or set to default values. |
| error | google.protobuf.StringValue | Error is an optional field. It should be filled when there is an error in the GetSome process. |
| time | google.protobuf.Timestamp |
SenderStatusStreamRequest
| Field Name | Type | Description |
|---|---|---|
| partial_eq_filter | SenderStatus[...] | PartialEqFilter provides a way to server-side filter a GetAll/Subscribe. This requires all provided fields to be equal to the response. While transparent to users, this field also allows services to optimize internal subscriptions if filter(s) are sufficiently specific. |
| time | arista.time.TimeBounds | TimeRange allows limiting response data to within a specified time window. If this field is populated, at least one of the two time fields are required. For GetAll, the fields start and end can be used as follows: * end: Returns the state of each SenderStatus at end. * Each SenderStatus response is fully-specified (all fields set). * start: Returns the state of each SenderStatus at start, followed by updates until now. * Each SenderStatus response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each SenderStatus at start, followed by updates until end. * Each SenderStatus response at start is fully-specified, but updates until end may be partial. This field is not allowed in the Subscribe RPC. |
SenderStatusStreamResponse
| Field Name | Type | Description |
|---|---|---|
| value | SenderStatus | Value is a value deemed relevant to the initiating request. This structure will always have its key-field populated. Which other fields are populated, and why, depends on the value of Operation and what triggered this notification. |
| time | google.protobuf.Timestamp | Time holds the timestamp of this SenderStatus's last modification. |
| type | arista.subscriptions.Operation | Operation indicates how the SenderStatus value in this response should be considered. Under non-subscribe requests, this value should always be INITIAL. In a subscription, once all initial data is streamed and the client begins to receive modification updates, you should not see INITIAL again. |
TemplateConfigBatchedStreamRequest
| Field Name | Type | Description |
|---|---|---|
| time | arista.time.TimeBounds | TimeRange allows limiting response data to within a specified time window. If this field is populated, at least one of the two time fields are required. For GetAll, the fields start and end can be used as follows: * end: Returns the state of each TemplateConfig at end. * Each TemplateConfig response is fully-specified (all fields set). * start: Returns the state of each TemplateConfig at start, followed by updates until now. * Each TemplateConfig response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each TemplateConfig at start, followed by updates until end. * Each TemplateConfig response at start is fully-specified, but updates until end may be partial. This field is not allowed in the Subscribe RPC. |
| max_messages | google.protobuf.UInt32Value | MaxMessages limits the maximum number of messages that can be contained in one batch. MaxMessages is required to be at least 1. The maximum number of messages in a batch is min(max_messages, INTERNAL_BATCH_LIMIT) INTERNAL_BATCH_LIMIT is set based on the maximum message size. |
TemplateConfigBatchedStreamResponse
| Field Name | Type | Description |
|---|---|---|
| responses | TemplateConfigStreamResponse[...] | Values are the values deemed relevant to the initiating request. The length of this structure is guaranteed to be between (inclusive) 1 and min(req.max_messages, INTERNAL_BATCH_LIMIT). |
TemplateConfigDeleteAllRequest
TemplateConfigDeleteAllResponse
| Field Name | Type | Description |
|---|---|---|
| type | fmp.DeleteError | This describes the class of delete error. A DeleteAllResponse is only sent when there is an error. |
| error | google.protobuf.StringValue | This indicates the error message from the delete failure. |
| key | TemplateKey | This is the key of the TemplateConfig instance that failed to be deleted. |
| time | google.protobuf.Timestamp | Time indicates the (UTC) timestamp when the key was being deleted. |
TemplateConfigDeleteRequest
| Field Name | Type | Description |
|---|---|---|
| key | TemplateKey | Key indicates which TemplateConfig instance to remove. This field must always be set. |
TemplateConfigDeleteResponse
| Field Name | Type | Description |
|---|---|---|
| key | TemplateKey | Key echoes back the key of the deleted TemplateConfig instance. |
| time | google.protobuf.Timestamp | Time indicates the (UTC) timestamp at which the system recognizes the deletion. The only guarantees made about this timestamp are: - it is after the time the request was received - a time-ranged query with StartTime==DeletedAt will not include this instance. |
TemplateConfigDeleteSomeRequest
| Field Name | Type | Description |
|---|---|---|
| keys | TemplateKey[...] | key contains a list of TemplateConfig keys to delete |
TemplateConfigDeleteSomeResponse
TemplateConfigDeleteSomeResponse is only sent when there is an error.
| Field Name | Type | Description |
|---|---|---|
| key | TemplateKey | |
| error | string |
TemplateConfigRequest
| Field Name | Type | Description |
|---|---|---|
| key | TemplateKey | Key uniquely identifies a TemplateConfig instance to retrieve. This value must be populated. |
| time | google.protobuf.Timestamp | Time indicates the time for which you are interested in the data. If no time is given, the server will use the time at which it makes the request. |
TemplateConfigResponse
| Field Name | Type | Description |
|---|---|---|
| value | TemplateConfig | Value is the value requested. This structure will be fully-populated as it exists in the datastore. If optional fields were not given at creation, these fields will be empty or set to default values. |
| time | google.protobuf.Timestamp | Time carries the (UTC) timestamp of the last-modification of the TemplateConfig instance in this response. |
TemplateConfigSetRequest
| Field Name | Type | Description |
|---|---|---|
| value | TemplateConfig | TemplateConfig carries the value to set into the datastore. See the documentation on the TemplateConfig struct for which fields are required. |
TemplateConfigSetResponse
| Field Name | Type | Description |
|---|---|---|
| value | TemplateConfig | Value carries all the values given in the TemplateConfigSetRequest as well as any server-generated values. |
| time | google.protobuf.Timestamp | Time indicates the (UTC) timestamp at which the system recognizes the creation. The only guarantees made about this timestamp are: - it is after the time the request was received - a time-ranged query with StartTime==CreatedAt will include this instance. |
TemplateConfigSetSomeRequest
| Field Name | Type | Description |
|---|---|---|
| values | TemplateConfig[...] | value contains a list of TemplateConfig values to write. It is possible to provide more values than can fit within either: - the maxiumum send size of the client - the maximum receive size of the server If this error occurs you must reduce the number of values sent. See gRPC "maximum message size" documentation for more information. |
TemplateConfigSetSomeResponse
| Field Name | Type | Description |
|---|---|---|
| key | TemplateKey | |
| error | string |
TemplateConfigSomeRequest
| Field Name | Type | Description |
|---|---|---|
| keys | TemplateKey[...] | |
| time | google.protobuf.Timestamp | Time indicates the time for which you are interested in the data. If no time is given, the server will use the time at which it makes the request. |
TemplateConfigSomeResponse
| Field Name | Type | Description |
|---|---|---|
| value | TemplateConfig | Value is the value requested. This structure will be fully-populated as it exists in the datastore. If optional fields were not given at creation, these fields will be empty or set to default values. |
| error | google.protobuf.StringValue | Error is an optional field. It should be filled when there is an error in the GetSome process. |
| time | google.protobuf.Timestamp |
TemplateConfigStreamRequest
| Field Name | Type | Description |
|---|---|---|
| time | arista.time.TimeBounds | TimeRange allows limiting response data to within a specified time window. If this field is populated, at least one of the two time fields are required. For GetAll, the fields start and end can be used as follows: * end: Returns the state of each TemplateConfig at end. * Each TemplateConfig response is fully-specified (all fields set). * start: Returns the state of each TemplateConfig at start, followed by updates until now. * Each TemplateConfig response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each TemplateConfig at start, followed by updates until end. * Each TemplateConfig response at start is fully-specified, but updates until end may be partial. This field is not allowed in the Subscribe RPC. |
TemplateConfigStreamResponse
| Field Name | Type | Description |
|---|---|---|
| value | TemplateConfig | Value is a value deemed relevant to the initiating request. This structure will always have its key-field populated. Which other fields are populated, and why, depends on the value of Operation and what triggered this notification. |
| time | google.protobuf.Timestamp | Time holds the timestamp of this TemplateConfig's last modification. |
| type | arista.subscriptions.Operation | Operation indicates how the TemplateConfig value in this response should be considered. Under non-subscribe requests, this value should always be INITIAL. In a subscription, once all initial data is streamed and the client begins to receive modification updates, you should not see INITIAL again. |
AlertConfigService
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| GetOne | AlertConfigRequest | AlertConfigResponse | |
| GetAll | AlertConfigStreamRequest | AlertConfigStreamResponse stream | |
| Subscribe | AlertConfigStreamRequest | AlertConfigStreamResponse stream | |
| SubscribeMeta | AlertConfigStreamRequest | MetaResponse stream | |
| Set | AlertConfigSetRequest | AlertConfigSetResponse |
AlertService
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| GetOne | AlertRequest | AlertResponse | |
| GetAll | AlertStreamRequest | AlertStreamResponse stream | |
| Subscribe | AlertStreamRequest | AlertStreamResponse stream | |
| SubscribeMeta | AlertStreamRequest | MetaResponse stream |
DefaultTemplateService
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| GetOne | DefaultTemplateRequest | DefaultTemplateResponse | |
| GetSome | DefaultTemplateSomeRequest | DefaultTemplateSomeResponse stream | |
| GetAll | DefaultTemplateStreamRequest | DefaultTemplateStreamResponse stream | |
| Subscribe | DefaultTemplateStreamRequest | DefaultTemplateStreamResponse stream | |
| GetMeta | DefaultTemplateStreamRequest | MetaResponse | |
| SubscribeMeta | DefaultTemplateStreamRequest | MetaResponse stream | |
| GetAllBatched | DefaultTemplateBatchedStreamRequest | DefaultTemplateBatchedStreamResponse stream | |
| SubscribeBatched | DefaultTemplateBatchedStreamRequest | DefaultTemplateBatchedStreamResponse stream |
SenderStatusService
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| GetOne | SenderStatusRequest | SenderStatusResponse | |
| GetSome | SenderStatusSomeRequest | SenderStatusSomeResponse stream | |
| GetAll | SenderStatusStreamRequest | SenderStatusStreamResponse stream | |
| Subscribe | SenderStatusStreamRequest | SenderStatusStreamResponse stream | |
| GetMeta | SenderStatusStreamRequest | MetaResponse | |
| SubscribeMeta | SenderStatusStreamRequest | MetaResponse stream | |
| GetAllBatched | SenderStatusBatchedStreamRequest | SenderStatusBatchedStreamResponse stream | |
| SubscribeBatched | SenderStatusBatchedStreamRequest | SenderStatusBatchedStreamResponse stream |
TemplateConfigService
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| GetOne | TemplateConfigRequest | TemplateConfigResponse | |
| GetSome | TemplateConfigSomeRequest | TemplateConfigSomeResponse stream | |
| GetAll | TemplateConfigStreamRequest | TemplateConfigStreamResponse stream | |
| Subscribe | TemplateConfigStreamRequest | TemplateConfigStreamResponse stream | |
| GetMeta | TemplateConfigStreamRequest | MetaResponse | |
| SubscribeMeta | TemplateConfigStreamRequest | MetaResponse stream | |
| Set | TemplateConfigSetRequest | TemplateConfigSetResponse | |
| SetSome | TemplateConfigSetSomeRequest | TemplateConfigSetSomeResponse stream | |
| Delete | TemplateConfigDeleteRequest | TemplateConfigDeleteResponse | |
| DeleteSome | TemplateConfigDeleteSomeRequest | TemplateConfigDeleteSomeResponse stream | |
| DeleteAll | TemplateConfigDeleteAllRequest | TemplateConfigDeleteAllResponse stream | |
| GetAllBatched | TemplateConfigBatchedStreamRequest | TemplateConfigBatchedStreamResponse stream | |
| SubscribeBatched | TemplateConfigBatchedStreamRequest | TemplateConfigBatchedStreamResponse stream |