ilert

package module
v3.7.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 6, 2024 License: Apache-2.0 Imports: 9 Imported by: 0

README

ilert-go

The official ilert Go api bindings.

Create an alert (manually)

package main

import (
	"log"
	"github.com/iLert/ilert-go/v3"
)

func main() {

	// We strongly recommend to enable a retry logic if an error occurs
	var apiToken = "your API token"
	client := ilert.NewClient(ilert.WithRetry(10, 5*time.Second, 20*time.Second), ilert.WithAPIToken(apiToken))

	var apiKey = "alert source API Key"
	event := &ilert.Event{
		APIKey:      apiKey,
		EventType:   ilert.EventTypes.Alert,
		Summary:     "My test alert summary",
		AlertKey: "123456",
	}

	input := &ilert.CreateEventInput{Event: event}
	result, err := client.CreateEvent(input)
	if err != nil {
		log.Println(result)
		log.Fatalln("ERROR:", err)
	}

	log.Println("Event processed!")
}

Ping heartbeat

package main

import (
	"log"
	"github.com/iLert/ilert-go/v3"
)

func main() {
	var apiKey = "heartbeat API Key"
	var apiToken = "your API token"
	client := ilert.NewClient(ilert.WithAPIToken(apiToken))

	result, err := client.PingHeartbeat(&ilert.PingHeartbeatInput{
		APIKey: ilert.String(apiKey),
		Method: ilert.String(ilert.HeartbeatMethods.HEAD),
	})
	if err != nil {
		log.Println(result)
		log.Fatalln("ERROR:", err)
	}
	log.Println("Heartbeat is ok!")
}

Using proxy

package main

import (
	"log"
	"github.com/iLert/ilert-go/v3"
)

func main() {
	var apiToken = "your API token"
	client := ilert.NewClient(ilert.WithProxy("http://proxyserver:8888"), ilert.WithAPIToken(apiToken))
	...
}

Versions overview

If you want to use older legacy versions of ilert-go, you can access previous major versions using one of the commands below.

Version Description Command
> 3.0.0 API user preference migration - changes go get github.com/iLert/ilert-go/v3
2.0.0 - 2.6.0 API versionless - changes go get github.com/iLert/ilert-go/v2
1.0.0 - 1.6.5 API v1 - basic legacy resources go get github.com/iLert/ilert-go

Getting help

We are happy to respond to GitHub issues as well.


License
Licensed under Apache License, Version 2.0
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in ilert-go by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Documentation

Index

Constants

View Source
const Version = "v3.7.1"

Version package version

Variables

View Source
var AlertActionTriggerModes = struct {
	Automatic string
	Manual    string
}{
	Automatic: "AUTOMATIC",
	Manual:    "MANUAL",
}

AlertActionTriggerModes defines alertAction trigger modes

View Source
var AlertActionTriggerModesAll = []string{
	AlertActionTriggerModes.Automatic,
	AlertActionTriggerModes.Manual,
}

AlertActionTriggerModesAll defines alertAction trigger modes list

View Source
var AlertActionTriggerTypes = struct {
	AlertCreated          string
	AlertAssigned         string
	AlertAutoEscalated    string
	AlertAcknowledged     string
	AlertRaised           string
	AlertCommentAdded     string
	AlertEscalationEnded  string
	AlertResolved         string
	AlertAutoResolved     string
	AlertResponderAdded   string
	AlertResponderRemoved string
	AlertChannelAttached  string
	AlertChannelDetached  string
}{
	AlertCreated:          "alert-created",
	AlertAssigned:         "alert-assigned",
	AlertAutoEscalated:    "alert-auto-escalated",
	AlertAcknowledged:     "alert-acknowledged",
	AlertRaised:           "alert-raised",
	AlertCommentAdded:     "alert-comment-added",
	AlertEscalationEnded:  "alert-escalation-ended",
	AlertResolved:         "alert-resolved",
	AlertAutoResolved:     "alert-auto-resolved",
	AlertResponderAdded:   "alert-responder-added",
	AlertResponderRemoved: "alert-responder-removed",
	AlertChannelAttached:  "alert-channel-attached",
	AlertChannelDetached:  "alert-channel-detached",
}

AlertActionTriggerTypes defines alertAction trigger types

View Source
var AlertActionTriggerTypesAll = []string{
	AlertActionTriggerTypes.AlertCreated,
	AlertActionTriggerTypes.AlertAssigned,
	AlertActionTriggerTypes.AlertAutoEscalated,
	AlertActionTriggerTypes.AlertAcknowledged,
	AlertActionTriggerTypes.AlertRaised,
	AlertActionTriggerTypes.AlertCommentAdded,
	AlertActionTriggerTypes.AlertEscalationEnded,
	AlertActionTriggerTypes.AlertResolved,
	AlertActionTriggerTypes.AlertAutoResolved,
	AlertActionTriggerTypes.AlertResponderAdded,
	AlertActionTriggerTypes.AlertResponderRemoved,
	AlertActionTriggerTypes.AlertChannelAttached,
	AlertActionTriggerTypes.AlertChannelDetached,
}

AlertActionTriggerTypesAll defines all alertAction trigger types

View Source
var AlertFilterOperator = struct {
	And string
	Or  string
}{
	And: "AND",
	Or:  "OR",
}

AlertFilterOperator defines alertFilter operator

View Source
var AlertFilterOperatorAll = []string{
	AlertFilterOperator.And,
	AlertFilterOperator.Or,
}

AlertFilterOperatorAll defines all alertFilter operator

View Source
var AlertFilterPredicateCriteria = struct {
	ContainsAnyWords  string
	ContainsNotWords  string
	ContainsString    string
	ContainsNotString string
	IsString          string
	IsNotString       string
	MatchesRegex      string
	MatchesNotRegex   string
}{
	ContainsAnyWords:  "CONTAINS_ANY_WORDS",
	ContainsNotWords:  "CONTAINS_NOT_WORDS",
	ContainsString:    "CONTAINS_STRING",
	ContainsNotString: "CONTAINS_NOT_STRING",
	IsString:          "IS_STRING",
	IsNotString:       "IS_NOT_STRING",
	MatchesRegex:      "MATCHES_REGEX",
	MatchesNotRegex:   "MATCHES_NOT_REGEX",
}

AlertFilterPredicateCriteria defines alertFilter predicate criteria

View Source
var AlertFilterPredicateCriteriaAll = []string{
	AlertFilterPredicateCriteria.ContainsAnyWords,
	AlertFilterPredicateCriteria.ContainsNotWords,
	AlertFilterPredicateCriteria.ContainsString,
	AlertFilterPredicateCriteria.ContainsNotString,
	AlertFilterPredicateCriteria.IsString,
	AlertFilterPredicateCriteria.IsNotString,
	AlertFilterPredicateCriteria.MatchesRegex,
	AlertFilterPredicateCriteria.MatchesNotRegex,
}

AlertFilterPredicateCriteriaAll defines all alertFilter predicate criteria

View Source
var AlertFilterPredicateFields = struct {
	AlertSummary     string
	AlertDetails     string
	EscalationPolicy string
	AlertPriority    string
}{
	AlertSummary:     "ALERT_SUMMARY",
	AlertDetails:     "ALERT_DETAILS",
	EscalationPolicy: "ESCALATION_POLICY",
	AlertPriority:    "ALERT_PRIORITY",
}

AlertFilterPredicateFields defines alertFilter predicate fields

View Source
var AlertFilterPredicateFieldsAll = []string{
	AlertFilterPredicateFields.AlertSummary,
	AlertFilterPredicateFields.AlertDetails,
	AlertFilterPredicateFields.EscalationPolicy,
	AlertFilterPredicateFields.AlertPriority,
}

AlertFilterPredicateFieldsAll defines all alertFilter predicate fields

View Source
var AlertInclude = struct {
	EscalationRules    string
	NextEscalationUser string
}{
	EscalationRules:    "escalationRules",
	NextEscalationUser: "nextEscalationUser",
}
View Source
var AlertLogEntryTypes = struct {
	AlertReceivedLogEntry         string
	AlertSourceResponseLogEntry   string
	EmailReceivedLogEntry         string
	AlertAssignedBySystemLogEntry string
	AlertAssignedByUserLogEntry   string
	AlertCreatedByUserLogEntry    string
	NotificationLogEntry          string
	UserResponseLogEntry          string
}{
	AlertReceivedLogEntry:         "AlertReceivedLogEntry",
	AlertSourceResponseLogEntry:   "AlertSourceResponseLogEntry",
	EmailReceivedLogEntry:         "EmailReceivedLogEntry",
	AlertAssignedBySystemLogEntry: "AlertAssignedBySystemLogEntry",
	AlertAssignedByUserLogEntry:   "AlertAssignedByUserLogEntry",
	AlertCreatedByUserLogEntry:    "AlertCreatedByUserLogEntry",
	NotificationLogEntry:          "NotificationLogEntry",
	UserResponseLogEntry:          "UserResponseLogEntry",
}

AlertLogEntryTypes defines alert log entry types

View Source
var AlertPriorities = struct {
	High string
	Low  string
}{
	High: "HIGH",
	Low:  "LOW",
}

AlertPriorities defines alert priorities

View Source
var AlertPrioritiesAll = []string{
	AlertPriorities.High,
	AlertPriorities.Low,
}

AlertPrioritiesAll defines alert priorities list

View Source
var AlertResponderGroups = struct {
	Suggested        string
	User             string
	EscalationPolicy string
	OnCallSchedule   string
}{
	Suggested:        "SUGGESTED",
	User:             "USER",
	EscalationPolicy: "ESCALATION_POLICY",
	OnCallSchedule:   "ON_CALL_SCHEDULE",
}

AlertResponderGroups defines alert responder groups

View Source
var AlertResponderTypes = struct {
	User        string
	AlertSource string
}{
	User:        "USER",
	AlertSource: "SOURCE",
}

AlertResponderTypes defines alert responder types

View Source
var AlertSourceAlertCreations = struct {
	// @deprecated
	OneIncidentPerEmail        string
	OneIncidentPerEmailSubject string
	OnePendingIncidentAllowed  string
	OneOpenIncidentAllowed     string

	OneAlertPerEmail         string
	OneAlertPerEmailSubject  string
	OnePendingAlertAllowed   string
	OneOpenAlertAllowed      string
	OpenResolveOnExtraction  string
	OneAlertGroupedPerWindow string
}{

	OneIncidentPerEmail:        "ONE_INCIDENT_PER_EMAIL",
	OneIncidentPerEmailSubject: "ONE_INCIDENT_PER_EMAIL_SUBJECT",
	OnePendingIncidentAllowed:  "ONE_PENDING_INCIDENT_ALLOWED",
	OneOpenIncidentAllowed:     "ONE_OPEN_INCIDENT_ALLOWED",

	OneAlertPerEmail:         "ONE_ALERT_PER_EMAIL",
	OneAlertPerEmailSubject:  "ONE_ALERT_PER_EMAIL_SUBJECT",
	OnePendingAlertAllowed:   "ONE_PENDING_ALERT_ALLOWED",
	OneOpenAlertAllowed:      "ONE_OPEN_ALERT_ALLOWED",
	OpenResolveOnExtraction:  "OPEN_RESOLVE_ON_EXTRACTION",
	OneAlertGroupedPerWindow: "ONE_ALERT_GROUPED_PER_WINDOW",
}

AlertSourceAlertCreations defines alert source alert creations

View Source
var AlertSourceAlertCreationsAll = []string{

	AlertSourceAlertCreations.OneIncidentPerEmail,
	AlertSourceAlertCreations.OneIncidentPerEmailSubject,
	AlertSourceAlertCreations.OnePendingIncidentAllowed,
	AlertSourceAlertCreations.OneOpenIncidentAllowed,

	AlertSourceAlertCreations.OneAlertPerEmail,
	AlertSourceAlertCreations.OneAlertPerEmailSubject,
	AlertSourceAlertCreations.OnePendingAlertAllowed,
	AlertSourceAlertCreations.OneOpenAlertAllowed,
	AlertSourceAlertCreations.OpenResolveOnExtraction,
	AlertSourceAlertCreations.OneAlertGroupedPerWindow,
}

AlertSourceAlertCreationsAll defines alert source alert creations list

View Source
var AlertSourceAlertGroupingWindows = struct {
	TwoMinutes      string
	FiveMinutes     string
	FifteenMinutes  string
	ThirtyMinutes   string
	OneHour         string
	TwoHours        string
	FourHours       string
	EightHours      string
	TwelveHours     string
	TwentyFourHours string
}{
	TwoMinutes:      "PT2M",
	FiveMinutes:     "PT5M",
	FifteenMinutes:  "PT15M",
	ThirtyMinutes:   "PT30M",
	OneHour:         "PT1H",
	TwoHours:        "PT2H",
	FourHours:       "PT4H",
	EightHours:      "PT8H",
	TwelveHours:     "PT12H",
	TwentyFourHours: "PT24H",
}

AlertSourceAlertGroupingWindows defines alert source alert grouping windows

AlertSourceAlertGroupingWindowsAll defines alert source alert grouping windows list

View Source
var AlertSourceIntegrationTypes = struct {
	AmazonCloudWatch           string
	API                        string
	AppDynamics                string
	Autotask                   string
	AWSBudget                  string
	AWSPersonalHealthDashboard string
	CallRoutingNumber          string
	CheckMK                    string
	Datadog                    string
	Dynatrace                  string
	Email                      string
	Github                     string
	GoogleStackdriver          string
	Grafana                    string
	Heartbeat                  string
	Icinga                     string
	Instana                    string
	Jira                       string
	KentixAlarmManager         string
	Nagios                     string
	NewRelic                   string
	Pingdom                    string
	Prometheus                 string
	PRTGNetworkMonitor         string
	SMS                        string
	Solarwinds                 string
	StatusCake                 string
	TOPdesk                    string
	UptimeMonitor              string
	UPTIMEROBOT                string
	Zabbix                     string
	Consul                     string
	Zammad                     string
	SignalFx                   string
	Splunk                     string
	Kubernetes                 string
	Sematext                   string
	Sentry                     string
	Sumologic                  string
	Raygun                     string
	MXToolBox                  string
	ESWatcher                  string
	AmazonSNS                  string
	Kapacitor                  string
	CortexXSOAR                string
	Sysdig                     string
	ServerDensity              string
	Zapier                     string
	ServiceNow                 string
	SearchGuard                string
	AzureAlerts                string
	TerraformCloud             string
	Zendesk                    string
	Auvik                      string
	Sensu                      string
	NCentral                   string
	JumpCloud                  string
	Salesforce                 string
	GuardDuty                  string
	StatusHub                  string
	IXON                       string
	ApiFortress                string
	FreshService               string
	AppSignal                  string
	LightStep                  string
	IBMCloudFunctions          string
	CrowdStrike                string
	Humio                      string
	OhDear                     string
	MongodbAtlas               string
	Gitlab                     string
	Checkly                    string
}{
	AmazonCloudWatch:           "CLOUDWATCH",
	API:                        "API",
	AppDynamics:                "APPDYNAMICS",
	Autotask:                   "AUTOTASK",
	AWSBudget:                  "AWSBUDGET",
	AWSPersonalHealthDashboard: "AWSPHD",
	CallRoutingNumber:          "CRN",
	CheckMK:                    "CHECKMK",
	Datadog:                    "DATADOG",
	Dynatrace:                  "DYNATRACE",
	Email:                      "EMAIL",
	Github:                     "GITHUB",
	GoogleStackdriver:          "STACKDRIVER",
	Grafana:                    "GRAFANA",
	Heartbeat:                  "HEARTBEAT",
	Icinga:                     "ICINGA",
	Instana:                    "INSTANA",
	Jira:                       "JIRA",
	KentixAlarmManager:         "KENTIXAM",
	Nagios:                     "NAGIOS",
	NewRelic:                   "NEWRELIC",
	Pingdom:                    "PINGDOM",
	Prometheus:                 "PROMETHEUS",
	PRTGNetworkMonitor:         "PRTG",
	SMS:                        "SMS",
	Solarwinds:                 "SOLARWINDS",
	StatusCake:                 "STATUSCAKE",
	TOPdesk:                    "TOPDESK",
	UptimeMonitor:              "MONITOR",
	UPTIMEROBOT:                "UPTIMEROBOT",
	Zabbix:                     "ZABBIX",
	Consul:                     "CONSUL",
	Zammad:                     "ZAMMAD",
	SignalFx:                   "SIGNALFX",
	Splunk:                     "SPLUNK",
	Kubernetes:                 "KUBERNETES",
	Sematext:                   "SEMATEXT",
	Sentry:                     "SENTRY",
	Sumologic:                  "SUMOLOGIC",
	Raygun:                     "RAYGUN",
	MXToolBox:                  "MXTOOLBOX",
	ESWatcher:                  "ESWATCHER",
	AmazonSNS:                  "AMAZONSNS",
	Kapacitor:                  "KAPACITOR",
	CortexXSOAR:                "CORTEXXSOAR",
	Sysdig:                     "SYSDIG",
	ServerDensity:              "SERVERDENSITY",
	Zapier:                     "ZAPIER",
	ServiceNow:                 "SERVICENOW",
	SearchGuard:                "SEARCHGUARD",
	AzureAlerts:                "AZUREALERTS",
	TerraformCloud:             "TERRAFORMCLOUD",
	Zendesk:                    "ZENDESK",
	Auvik:                      "AUVIK",
	Sensu:                      "SENSU",
	NCentral:                   "NCENTRAL",
	JumpCloud:                  "JUMPCLOUD",
	Salesforce:                 "SALESFORCE",
	GuardDuty:                  "GUARDDUTY",
	StatusHub:                  "STATUSHUB",
	IXON:                       "IXON",
	ApiFortress:                "APIFORTRESS",
	FreshService:               "FRESHSERVICE",
	AppSignal:                  "APPSIGNAL",
	LightStep:                  "LIGHTSTEP",
	IBMCloudFunctions:          "IBMCLOUDFUNCTIONS",
	CrowdStrike:                "CROWDSTRIKE",
	Humio:                      "HUMIO",
	OhDear:                     "OHDEAR",
	MongodbAtlas:               "MONGODBATLAS",
	Gitlab:                     "GITLAB",
	Checkly:                    "CHECKLY",
}

AlertSourceIntegrationTypes defines alert source integration types

View Source
var AlertSourceIntegrationTypesAll = []string{
	AlertSourceIntegrationTypes.AmazonCloudWatch,
	AlertSourceIntegrationTypes.API,
	AlertSourceIntegrationTypes.AppDynamics,
	AlertSourceIntegrationTypes.Autotask,
	AlertSourceIntegrationTypes.AWSBudget,
	AlertSourceIntegrationTypes.AWSPersonalHealthDashboard,
	AlertSourceIntegrationTypes.CallRoutingNumber,
	AlertSourceIntegrationTypes.CheckMK,
	AlertSourceIntegrationTypes.Datadog,
	AlertSourceIntegrationTypes.Dynatrace,
	AlertSourceIntegrationTypes.Email,
	AlertSourceIntegrationTypes.Github,
	AlertSourceIntegrationTypes.GoogleStackdriver,
	AlertSourceIntegrationTypes.Grafana,
	AlertSourceIntegrationTypes.Heartbeat,
	AlertSourceIntegrationTypes.Icinga,
	AlertSourceIntegrationTypes.Instana,
	AlertSourceIntegrationTypes.Jira,
	AlertSourceIntegrationTypes.KentixAlarmManager,
	AlertSourceIntegrationTypes.Nagios,
	AlertSourceIntegrationTypes.NewRelic,
	AlertSourceIntegrationTypes.Pingdom,
	AlertSourceIntegrationTypes.Prometheus,
	AlertSourceIntegrationTypes.PRTGNetworkMonitor,
	AlertSourceIntegrationTypes.SMS,
	AlertSourceIntegrationTypes.Solarwinds,
	AlertSourceIntegrationTypes.StatusCake,
	AlertSourceIntegrationTypes.TOPdesk,
	AlertSourceIntegrationTypes.UptimeMonitor,
	AlertSourceIntegrationTypes.UPTIMEROBOT,
	AlertSourceIntegrationTypes.Zabbix,
	AlertSourceIntegrationTypes.Consul,
	AlertSourceIntegrationTypes.Zammad,
	AlertSourceIntegrationTypes.SignalFx,
	AlertSourceIntegrationTypes.Splunk,
	AlertSourceIntegrationTypes.Kubernetes,
	AlertSourceIntegrationTypes.Sematext,
	AlertSourceIntegrationTypes.Sentry,
	AlertSourceIntegrationTypes.Sumologic,
	AlertSourceIntegrationTypes.Raygun,
	AlertSourceIntegrationTypes.MXToolBox,
	AlertSourceIntegrationTypes.ESWatcher,
	AlertSourceIntegrationTypes.AmazonSNS,
	AlertSourceIntegrationTypes.Kapacitor,
	AlertSourceIntegrationTypes.CortexXSOAR,
	AlertSourceIntegrationTypes.Sysdig,
	AlertSourceIntegrationTypes.ServerDensity,
	AlertSourceIntegrationTypes.Zapier,
	AlertSourceIntegrationTypes.ServiceNow,
	AlertSourceIntegrationTypes.SearchGuard,
	AlertSourceIntegrationTypes.AzureAlerts,
	AlertSourceIntegrationTypes.TerraformCloud,
	AlertSourceIntegrationTypes.Zendesk,
	AlertSourceIntegrationTypes.Auvik,
	AlertSourceIntegrationTypes.Sensu,
	AlertSourceIntegrationTypes.NCentral,
	AlertSourceIntegrationTypes.JumpCloud,
	AlertSourceIntegrationTypes.Salesforce,
	AlertSourceIntegrationTypes.GuardDuty,
	AlertSourceIntegrationTypes.StatusHub,
	AlertSourceIntegrationTypes.IXON,
	AlertSourceIntegrationTypes.ApiFortress,
	AlertSourceIntegrationTypes.FreshService,
	AlertSourceIntegrationTypes.AppSignal,
	AlertSourceIntegrationTypes.LightStep,
	AlertSourceIntegrationTypes.IBMCloudFunctions,
	AlertSourceIntegrationTypes.CrowdStrike,
	AlertSourceIntegrationTypes.Humio,
	AlertSourceIntegrationTypes.OhDear,
	AlertSourceIntegrationTypes.MongodbAtlas,
	AlertSourceIntegrationTypes.Gitlab,
	AlertSourceIntegrationTypes.Checkly,
}

AlertSourceIntegrationTypesAll defines all alert source integration types

View Source
var AlertSourceStatuses = struct {
	Pending       string
	AllAccepted   string
	AllResolved   string
	InMaintenance string
	Disabled      string
}{
	Pending:       "PENDING",
	AllAccepted:   "ALL_ACCEPTED",
	AllResolved:   "ALL_RESOLVED",
	InMaintenance: "IN_MAINTENANCE",
	Disabled:      "DISABLED",
}

AlertSourceStatuses defines alert source statuses

View Source
var AlertSourceStatusesAll = []string{
	AlertSourceStatuses.Pending,
	AlertSourceStatuses.AllAccepted,
	AlertSourceStatuses.AllResolved,
	AlertSourceStatuses.InMaintenance,
	AlertSourceStatuses.Disabled,
}

AlertSourceStatusesAll defines alert source statuses list

View Source
var AlertStatuses = struct {
	New      string
	Pending  string
	Accepted string
	Resolved string
}{
	New:      "NEW",
	Pending:  "PENDING",
	Accepted: "ACCEPTED",
	Resolved: "RESOLVED",
}

AlertStatuses defines alert statuses

View Source
var AlertType = struct {
	Created  string
	Accepted string
}{
	Created:  "CREATED",
	Accepted: "ACCEPTED",
}

AlertType defines the alert type in an automation rule

View Source
var AlertTypeAll = []string{
	AlertType.Created,
	AlertType.Accepted,
}

AlertType defines the alert type list

View Source
var ConnectionTriggerModes = struct {
	Automatic string
	Manual    string
}{
	Automatic: "AUTOMATIC",
	Manual:    "MANUAL",
}

ConnectionTriggerModes defines connection trigger modes

View Source
var ConnectionTriggerModesAll = []string{
	ConnectionTriggerModes.Automatic,
	ConnectionTriggerModes.Manual,
}

ConnectionTriggerModesAll defines all connection trigger modes

View Source
var ConnectionTriggerTypes = struct {
	IncidentCreated       string
	IncidentAssigned      string
	IncidentAutoEscalated string
	IncidentAcknowledged  string
	IncidentRaised        string
	IncidentCommentAdded  string
	IncidentResolved      string
}{
	IncidentCreated:       "incident-created",
	IncidentAssigned:      "incident-assigned",
	IncidentAutoEscalated: "incident-auto-escalated",
	IncidentAcknowledged:  "incident-acknowledged",
	IncidentRaised:        "incident-raised",
	IncidentCommentAdded:  "incident-comment-added",
	IncidentResolved:      "incident-resolved",
}

ConnectionTriggerTypes defines connection trigger types

View Source
var ConnectionTriggerTypesAll = []string{
	ConnectionTriggerTypes.IncidentCreated,
	ConnectionTriggerTypes.IncidentAssigned,
	ConnectionTriggerTypes.IncidentAutoEscalated,
	ConnectionTriggerTypes.IncidentAcknowledged,
	ConnectionTriggerTypes.IncidentRaised,
	ConnectionTriggerTypes.IncidentCommentAdded,
	ConnectionTriggerTypes.IncidentResolved,
}

ConnectionTriggerTypesAll defines all connection trigger types

View Source
var ConnectorTypes = struct {
	AutomationRule    string
	Autotask          string
	DingTalk          string
	DingTalkAction    string
	Discord           string
	Email             string
	Github            string
	Jira              string
	Mattermost        string
	MicrosoftTeams    string
	MicrosoftTeamsBot string
	ServiceNow        string
	Slack             string
	Telegram          string
	Topdesk           string
	Webhook           string
	Zammad            string
	Zendesk           string
}{
	AutomationRule:    "automation_rule",
	Autotask:          "autotask",
	DingTalk:          "dingtalk",
	DingTalkAction:    "dingtalk_action",
	Discord:           "discord",
	Email:             "email",
	Github:            "github",
	Jira:              "jira",
	Mattermost:        "mattermost",
	MicrosoftTeams:    "microsoft_teams",
	MicrosoftTeamsBot: "microsoft_teams_bot",
	ServiceNow:        "servicenow",
	Slack:             "slack",
	Telegram:          "telegram",
	Topdesk:           "topdesk",
	Webhook:           "webhook",
	Zammad:            "zammad",
	Zendesk:           "zendesk",
}

ConnectorTypes defines connector types

View Source
var ConnectorTypesAll = []string{
	ConnectorTypes.AutomationRule,
	ConnectorTypes.Autotask,
	ConnectorTypes.DingTalk,
	ConnectorTypes.DingTalkAction,
	ConnectorTypes.Discord,
	ConnectorTypes.Email,
	ConnectorTypes.Github,
	ConnectorTypes.Jira,
	ConnectorTypes.Mattermost,
	ConnectorTypes.MicrosoftTeams,
	ConnectorTypes.MicrosoftTeamsBot,
	ConnectorTypes.ServiceNow,
	ConnectorTypes.Slack,
	ConnectorTypes.Telegram,
	ConnectorTypes.Topdesk,
	ConnectorTypes.Webhook,
	ConnectorTypes.Zammad,
	ConnectorTypes.Zendesk,
}

ConnectorTypesAll defines connector all types list

View Source
var DayOfWeek = struct {
	Monday    string
	Tuesday   string
	Wednesday string
	Thursday  string
	Friday    string
	Saturday  string
	Sunday    string
}{
	Monday:    "MONDAY",
	Tuesday:   "TUESDAY",
	Wednesday: "WEDNESDAY",
	Thursday:  "THURSDAY",
	Friday:    "FRIDAY",
	Saturday:  "SATURDAY",
	Sunday:    "SUNDAY",
}
View Source
var DayOfWeekAll = []string{
	DayOfWeek.Monday,
	DayOfWeek.Tuesday,
	DayOfWeek.Wednesday,
	DayOfWeek.Thursday,
	DayOfWeek.Friday,
	DayOfWeek.Saturday,
	DayOfWeek.Sunday,
}
View Source
var EventTypes = struct {
	Alert   string
	Accept  string
	Resolve string
}{
	Alert:   "ALERT",
	Accept:  "ACCEPT",
	Resolve: "RESOLVE",
}

EventTypes defines event types

View Source
var HeartbeatMethods = struct {
	HEAD string
	GET  string
	POST string
}{
	HEAD: "HEAD",
	GET:  "GET",
	POST: "POST",
}

HeartbeatMethods defines uptime monitor regions

View Source
var IncidentInclude = struct {
	Subscribed    string
	AffectedTeams string
	History       string
}{
	Subscribed:    "subscribed",
	AffectedTeams: "affectedTeams",
	History:       "history",
}

IncidentInclude defines incident includes

View Source
var IncidentIncludeAll = []string{
	IncidentInclude.Subscribed,
	IncidentInclude.AffectedTeams,
	IncidentInclude.History,
}

IncidentIncludeAll defines incident includes list

View Source
var IncidentStatus = struct {
	Investigating string
	Identified    string
	Monitoring    string
	Resolved      string
}{
	Investigating: "INVESTIGATING",
	Identified:    "IDENTIFIED",
	Monitoring:    "MONITORING",
	Resolved:      "RESOLVED",
}

IncidentStatus defines incident status

View Source
var IncidentStatusAll = []string{
	IncidentStatus.Investigating,
	IncidentStatus.Identified,
	IncidentStatus.Monitoring,
	IncidentStatus.Resolved,
}

IncidentStatusAll defines incident status list

View Source
var IncidentType = struct {
	User string
	Team string
}{
	User: "USER",
	Team: "TEAM",
}

IncidentType defines incident type

View Source
var IncidentTypeAll = []string{
	IncidentType.User,
	IncidentType.Team,
}

IncidentTypeAll defines incident type list

View Source
var MetricAggregationType = struct {
	Average string
	Sum     string
	Minimum string
	Maximum string
	Last    string
}{
	Average: "AVG",
	Sum:     "SUM",
	Minimum: "MIN",
	Maximum: "MAX",
	Last:    "LAST",
}

MetricAggregationType defines aggregation type for the metric

View Source
var MetricAggregationTypeAll = []string{
	MetricAggregationType.Average,
	MetricAggregationType.Sum,
	MetricAggregationType.Minimum,
	MetricAggregationType.Maximum,
	MetricAggregationType.Last,
}

MetricAggregationType defines aggregation type list

View Source
var MetricDataSourceAuthType = struct {
	None   string
	Basic  string
	Header string
}{
	None:   "NONE",
	Basic:  "BASIC",
	Header: "HEADER",
}

MetricDataSourceAuthType defines provider authentication type of the metric data source

View Source
var MetricDataSourceAuthTypeAll = []string{
	MetricDataSourceAuthType.None,
	MetricDataSourceAuthType.Basic,
	MetricDataSourceAuthType.Header,
}

MetricDataSourceAuthType defines provider authentication type list

View Source
var MetricDataSourceType = struct {
	Datadog    string
	Prometheus string
}{
	Datadog:    "DATADOG",
	Prometheus: "PROMETHEUS",
}

MetricDataSourceType defines provider type of the metric data source

View Source
var MetricDataSourceTypeAll = []string{
	MetricDataSourceType.Datadog,
	MetricDataSourceType.Prometheus,
}

MetricDataSourceType defines provider type list

View Source
var MetricDisplayType = struct {
	Graph  string
	Single string
}{
	Graph:  "GRAPH",
	Single: "SINGLE",
}

MetricDisplayType defines display type for the metric

View Source
var MetricDisplayTypeAll = []string{
	MetricDisplayType.Graph,
	MetricDisplayType.Single,
}

MetricDisplayType defines display type list

View Source
var NumberTypes = struct {
	SMS   string
	Voice string
}{
	SMS:   "SMS",
	Voice: "VOICE",
}

NumberTypes defines number types

View Source
var RestrictionType = struct {
	TimeOfWeek string
	TimeOfDay  string
}{
	TimeOfWeek: "TIME_OF_WEEK",
	TimeOfDay:  "TIME_OF_DAY",
}
View Source
var RestrictionTypeAll = []string{
	RestrictionType.TimeOfDay,
	RestrictionType.TimeOfWeek,
}
View Source
var ScheduleType = struct {
	Static    string
	Recurring string
}{
	Static:    "STATIC",
	Recurring: "RECURRING",
}
View Source
var ScheduleTypeAll = []string{
	ScheduleType.Static,
	ScheduleType.Recurring,
}
View Source
var ServiceInclude = struct {
	Subscribed string
	Uptime     string
	Incidents  string
}{
	Subscribed: "subscribed",
	Uptime:     "uptime",
	Incidents:  "incidents",
}

ServiceInclude defines included services

View Source
var ServiceIncludeAll = []string{
	ServiceInclude.Subscribed,
	ServiceInclude.Uptime,
	ServiceInclude.Incidents,
}

ServiceIncludeAll defines included services list

View Source
var ServiceStatus = struct {
	Operational      string
	UnderMaintenance string
	Degraded         string
	PartialOutage    string
	MajorOutage      string
}{
	Operational:      "OPERATIONAL",
	UnderMaintenance: "UNDER_MAINTENANCE",
	Degraded:         "DEGRADED",
	PartialOutage:    "PARTIAL_OUTAGE",
	MajorOutage:      "MAJOR_OUTAGE",
}

ServiceStatus defines services status

View Source
var ServiceStatusAll = []string{
	ServiceStatus.Operational,
	ServiceStatus.UnderMaintenance,
	ServiceStatus.Degraded,
	ServiceStatus.PartialOutage,
	ServiceStatus.MajorOutage,
}

ServiceStatusAll defines services status list

View Source
var StatusPageAppearance = struct {
	Light string
	Dark  string
}{
	Light: "LIGHT",
	Dark:  "DARK",
}

StatusPageAppearance defines status page appearance

View Source
var StatusPageAppearanceAll = []string{
	StatusPageAppearance.Light,
	StatusPageAppearance.Dark,
}

StatusPageAppearanceAll defines all status page appearances

View Source
var StatusPageElementOption = struct {
	Expand  string
	NoGraph string
}{
	Expand:  "expand",
	NoGraph: "no-graph",
}

StatusPageElementOption defines status page element option

View Source
var StatusPageElementOptionAll = []string{
	StatusPageElementOption.Expand,
	StatusPageElementOption.NoGraph,
}

StatusPageElementOptionAll defines all status page element options

View Source
var StatusPageElementType = struct {
	Service string
	Group   string
}{
	Service: "SERVICE",
	Group:   "GROUP",
}

StatusPageElementType defines status page element type

View Source
var StatusPageElementTypeAll = []string{
	StatusPageElementType.Service,
	StatusPageElementType.Group,
}

StatusPageElementTypeAll defines all status page element types

View Source
var StatusPageLayout = struct {
	SingleColumn string
	Responsive   string
}{
	SingleColumn: "SINGLE_COLUMN",
	Responsive:   "RESPONSIVE",
}

StatusPageLayout defines status page layout

View Source
var StatusPageLayoutAll = []string{
	StatusPageLayout.SingleColumn,
	StatusPageLayout.Responsive,
}

StatusPageLayoutAll defines all status page layouts

View Source
var StatusPageVisibility = struct {
	Public  string
	Private string
}{
	Public:  "PUBLIC",
	Private: "PRIVATE",
}

StatusPageVisibility defines status page visibility

View Source
var StatusPageVisibilityAll = []string{
	StatusPageVisibility.Public,
	StatusPageVisibility.Private,
}

StatusPageVisibilityAll defines status page visibility list

View Source
var TeamMemberRoles = struct {
	Admin       string
	User        string
	Responder   string
	Stakeholder string
}{
	Admin:       "ADMIN",
	User:        "USER",
	Responder:   "RESPONDER",
	Stakeholder: "STAKEHOLDER",
}

TeamMemberRoles defines team member roles

View Source
var TeamMemberRolesAll = []string{
	TeamMemberRoles.Admin,
	TeamMemberRoles.User,
	TeamMemberRoles.Responder,
	TeamMemberRoles.Stakeholder,
}

TeamMemberRolesAll defines team member roles list

View Source
var TeamVisibility = struct {
	Public  string
	Private string
}{
	Public:  "PUBLIC",
	Private: "PRIVATE",
}

TeamVisibility defines team visibility

View Source
var TeamVisibilityAll = []string{
	TeamVisibility.Public,
	TeamVisibility.Private,
}

TeamVisibilityAll defines team visibility list

View Source
var UptimeMonitorCheckTypes = struct {
	HTTP string
	Ping string
	TCP  string
	UDP  string
	SSL  string
}{
	HTTP: "http",
	Ping: "ping",
	TCP:  "tcp",
	UDP:  "udp",
	SSL:  "ssl",
}

UptimeMonitorCheckTypes defines uptime monitor check types

UptimeMonitorCheckTypesAll defines uptime monitor check types list

View Source
var UptimeMonitorRegions = struct {
	EU string
	US string
}{
	EU: "EU",
	US: "US",
}

UptimeMonitorRegions defines uptime monitor regions

View Source
var UptimeMonitorRegionsAll = []string{
	UptimeMonitorRegions.EU,
	UptimeMonitorRegions.US,
}

UptimeMonitorRegionsAll defines uptime monitor regions list

View Source
var UptimeMonitorStatuses = struct {
	Up      string
	Down    string
	Warning string
	Paused  string
	Unknown string
}{
	Up:      "up",
	Down:    "down",
	Warning: "warn",
	Paused:  "paused",
	Unknown: "unknown",
}

UptimeMonitorStatuses defines uptime monitor statuses

UptimeMonitorStatusesAll defines uptime monitor statuses list

View Source
var UserAlertPreferenceMethodAll = []string{
	UserPreferenceMethod.Email,
	UserPreferenceMethod.Sms,
	UserPreferenceMethod.Push,
	UserPreferenceMethod.Voice,
	UserPreferenceMethod.WhatsApp,
	UserPreferenceMethod.Telegram,
}

UserAlertPreferenceMethodAll defines user alert notification preference method list

View Source
var UserAlertPreferenceType = struct {
	HighPriority string
	LowPriority  string
}{
	HighPriority: "HIGH_PRIORITY",
	LowPriority:  "LOW_PRIORITY",
}

UserAlertPreferenceType defines user alert notification preference type

View Source
var UserAlertPreferenceTypeAll = []string{
	UserAlertPreferenceType.HighPriority,
	UserAlertPreferenceType.LowPriority,
}

UserAlertPreferenceTypeAll defines user alert notification preference type list

View Source
var UserContactStatus = struct {
	Ok          string
	Locked      string
	Blacklisted string
}{
	Ok:          "OK",
	Locked:      "LOCKED",
	Blacklisted: "BLACKLISTED",
}

UserContactStatus defines user contact status

View Source
var UserContactStatusAll = []string{
	UserContactStatus.Ok,
	UserContactStatus.Locked,
	UserContactStatus.Blacklisted,
}

UserContactStatusAll defines user contact status list

View Source
var UserDutyPreferenceMethodAll = []string{
	UserPreferenceMethod.Email,
	UserPreferenceMethod.Sms,
	UserPreferenceMethod.Push,
	UserPreferenceMethod.WhatsApp,
	UserPreferenceMethod.Telegram,
}

UserDutyPreferenceMethodAll defines user duty notification preference method list

View Source
var UserDutyPreferenceType = struct {
	OnCall string
}{
	OnCall: "ON_CALL",
}

UserDutyPreferenceType defines user duty notification preference type

View Source
var UserDutyPreferenceTypeAll = []string{
	UserDutyPreferenceType.OnCall,
}

UserDutyPreferenceTypeAll defines user duty notification preference type list

View Source
var UserLanguage = struct {
	English string
	German  string
}{
	English: "en",
	German:  "de",
}

UserLanguage defines user language

View Source
var UserLanguageAll = []string{
	UserLanguage.English,
	UserLanguage.German,
}

UserLanguageAll defines user language list

View Source
var UserPreferenceMethod = struct {
	Email    string
	Sms      string
	Push     string
	Voice    string
	WhatsApp string
	Telegram string
}{
	Email:    "EMAIL",
	Sms:      "SMS",
	Push:     "PUSH",
	Voice:    "VOICE",
	WhatsApp: "WHATSAPP",
	Telegram: "TELEGRAM",
}

UserPreferenceMethod defines user notification preference method

View Source
var UserRole = struct {
	User        string
	Admin       string
	Stakeholder string
}{
	User:        "USER",
	Admin:       "ADMIN",
	Stakeholder: "STAKEHOLDER",
}

UserRole defines user roles

View Source
var UserRoleAll = []string{
	UserRole.User,
	UserRole.Admin,
	UserRole.Stakeholder,
}

UserRoleAll defines user roles list

View Source
var UserSubscriptionPreferenceMethodAll = []string{
	UserPreferenceMethod.Email,
	UserPreferenceMethod.Sms,
	UserPreferenceMethod.Push,
}

UserSubscriptionPreferenceMethodAll defines user subscription notification preference method list

View Source
var UserUpdatePreferenceMethodAll = []string{
	UserPreferenceMethod.Email,
	UserPreferenceMethod.Sms,
	UserPreferenceMethod.Push,
	UserPreferenceMethod.WhatsApp,
	UserPreferenceMethod.Telegram,
}

UserUpdatePreferenceMethodAll defines user update notification preference method list

View Source
var UserUpdatePreferenceType = struct {
	AlertAccepted  string
	AlertResolved  string
	AlertEscalated string
}{
	AlertAccepted:  "ALERT_ACCEPTED",
	AlertResolved:  "ALERT_RESOLVED",
	AlertEscalated: "ALERT_ESCALATED",
}

UserUpdatePreferenceType defines user update notification preference type

View Source
var UserUpdatePreferenceTypeAll = []string{
	UserUpdatePreferenceType.AlertAccepted,
	UserUpdatePreferenceType.AlertResolved,
	UserUpdatePreferenceType.AlertEscalated,
}

UserUpdatePreferenceTypeAll defines user update notification preference type list

Functions

func Int

func Int(v int) *int

Int returns a pointer to the int value passed in.

func Int64

func Int64(v int64) *int64

Int64 returns a pointer to the int64 value passed in.

func String

func String(v string) *string

String returns a pointer to the string value passed in.

Types

type AcceptAlertInput

type AcceptAlertInput struct {
	AlertID *int64
	// contains filtered or unexported fields
}

AcceptAlertInput represents the input of a AcceptAlert operation.

type AcceptAlertOutput

type AcceptAlertOutput struct {
	Alert *Alert
	// contains filtered or unexported fields
}

AcceptAlertOutput represents the output of a AcceptAlert operation.

type AddIncidentSubscribersInput

type AddIncidentSubscribersInput struct {
	IncidentID  *int64
	Subscribers *[]Subscriber
	// contains filtered or unexported fields
}

AddIncidentSubscribersInput represents the input of a AddIncidentSubscribers operation.

type AddIncidentSubscribersOutput

type AddIncidentSubscribersOutput struct {
	// contains filtered or unexported fields
}

AddIncidentSubscribersOutput represents the output of a AddIncidentSubscribers operation.

type AddScheduleShiftOverrideInput

type AddScheduleShiftOverrideInput struct {
	ScheduleID *int64
	Shift      *Shift
	// contains filtered or unexported fields
}

AddScheduleShiftOverrideInput represents the input of a AddScheduleShiftOverride operation.

type AddScheduleShiftOverrideOutput

type AddScheduleShiftOverrideOutput struct {
	Schedule *Schedule
	// contains filtered or unexported fields
}

AddScheduleShiftOverrideOutput represents the output of a AddScheduleShiftOverride operation.

type AddServiceSubscribersInput

type AddServiceSubscribersInput struct {
	ServiceID   *int64
	Subscribers *[]Subscriber
	// contains filtered or unexported fields
}

AddServiceSubscribersInput represents the input of a AddServiceSubscribers operation.

type AddServiceSubscribersOutput

type AddServiceSubscribersOutput struct {
	// contains filtered or unexported fields
}

AddServiceSubscribersOutput represents the output of a AddServiceSubscribers operation.

type AddStatusPageSubscriberInput

type AddStatusPageSubscriberInput struct {
	StatusPageID *int64
	Subscriber   *Subscriber
	// contains filtered or unexported fields
}

AddStatusPageSubscriberInput represents the input of a AddStatusPageSubscriber operation.

type AddStatusPageSubscriberOutput

type AddStatusPageSubscriberOutput struct {
	// contains filtered or unexported fields
}

AddStatusPageSubscriberOutput represents the output of a AddStatusPageSubscriber operation.

type AddStatusPageSubscribersInput

type AddStatusPageSubscribersInput struct {
	StatusPageID *int64
	Subscribers  *[]Subscriber
	// contains filtered or unexported fields
}

AddStatusPageSubscribersInput represents the input of a AddStatusPageSubscribers operation.

type AddStatusPageSubscribersOutput

type AddStatusPageSubscribersOutput struct {
	// contains filtered or unexported fields
}

AddStatusPageSubscribersOutput represents the output of a AddStatusPageSubscribers operation.

type Affected

type Affected struct {
	StatusPagesInfo    UIMenuItem `json:"statusPagesInfo"`
	PrivateStatusPages int64      `json:"privateStatusPages"`
	PublicStatusPages  int64      `json:"publicStatusPages"`
	PrivateSubscribers int64      `json:"privateSubscribers"`
	PublicSubscribers  int64      `json:"publicSubscribers"`
}

Affected defines affected entities on incident

type AffectedServices

type AffectedServices struct {
	Impact  string  `json:"impact"`
	Service Service `json:"service"`
}

AffectedServices defines affected services

type Alert

type Alert struct {
	ID                 int64                  `json:"id"`
	Summary            string                 `json:"summary"`
	Details            string                 `json:"details"`
	ReportTime         string                 `json:"reportTime"` // Date time string in ISO format
	ResolvedOn         string                 `json:"resolvedOn"` // Date time string in ISO format
	Status             string                 `json:"status"`
	AlertSource        *AlertSource           `json:"alertSource,omitempty"`
	EscalationPolicy   *EscalationPolicy      `json:"scalationPolicy,omitempty"`
	Priority           string                 `json:"priority"`
	AlertKey           string                 `json:"alertKey"`
	AssignedTo         *User                  `json:"assignedTo,omitempty"`
	NextEscalation     string                 `json:"nextEscalation"` // Date time string in ISO format
	CallRoutingNumber  *CallRoutingNumber     `json:"callRoutingNumber,omitempty"`
	AcknowledgedBy     *User                  `json:"acknowledgedBy,omitempty"`
	AcknowledgedByType string                 `json:"acknowledgedByType,omitempty"`
	ResolvedBy         *User                  `json:"resolvedBy,omitempty"`
	ResolvedByType     string                 `json:"resolvedByType,omitempty"`
	Images             []AlertImage           `json:"images,omitempty"`
	Links              []AlertLink            `json:"links,omitempty"`
	CustomDetails      map[string]interface{} `json:"customDetails,omitempty"`
}

Alert definition

type AlertAction

type AlertAction struct {
	ID             string         `json:"id,omitempty"`
	Name           string         `json:"name"`
	AlertSourceIDs []int64        `json:"alertSourceIds,omitempty"` // @deprecated
	AlertSources   *[]AlertSource `json:"alertSources,omitempty"`
	ConnectorID    string         `json:"connectorId,omitempty"`
	ConnectorType  string         `json:"connectorType"`
	TriggerMode    string         `json:"triggerMode"`
	DelaySec       int            `json:"delaySec,omitempty"` // between 0 and 7200, only allowed with triggerType 'alert-escalation-ended'
	TriggerTypes   []string       `json:"triggerTypes,omitempty"`
	CreatedAt      string         `json:"createdAt,omitempty"` // date time string in ISO 8601
	UpdatedAt      string         `json:"updatedAt,omitempty"` // date time string in ISO 8601
	Params         interface{}    `json:"params"`
	AlertFilter    *AlertFilter   `json:"alertFilter,omitempty"`
	Teams          *[]TeamShort   `json:"teams,omitempty"`
}

AlertAction definition https://api.ilert.com/api-docs/#tag/Alert-Actions

type AlertActionOutput

type AlertActionOutput struct {
	ID             string                   `json:"id"`
	Name           string                   `json:"name"`
	AlertSourceIDs []int64                  `json:"alertSourceIds,omitempty"` // @deprecated
	AlertSources   *[]AlertSource           `json:"alertSources,omitempty"`
	ConnectorID    string                   `json:"connectorId"`
	ConnectorType  string                   `json:"connectorType"`
	TriggerMode    string                   `json:"triggerMode"`
	DelaySec       int                      `json:"delaySec,omitempty"` // between 0 and 7200, only allowed with triggerType 'alert-escalation-ended'
	TriggerTypes   []string                 `json:"triggerTypes,omitempty"`
	CreatedAt      string                   `json:"createdAt"` // date time string in ISO 8601
	UpdatedAt      string                   `json:"updatedAt"` // date time string in ISO 8601
	Params         *AlertActionOutputParams `json:"params"`
	AlertFilter    *AlertFilter             `json:"alertFilter,omitempty"`
	Teams          *[]TeamShort             `json:"teams,omitempty"`
}

AlertActionOutput definition https://api.ilert.com/api-docs/#tag/Alert-Actions

type AlertActionOutputParams

type AlertActionOutputParams struct {
	AlertType        string   `json:"alertType"`                  // Automation rule
	AtMobiles        []string `json:"atMobiles,omitempty"`        // DingTalk
	BodyTemplate     string   `json:"bodyTemplate,omitempty"`     // Custom, Jira, Email. Used to post data to external server
	CallerID         string   `json:"callerId,omitempty"`         // ServiceNow: user email
	ChannelID        string   `json:"channelId,omitempty"`        // Slack, Telegram
	ChannelName      string   `json:"channelName,omitempty"`      // Slack
	CompanyID        int64    `json:"companyId,omitempty"`        // Autotask: Company ID
	Email            string   `json:"email,omitempty"`            // Zammad
	EventFilter      string   `json:"eventFilter,omitempty"`      // Sysdig
	Impact           string   `json:"impact,omitempty"`           // ServiceNow: 1 - High, 2 - Medium, 3 - Low (Default)
	IsAtAll          bool     `json:"isAtAll,omitempty"`          // DingTalk
	IssueType        string   `json:"issueType,omitempty"`        // Jira: "Bug" | "Epic" | "Subtask" | "Story" | "Task"
	IssueTypeNumber  int64    `json:"issueTypeNumber,omitempty"`  // Autotask: Issue type
	Labels           []string `json:"labels,omitempty"`           // Github
	Name             string   `json:"name,omitempty"`             // Jira or MicrosoftTeams or Zendesk
	Owner            string   `json:"owner,omitempty"`            // Github
	PageID           string   `json:"pageId,omitempty"`           // StatusPage.io
	Priority         string   `json:"priority,omitempty"`         // Datadog: "normal" | "low". Zendesk: "urgent" | "high" | "normal" | "low".
	Project          string   `json:"project,omitempty"`          // Jira
	QueueID          int64    `json:"queueId,omitempty"`          // Autotask: Queue ID
	Recipients       []string `json:"recipients,omitempty"`       // Email
	Repository       string   `json:"repository,omitempty"`       // Github
	ResolveIncident  bool     `json:"resolveIncident,omitempty"`  // Automation rule
	Secret           string   `json:"secret,omitempty"`           // DingTalk
	SendNotification bool     `json:"sendNotification,omitempty"` // Automation rule
	ServiceIds       []int64  `json:"serviceIds"`                 // Automation rule
	ServiceStatus    string   `json:"serviceStatus"`              // Automation rule
	Site             string   `json:"site,omitempty"`             // Datadog: default `US`. Values: `US` or `EU`
	Status           string   `json:"status,omitempty"`           // Topdesk: firstLine, secondLine, partial
	Subject          string   `json:"subject,omitempty"`          // Email
	Tags             []string `json:"tags,omitempty"`             // Datadog or Sysdig
	TeamDomain       string   `json:"teamDomain,omitempty"`       // Slack
	TeamID           string   `json:"teamId,omitempty"`           // Slack, Microsoft Teams Bot
	TeamName         string   `json:"teamName,omitempty"`         // Slack, Microsoft Teams Bot
	TemplateId       int64    `json:"templateId,omitempty"`       // Automation rule
	TicketCategory   string   `json:"ticketCategory,omitempty"`   // Autotask
	TicketType       string   `json:"ticketType,omitempty"`       // Autotask
	Type             string   `json:"type,omitempty"`             // Microsoft Teams Bot
	Urgency          string   `json:"urgency,omitempty"`          // ServiceNow: 1 - High, 2 - Medium, 3 - Low (Default)
	WebhookURL       string   `json:"webhookUrl,omitempty"`       // Custom
	URL              string   `json:"url,omitempty"`              // DingTalk
}

AlertActionOutputParams definition

type AlertActionParamsAutomationRule

type AlertActionParamsAutomationRule struct {
	AlertType        string  `json:"alertType"`
	ResolveIncident  bool    `json:"resolveIncident,omitempty"`
	ServiceStatus    string  `json:"serviceStatus"`
	TemplateId       int64   `json:"templateId,omitempty"`
	SendNotification bool    `json:"sendNotification,omitempty"`
	ServiceIds       []int64 `json:"serviceIds"`
}

AlertActionParamsAutomationRule definition

type AlertActionParamsAutotask

type AlertActionParamsAutotask struct {
	CompanyID      string `json:"companyId,omitempty"`      // Autotask: Company ID
	IssueType      string `json:"issueType,omitempty"`      // Autotask: Issue type
	QueueID        int64  `json:"queueId,omitempty"`        // Autotask: Queue ID
	TicketCategory string `json:"ticketCategory,omitempty"` // Autotask ticket category
	TicketType     string `json:"ticketType,omitempty"`     // Autotask ticket type
}

AlertActionParamsAutotask definition

type AlertActionParamsDingTalk

type AlertActionParamsDingTalk struct {
	IsAtAll   bool     `json:"isAtAll,omitempty"`
	AtMobiles []string `json:"atMobiles,omitempty"`
}

AlertActionParamsDingTalk definition

type AlertActionParamsDingTalkAction

type AlertActionParamsDingTalkAction struct {
	URL       string   `json:"url,omitempty"`
	Secret    string   `json:"secret,omitempty"`
	IsAtAll   bool     `json:"isAtAll,omitempty"`
	AtMobiles []string `json:"atMobiles,omitempty"`
}

AlertActionParamsDingTalkAction definition

type AlertActionParamsDiscord

type AlertActionParamsDiscord struct{}

AlertActionParamsDiscord definition

type AlertActionParamsEmail

type AlertActionParamsEmail struct {
	Recipients   []string `json:"recipients,omitempty"`
	Subject      string   `json:"subject,omitempty"`
	BodyTemplate string   `json:"bodyTemplate,omitempty"`
}

AlertActionParamsEmail definition

type AlertActionParamsGithub

type AlertActionParamsGithub struct {
	Owner      string   `json:"owner,omitempty"`
	Repository string   `json:"repository,omitempty"`
	Labels     []string `json:"labels,omitempty"`
}

AlertActionParamsGithub definition

type AlertActionParamsJira

type AlertActionParamsJira struct {
	Project      string `json:"project,omitempty"`
	IssueType    string `json:"issueType,omitempty"` // "Bug" | "Epic" | "Subtask" | "Story" | "Task"
	BodyTemplate string `json:"bodyTemplate,omitempty"`
}

AlertActionParamsJira definition

type AlertActionParamsMicrosoftTeams

type AlertActionParamsMicrosoftTeams struct{}

AlertActionParamsMicrosoftTeams definition

type AlertActionParamsMicrosoftTeamsBot added in v3.7.0

type AlertActionParamsMicrosoftTeamsBot struct {
	ChannelID   string `json:"channelId,omitempty"`
	ChannelName string `json:"channelName,omitempty"`
	TeamID      string `json:"teamId,omitempty"`
	TeamName    string `json:"teamName,omitempty"`
	Type        string `json:"type,omitempty"` // "chat" | "meeting"
}

AlertActionParamsMicrosoftTeamsBot definition

type AlertActionParamsServiceNow

type AlertActionParamsServiceNow struct {
	CallerID string `json:"callerId,omitempty"` // user email
	Impact   string `json:"impact,omitempty"`   // 1 - High, 2 - Medium, 3 - Low (Default)
	Urgency  string `json:"urgency,omitempty"`  // 1 - High, 2 - Medium, 3 - Low (Default)
}

AlertActionParamsServiceNow definition

type AlertActionParamsSlack

type AlertActionParamsSlack struct {
	ChannelID   string `json:"channelId,omitempty"`
	ChannelName string `json:"channelName,omitempty"`
	TeamDomain  string `json:"teamDomain,omitempty"`
	TeamID      string `json:"teamId,omitempty"`
}

AlertActionParamsSlack definition

type AlertActionParamsTelegram added in v3.5.0

type AlertActionParamsTelegram struct {
	ChannelID string `json:"channelId,omitempty"`
}

AlertActionParamsTelegram definition

type AlertActionParamsTopdesk

type AlertActionParamsTopdesk struct {
	Status string `json:"status,omitempty"` // `firstLine`| `secondLine` | `partial`
}

AlertActionParamsTopdesk definition

type AlertActionParamsWebhook

type AlertActionParamsWebhook struct {
	WebhookURL   string `json:"webhookUrl,omitempty"`
	BodyTemplate string `json:"bodyTemplate,omitempty"`
}

AlertActionParamsWebhook definition

type AlertActionParamsZammad

type AlertActionParamsZammad struct {
	Email string `json:"email,omitempty"`
}

AlertActionParamsZammad definition

type AlertActionParamsZendesk

type AlertActionParamsZendesk struct {
	Priority string `json:"priority,omitempty"` // "urgent" | "high" | "normal" | "low"
}

AlertActionParamsZendesk definition

type AlertActionResult

type AlertActionResult struct {
	ID          string `json:"id"`
	WebhookID   string `json:"webhookId"`
	ExtensionID string `json:"extensionId"`
	AlertID     int64  `json:"alertId"`
	Success     bool   `json:"success"`
	Actor       User   `json:"actor"`
}

AlertActionResult definition

type AlertComment

type AlertComment struct {
	ID             string `json:"id"`
	Content        string `json:"content"`
	Creator        *User  `json:"creator"`
	TriggerType    string `json:"triggerType"`
	ResolveComment bool   `json:"resolveComment"`
	Created        string `json:"created"`
	Updated        string `json:"updated"`
}

AlertComment definition

type AlertFilter

type AlertFilter struct {
	Operator   string                 `json:"operator"`
	Predicates []AlertFilterPredicate `json:"predicates"`
}

AlertFilter definition

type AlertFilterPredicate

type AlertFilterPredicate struct {
	Field    string `json:"field"`
	Criteria string `json:"criteria"`
	Value    string `json:"value"`
}

AlertFilterPredicate definition

type AlertImage

type AlertImage struct {
	Src  string `json:"src"`
	Href string `json:"href"`
	Alt  string `json:"alt"`
}

AlertImage represents event image

type AlertLink struct {
	Text string `json:"text"`
	Href string `json:"href"`
}

AlertLink represents event link

type AlertLogEntry

type AlertLogEntry struct {
	ID           int64  `json:"id"`
	Timestamp    string `json:"timestamp"` // Date time string in ISO format
	LogEntryType string `json:"logEntryType"`
	Text         string `json:"text"`
	AlertID      int64  `json:"alertId"`
}

AlertLogEntry definition

type AlertResponder

type AlertResponder struct {
	ID       int64  `json:"id"`
	Name     string `json:"name"`
	Group    string `json:"group"`
	Disabled bool   `json:"disabled"`
}

AlertResponder definition

type AlertSource

type AlertSource struct {
	ID                     int64                  `json:"id,omitempty"`
	Name                   string                 `json:"name"`
	IconURL                string                 `json:"iconUrl,omitempty"`
	LightIconURL           string                 `json:"lightIconUrl,omitempty"`
	DarkIconURL            string                 `json:"darkIconUrl,omitempty"`
	IntegrationType        string                 `json:"integrationType"`
	IntegrationKey         string                 `json:"integrationKey,omitempty"`
	IntegrationURL         string                 `json:"integrationUrl,omitempty"`
	AlertCreation          string                 `json:"alertCreation,omitempty"`
	IncidentCreation       string                 `json:"incidentCreation,omitempty"` // @deprecated
	EmailFiltered          bool                   `json:"emailFiltered,omitempty"`
	EmailResolveFiltered   bool                   `json:"emailResolveFiltered,omitempty"`
	Active                 bool                   `json:"active,omitempty"`
	Status                 string                 `json:"status,omitempty"`
	AutoResolutionTimeout  string                 `json:"autoResolutionTimeout,omitempty"` // e.g. PT4H
	EmailPredicates        []EmailPredicate       `json:"emailPredicates,omitempty"`
	EmailResolvePredicates []EmailPredicate       `json:"emailResolvePredicates,omitempty"`
	ResolveKeyExtractor    *EmailPredicate        `json:"resolveKeyExtractor,omitempty"`
	FilterOperator         string                 `json:"filterOperator,omitempty"`
	ResolveFilterOperator  string                 `json:"resolveFilterOperator,omitempty"`
	AlertPriorityRule      string                 `json:"alertPriorityRule,omitempty"`
	IncidentPriorityRule   string                 `json:"incidentPriorityRule,omitempty"` // @deprecated
	SupportHours           interface{}            `json:"supportHours,omitempty"`
	EscalationPolicy       *EscalationPolicy      `json:"escalationPolicy,omitempty"`
	Metadata               map[string]interface{} `json:"metadata,omitempty"`         // @deprecated
	AutotaskMetadata       *AutotaskMetadata      `json:"autotaskMetadata,omitempty"` // @deprecated
	Heartbeat              *Heartbeat             `json:"heartbeat,omitempty"`
	Teams                  []TeamShort            `json:"teams,omitempty"`
	SummaryTemplate        *Template              `json:"summaryTemplate,omitempty"`
	DetailsTemplate        *Template              `json:"detailsTemplate,omitempty"`
	RoutingTemplate        *Template              `json:"routingTemplate,omitempty"`
	LinkTemplates          []LinkTemplate         `json:"linkTemplates,omitempty"`
	PriorityTemplate       *PriorityTemplate      `json:"priorityTemplate,omitempty"`
	AlertGroupingWindow    string                 `json:"alertGroupingWindow,omitempty"` // e.g. PT4H
}

AlertSource definition

type AssignAlertInput

type AssignAlertInput struct {
	AlertID            *int64
	UserID             *int64
	Username           *string
	EscalationPolicyID *int64
	ScheduleID         *int64
	// contains filtered or unexported fields
}

AssignAlertInput represents the input of a AssignAlert operation.

type AssignAlertOutput

type AssignAlertOutput struct {
	Alert *Alert
	// contains filtered or unexported fields
}

AssignAlertOutput represents the output of a AssignAlert operation.

type AutomationRule

type AutomationRule struct {
	ID               string            `json:"id"`
	AlertType        string            `json:"alertType"`
	ResolveIncident  bool              `json:"resolveIncident"`
	ResolveService   bool              `json:"resolveService"`
	ServiceStatus    string            `json:"serviceStatus"`
	Template         *IncidentTemplate `json:"template"`
	Service          *Service          `json:"service"`
	AlertSource      *AlertSource      `json:"alertSource"`
	SendNotification bool              `json:"sendNotification"`
}

Legacy API - please use alert-actions of type 'automation_rule' - for more information see https://api.ilert.com/api-docs/#tag/Alert-Actions/paths/~1alert-actions/post

type AutotaskMetadata

type AutotaskMetadata struct {
	Username  string `json:"userName"`
	Secret    string `json:"secret"`
	WebServer string `json:"webServer"`
}

AutotaskMetadata definition

type BadRequestAPIError

type BadRequestAPIError struct {
	Status  int    `json:"status"`
	Message string `json:"message"`
	Code    string `json:"code"`
	// contains filtered or unexported fields
}

BadRequestAPIError describes not-found API response error e.g. resource deleted or never exists

func (*BadRequestAPIError) Error

func (aerr *BadRequestAPIError) Error() string

type CallRoutingNumber

type CallRoutingNumber struct {
	ID                  int          `json:"id"`
	Number              Phone        `json:"number"`
	VoiceLanguageLocale string       `json:"voiceLanguageLocale"`
	AlertSource         *AlertSource `json:"alertSource"`
}

CallRoutingNumber definition

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client wraps http client

func NewClient

func NewClient(options ...ClientOptions) *Client

NewClient creates an API client using an API token

func (*Client) AcceptAlert

func (c *Client) AcceptAlert(input *AcceptAlertInput) (*AcceptAlertOutput, error)

AcceptAlert accepts an alert with specified id. https://api.ilert.com/api-docs/#tag/Alerts/paths/~1alerts~1{id}~1accept/put

func (*Client) AddIncidentSubscribers

func (c *Client) AddIncidentSubscribers(input *AddIncidentSubscribersInput) (*AddIncidentSubscribersOutput, error)

AddIncidentSubscribers adds a new subscriber to an incident. https://api.ilert.com/api-docs/#tag/Incidents/paths/~1incidents~1{id}~1private-subscribers/post

func (*Client) AddScheduleShiftOverride

func (c *Client) AddScheduleShiftOverride(input *AddScheduleShiftOverrideInput) (*AddScheduleShiftOverrideOutput, error)

AddScheduleShiftOverride adds an override to a shift on the schedule. https://api.ilert.com/api-docs/#tag/Schedules/paths/~1schedules~1{id}~1overrides/put

func (*Client) AddServiceSubscribers

func (c *Client) AddServiceSubscribers(input *AddServiceSubscribersInput) (*AddServiceSubscribersOutput, error)

AddServiceSubscribers adds a new subscriber to a service. https://api.ilert.com/api-docs/#tag/Services/paths/~1services~1{id}~1private-subscribers/post

func (*Client) AddStatusPageSubscriber

func (c *Client) AddStatusPageSubscriber(input *AddStatusPageSubscribersInput) (*AddStatusPageSubscribersOutput, error)

AddStatusPageSubscriber adds a new subscriber to a status page. https://api.ilert.com/api-docs/#tag/Status-Pages/paths/~1status-pages~1{id}~1private-subscribers/post

func (*Client) AddStatusPageSubscribers

func (c *Client) AddStatusPageSubscribers(input *AddStatusPageSubscribersInput) (*AddStatusPageSubscribersOutput, error)

AddStatusPageSubscribers adds a new subscriber to an status page. https://api.ilert.com/api-docs/#tag/Status-Pages/paths/~1status-pages~1{id}~1private-subscribers/post

func (*Client) AssignAlert

func (c *Client) AssignAlert(input *AssignAlertInput) (*AssignAlertOutput, error)

AssignAlert assigns an alert with specified id to specified entities. https://api.ilert.com/api-docs/#tag/Alerts/paths/~1alerts~1{id}~1assign/put

func (*Client) CreateAlertAction

func (c *Client) CreateAlertAction(input *CreateAlertActionInput) (*CreateAlertActionOutput, error)

CreateAlertAction creates a new alert action. https://api.ilert.com/api-docs/#tag/Alert-Actions/paths/~1alert-actions/post

func (*Client) CreateAlertSource

func (c *Client) CreateAlertSource(input *CreateAlertSourceInput) (*CreateAlertSourceOutput, error)

CreateAlertSource creates a new alert source. https://api.ilert.com/api-docs/#tag/Alert-Sources/paths/~1alert-sources/post

func (*Client) CreateAutomationRule

func (c *Client) CreateAutomationRule(input *CreateAutomationRuleInput) (*CreateAutomationRuleOutput, error)

Legacy API - please use alert-actions of type 'automation_rule' - for more information see https://api.ilert.com/api-docs/#tag/Alert-Actions/paths/~1alert-actions/post

func (*Client) CreateConnection

func (c *Client) CreateConnection(input *CreateConnectionInput) (*CreateConnectionOutput, error)

Legacy API - please use alert-actions - for more information see https://docs.ilert.com/rest-api/api-version-history#renaming-connections-to-alert-actions

func (*Client) CreateConnector

func (c *Client) CreateConnector(input *CreateConnectorInput) (*CreateConnectorOutput, error)

CreateConnector creates a new connector. https://api.ilert.com/api-docs/#tag/Connectors/paths/~1connectors/post

func (*Client) CreateEscalationPolicy

func (c *Client) CreateEscalationPolicy(input *CreateEscalationPolicyInput) (*CreateEscalationPolicyOutput, error)

CreateEscalationPolicy creates a new escalation policy. https://api.ilert.com/api-docs/#tag/Escalation-Policies/paths/~1escalation-policies/post

func (*Client) CreateEvent

func (c *Client) CreateEvent(input *CreateEventInput) (*CreateEventOutput, error)

CreateEvent creates an alert event. https://api.ilert.com/api-docs/#tag/Events/paths/~1events/post

func (*Client) CreateIncident

func (c *Client) CreateIncident(input *CreateIncidentInput) (*CreateIncidentOutput, error)

CreateIncident creates a new incident. https://api.ilert.com/api-docs/#tag/Incidents/paths/~1incidents/post

func (*Client) CreateIncidentTemplate

func (c *Client) CreateIncidentTemplate(input *CreateIncidentTemplateInput) (*CreateIncidentTemplateOutput, error)

CreateIncidentTemplate creates a new incident template. https://api.ilert.com/api-docs/#tag/Incident-Templates/paths/~1incident-templates/post

func (*Client) CreateMetric

func (c *Client) CreateMetric(input *CreateMetricInput) (*CreateMetricOutput, error)

CreateMetric creates a new metric. https://api.ilert.com/api-docs/#tag/Metrics/paths/~1metrics/post

func (*Client) CreateMetricDataSource

func (c *Client) CreateMetricDataSource(input *CreateMetricDataSourceInput) (*CreateMetricDataSourceOutput, error)

CreateMetricDataSource creates a new metric data source. https://api.ilert.com/api-docs/#tag/Metric-Data-Sources/paths/~1metric-data-sources/post

func (*Client) CreateMultipleSeries

func (c *Client) CreateMultipleSeries(input *CreateMultipleSeriesInput) error

CreateMultipleSeries ingests multiple series for a metric. https://api.ilert.com/api-docs/#tag/Series/paths/~1series~1{key}/post

func (*Client) CreateSchedule

func (c *Client) CreateSchedule(input *CreateScheduleInput) (*CreateScheduleOutput, error)

CreateSchedule creates a new schedule. https://api.ilert.com/api-docs/#tag/Schedules/paths/~1schedules/post

func (*Client) CreateService

func (c *Client) CreateService(input *CreateServiceInput) (*CreateServiceOutput, error)

CreateService creates a new service. https://api.ilert.com/api-docs/#tag/Services/paths/~1services/post

func (*Client) CreateSingleSeries

func (c *Client) CreateSingleSeries(input *CreateSingleSeriesInput) error

CreateSingleSeries ingests a series for a metric. https://api.ilert.com/api-docs/#tag/Series/paths/~1series~1{key}/post

func (*Client) CreateStatusPage

func (c *Client) CreateStatusPage(input *CreateStatusPageInput) (*CreateStatusPageOutput, error)

CreateStatusPage creates a new status page. https://api.ilert.com/api-docs/#tag/Status-Pages/paths/~1status-pages/post

func (*Client) CreateStatusPageGroup

func (c *Client) CreateStatusPageGroup(input *CreateStatusPageGroupInput) (*CreateStatusPageGroupOutput, error)

CreateStatusPageGroup creates a new status page group. https://api.ilert.com/api-docs/#tag/Status-Pages/paths/~1status-pages~1{id}~1groups/post

func (*Client) CreateSupportHour added in v3.4.0

func (c *Client) CreateSupportHour(input *CreateSupportHourInput) (*CreateSupportHourOutput, error)

CreateSupportHour creates a new support hours resource. https://api.ilert.com/api-docs/#tag/Support-Hours/paths/~1support-hours/post

func (*Client) CreateTeam

func (c *Client) CreateTeam(input *CreateTeamInput) (*CreateTeamOutput, error)

CreateTeam creates a new team. https://api.ilert.com/api-docs/#tag/Teams/paths/~1teams/post

func (*Client) CreateUptimeMonitor

func (c *Client) CreateUptimeMonitor(input *CreateUptimeMonitorInput) (*CreateUptimeMonitorOutput, error)

CreateUptimeMonitor creates a new uptime monitor. https://api.ilert.com/api-docs/#tag/Uptime-Monitors/paths/~1uptime-monitors/post

func (*Client) CreateUser

func (c *Client) CreateUser(input *CreateUserInput) (*CreateUserOutput, error)

CreateUser creates a new user. Requires ADMIN privileges. https://api.ilert.com/api-docs/#tag/Users/paths/~1users/post

func (*Client) CreateUserAlertPreference

func (c *Client) CreateUserAlertPreference(input *CreateUserAlertPreferenceInput) (*CreateUserAlertPreferenceOutput, error)

CreateUserAlertPreference creates a new alert notification preference for a user. Requires ADMIN privileges or user id equals your current user. https://api.ilert.com/api-docs/#tag/Notification-Preferences/paths/~1users~1{user-id}~1notification-preferences~1alerts/post

func (*Client) CreateUserDutyPreference

func (c *Client) CreateUserDutyPreference(input *CreateUserDutyPreferenceInput) (*CreateUserDutyPreferenceOutput, error)

CreateUserDutyPreference creates a new duty notification preference for a user. Requires ADMIN privileges or user id equals your current user. https://api.ilert.com/api-docs/#tag/Notification-Preferences/paths/~1users~1{user-id}~1notification-preferences~1duties/post

func (*Client) CreateUserEmailContact

func (c *Client) CreateUserEmailContact(input *CreateUserEmailContactInput) (*CreateUserEmailContactOutput, error)

CreateUserEmailContact creates a new email contact for a user. Requires ADMIN privileges or user id equals your current user. https://api.ilert.com/api-docs/#tag/Contacts/paths/~1users~1{user-id}~1contacts~1emails/post

func (*Client) CreateUserPhoneNumberContact

func (c *Client) CreateUserPhoneNumberContact(input *CreateUserPhoneNumberContactInput) (*CreateUserPhoneNumberContactOutput, error)

CreateUserPhoneNumberContact creates a new phone number contact for a user. Requires ADMIN privileges or user id equals your current user. https://api.ilert.com/api-docs/#tag/Contacts/paths/~1users~1{user-id}~1contacts~1phone-numbers/post

func (*Client) CreateUserSubscriptionPreference

func (c *Client) CreateUserSubscriptionPreference(input *CreateUserSubscriptionPreferenceInput) (*CreateUserSubscriptionPreferenceOutput, error)

CreateUserSubscriptionPreference creates a new subscription notification preference for a user. Requires ADMIN privileges or user id equals your current user. https://api.ilert.com/api-docs/#tag/Notification-Preferences/paths/~1users~1{user-id}~1notification-preferences~1subscriptions/post

func (*Client) CreateUserUpdatePreference

func (c *Client) CreateUserUpdatePreference(input *CreateUserUpdatePreferenceInput) (*CreateUserUpdatePreferenceOutput, error)

CreateUserUpdatePreference creates a new update notification preference for a user. Requires ADMIN privileges or user id equals your current user. https://api.ilert.com/api-docs/#tag/Notification-Preferences/paths/~1users~1{user-id}~1notification-preferences~1updates/post

func (*Client) DeleteAlertAction

func (c *Client) DeleteAlertAction(input *DeleteAlertActionInput) (*DeleteAlertActionOutput, error)

DeleteAlertAction deletes the specified alert action. https://api.ilert.com/api-docs/#tag/Alert-Actions/paths/~1alert-actions~1{id}/delete

func (*Client) DeleteAlertSource

func (c *Client) DeleteAlertSource(input *DeleteAlertSourceInput) (*DeleteAlertSourceOutput, error)

DeleteAlertSource deletes the specified alert source. https://api.ilert.com/api-docs/#tag/Alert-Sources/paths/~1alert-sources~1{id}/delete

func (*Client) DeleteAutomationRule

func (c *Client) DeleteAutomationRule(input *DeleteAutomationRuleInput) (*DeleteAutomationRuleOutput, error)

Legacy API - please use alert-actions of type 'automation_rule' - for more information see https://api.ilert.com/api-docs/#tag/Alert-Actions/paths/~1alert-actions/post

func (*Client) DeleteConnection

func (c *Client) DeleteConnection(input *DeleteConnectionInput) (*DeleteConnectionOutput, error)

Legacy API - please use alert-actions - for more information see https://docs.ilert.com/rest-api/api-version-history#renaming-connections-to-alert-actions

func (*Client) DeleteConnector

func (c *Client) DeleteConnector(input *DeleteConnectorInput) (*DeleteConnectorOutput, error)

DeleteConnector deletes the specified connector. https://api.ilert.com/api-docs/#tag/Connectors/paths/~1connectors~1{id}/delete

func (*Client) DeleteEscalationPolicy

func (c *Client) DeleteEscalationPolicy(input *DeleteEscalationPolicyInput) (*DeleteEscalationPolicyOutput, error)

DeleteEscalationPolicy deletes the specified escalation policy. https://api.ilert.com/api-docs/#tag/Escalation-Policies/paths/~1escalation-policies~1{id}/delete

func (*Client) DeleteIncidentTemplate

func (c *Client) DeleteIncidentTemplate(input *DeleteIncidentTemplateInput) (*DeleteIncidentTemplateOutput, error)

DeleteIncidentTemplate deletes the specified incident template. https://api.ilert.com/api-docs/#tag/Incident-Templates/paths/~1incident-templates~1{id}/delete

func (*Client) DeleteMetric

func (c *Client) DeleteMetric(input *DeleteMetricInput) (*DeleteMetricOutput, error)

DeleteMetric deletes the specified metric. https://api.ilert.com/api-docs/#tag/Metrics/paths/~1metrics~1{id}/delete

func (*Client) DeleteMetricDataSource

func (c *Client) DeleteMetricDataSource(input *DeleteMetricDataSourceInput) (*DeleteMetricDataSourceOutput, error)

DeleteMetricDataSource deletes the specified metric data source. https://api.ilert.com/api-docs/#tag/Metric-Data-Sources/paths/~1metric-data-sources~1{id}/delete

func (*Client) DeleteSchedule

func (c *Client) DeleteSchedule(input *DeleteScheduleInput) (*DeleteScheduleOutput, error)

DeleteSchedule deletes the specified schedule. https://api.ilert.com/api-docs/#tag/Schedules/paths/~1schedules~1{id}/delete

func (*Client) DeleteService

func (c *Client) DeleteService(input *DeleteServiceInput) (*DeleteServiceOutput, error)

DeleteService deletes the specified service. https://api.ilert.com/api-docs/#tag/Services/paths/~1services~1{id}/delete

func (*Client) DeleteStatusPage

func (c *Client) DeleteStatusPage(input *DeleteStatusPageInput) (*DeleteStatusPageOutput, error)

DeleteStatusPage deletes the specified status page. https://api.ilert.com/api-docs/#tag/Status-Pages/paths/~1status-pages~1{id}/delete

func (*Client) DeleteStatusPageGroup

func (c *Client) DeleteStatusPageGroup(input *DeleteStatusPageGroupInput) (*DeleteStatusPageGroupOutput, error)

DeleteStatusPageGroup deletes the specified status page group. https://api.ilert.com/api-docs/#tag/Status-Pages/paths/~1status-pages~1{id}~1groups~1{group-id}/delete

func (*Client) DeleteStatusSubscriberPage

func (c *Client) DeleteStatusSubscriberPage(input *DeleteStatusPageSubscriberInput) (*DeleteStatusPageSubscriberOutput, error)

DeleteStatusPageSubscriber deletes a subscriber of the specified status page. https://api.ilert.com/api-docs/#tag/Status-Pages/paths/~1status-pages~1{id}/delete

func (*Client) DeleteSupportHour added in v3.4.0

func (c *Client) DeleteSupportHour(input *DeleteSupportHourInput) (*DeleteSupportHourOutput, error)

DeleteSupportHour deletes the specified support hours resource. https://api.ilert.com/api-docs/#tag/Support-Hours/paths/~1support-hours~1{id}/delete

func (*Client) DeleteTeam

func (c *Client) DeleteTeam(input *DeleteTeamInput) (*DeleteTeamOutput, error)

DeleteTeam deletes the specified team. https://api.ilert.com/api-docs/#tag/Teams/paths/~1teams~1{id}/delete

func (*Client) DeleteUptimeMonitor

func (c *Client) DeleteUptimeMonitor(input *DeleteUptimeMonitorInput) (*DeleteUptimeMonitorOutput, error)

DeleteUptimeMonitor deletes the specified uptime monitor. https://api.ilert.com/api-docs/#tag/Uptime-Monitors/paths/~1uptime-monitors~1{id}/delete

func (*Client) DeleteUser

func (c *Client) DeleteUser(input *DeleteUserInput) (*DeleteUserOutput, error)

DeleteUser deletes the specified user. https://api.ilert.com/api-docs/#tag/Users/paths/~1users~1{user-id}/delete

func (*Client) DeleteUserAlertPreference

func (c *Client) DeleteUserAlertPreference(input *DeleteUserAlertPreferenceInput) (*DeleteUserAlertPreferenceOutput, error)

DeleteUserAlertPreference deletes the specified alert notification preference of a user. https://api.ilert.com/api-docs/#tag/Notification-Preferences/paths/~1users~1{user-id}~1notification-preferences~1alerts~1{id}/delete

func (*Client) DeleteUserDutyPreference

func (c *Client) DeleteUserDutyPreference(input *DeleteUserDutyPreferenceInput) (*DeleteUserDutyPreferenceOutput, error)

DeleteUserDutyPreference deletes the specified duty notification preference of a user. https://api.ilert.com/api-docs/#tag/Notification-Preferences/paths/~1users~1{user-id}~1notification-preferences~1duties~1{id}/delete

func (*Client) DeleteUserEmailContact

func (c *Client) DeleteUserEmailContact(input *DeleteUserEmailContactInput) (*DeleteUserEmailContactOutput, error)

DeleteUserEmailContact deletes the specified email contact of a user. https://api.ilert.com/api-docs/#tag/Contacts/paths/~1users~1{user-id}~1contacts~1emails~1{id}/delete

func (*Client) DeleteUserPhoneNumberContact

func (c *Client) DeleteUserPhoneNumberContact(input *DeleteUserPhoneNumberContactInput) (*DeleteUserPhoneNumberContactOutput, error)

DeleteUserPhoneNumberContact deletes the specified phone number contact of a user. https://api.ilert.com/api-docs/#tag/Contacts/paths/~1users~1{user-id}~1contacts~1phone-numbers~1{id}/delete

func (*Client) DeleteUserSubscriptionPreference

func (c *Client) DeleteUserSubscriptionPreference(input *DeleteUserSubscriptionPreferenceInput) (*DeleteUserSubscriptionPreferenceOutput, error)

DeleteUserSubscriptionPreference deletes the specified subscription notification preference of a user. https://api.ilert.com/api-docs/#tag/Notification-Preferences/paths/~1users~1{user-id}~1notification-preferences~1subscriptions~1{id}/delete

func (*Client) DeleteUserUpdatePreference

func (c *Client) DeleteUserUpdatePreference(input *DeleteUserUpdatePreferenceInput) (*DeleteUserUpdatePreferenceOutput, error)

DeleteUserUpdatePreference deletes the specified update notification preference of a user. https://api.ilert.com/api-docs/#tag/Notification-Preferences/paths/~1users~1{user-id}~1notification-preferences~1updates~1{id}/delete

func (*Client) GetAlert

func (c *Client) GetAlert(input *GetAlertInput) (*GetAlertOutput, error)

GetAlert gets the alert with specified id. https://api.ilert.com/api-docs/#tag/Alerts/paths/~1alerts~1{id}/get

func (*Client) GetAlertAction

func (c *Client) GetAlertAction(input *GetAlertActionInput) (*GetAlertActionOutput, error)

GetAlertAction gets the alert action with specified id. https://api.ilert.com/api-docs/#tag/Alert-Actions/paths/~1alert-actions~1{id}/get

func (*Client) GetAlertActions

func (c *Client) GetAlertActions(input *GetAlertActionsInput) (*GetAlertActionsOutput, error)

GetAlertActions lists existing alert actions. https://api.ilert.com/api-docs/#tag/Alert-Actions/paths/~1alert-actions/get

func (*Client) GetAlertLogEntries

func (c *Client) GetAlertLogEntries(input *GetAlertLogEntriesInput) (*GetAlertLogEntriesOutput, error)

GetAlertLogEntries gets log entries for the specified alert. https://api.ilert.com/api-docs/#tag/Alerts/paths/~1alerts~1{id}~1log-entries/get

func (*Client) GetAlertResponder

func (c *Client) GetAlertResponder(input *GetAlertResponderInput) (*GetAlertResponderOutput, error)

GetAlertResponder gets the responders on the alert with specified id. https://api.ilert.com/api-docs/#tag/Alerts/paths/~1alerts~1{id}~1suggested-responders/get

func (*Client) GetAlertSource

func (c *Client) GetAlertSource(input *GetAlertSourceInput) (*GetAlertSourceOutput, error)

GetAlertSource gets the alert source with specified id. https://api.ilert.com/api-docs/#tag/Alert-Sources/paths/~1alert-sources~1{id}/get

func (*Client) GetAlertSources

func (c *Client) GetAlertSources(input *GetAlertSourcesInput) (*GetAlertSourcesOutput, error)

GetAlertSources lists existing alert sources. https://api.ilert.com/api-docs/#tag/Alert-Sources/paths/~1alert-sources/get

func (*Client) GetAlerts

func (c *Client) GetAlerts(input *GetAlertsInput) (*GetAlertsOutput, error)

GetAlerts lists existing alerts. https://api.ilert.com/api-docs/#tag/Alerts/paths/~1alerts/get

func (*Client) GetAlertsCount

func (c *Client) GetAlertsCount(input *GetAlertsCountInput) (*GetAlertsCountOutput, error)

GetAlertsCount gets the alert count. https://api.ilert.com/api-docs/#tag/Alerts/paths/~1alerts~1count/get

func (*Client) GetAutomationRule

func (c *Client) GetAutomationRule(input *GetAutomationRuleInput) (*GetAutomationRuleOutput, error)

Legacy API - please use alert-actions of type 'automation_rule' - for more information see https://api.ilert.com/api-docs/#tag/Alert-Actions/paths/~1alert-actions/post

func (*Client) GetAutomationRules

func (c *Client) GetAutomationRules(input *GetAutomationRulesInput) (*GetAutomationRulesOutput, error)

Legacy API - please use alert-actions of type 'automation_rule' - for more information see https://api.ilert.com/api-docs/#tag/Alert-Actions/paths/~1alert-actions/post

func (*Client) GetConnection

func (c *Client) GetConnection(input *GetConnectionInput) (*GetConnectionOutput, error)

Legacy API - please use alert-actions - for more information see https://docs.ilert.com/rest-api/api-version-history#renaming-connections-to-alert-actions

func (*Client) GetConnections

func (c *Client) GetConnections(input *GetConnectionsInput) (*GetConnectionsOutput, error)

Legacy API - please use alert-actions - for more information see https://docs.ilert.com/rest-api/api-version-history#renaming-connections-to-alert-actions

func (*Client) GetConnector

func (c *Client) GetConnector(input *GetConnectorInput) (*GetConnectorOutput, error)

GetConnector gets the connector with specified id. https://api.ilert.com/api-docs/#tag/Connectors/paths/~1connectors~1{id}/get

func (*Client) GetConnectors

func (c *Client) GetConnectors(input *GetConnectorsInput) (*GetConnectorsOutput, error)

GetConnectors lists existing connectors. https://api.ilert.com/api-docs/#tag/Connectors/paths/~1connectors/get

func (*Client) GetCurrentUser

func (c *Client) GetCurrentUser() (*GetUserOutput, error)

GetCurrentUser gets the currently authenticated user. https://api.ilert.com/api-docs/#tag/Users/paths/~1users~1current/get

func (*Client) GetEscalationPolicies

func (c *Client) GetEscalationPolicies(input *GetEscalationPoliciesInput) (*GetEscalationPoliciesOutput, error)

GetEscalationPolicies lists existing escalation policies. https://api.ilert.com/api-docs/#tag/Escalation-Policies/paths/~1escalation-policies/get

func (*Client) GetEscalationPolicy

func (c *Client) GetEscalationPolicy(input *GetEscalationPolicyInput) (*GetEscalationPolicyOutput, error)

GetEscalationPolicy gets the escalation policy with specified id. https://api.ilert.com/api-docs/#tag/Escalation-Policies/paths/~1escalation-policies~1{id}/get

func (*Client) GetIncident

func (c *Client) GetIncident(input *GetIncidentInput) (*GetIncidentOutput, error)

GetIncident gets an incident by id. https://api.ilert.com/api-docs/#tag/Incidents/paths/~1incidents~1{id}/get

func (*Client) GetIncidentAffected

func (c *Client) GetIncidentAffected(input *GetIncidentAffectedInput) (*GetIncidentAffectedOutput, error)

GetIncidentAffected forecasts the affected subscribers and status pages. https://api.ilert.com/api-docs/#tag/Incidents/paths/~1incidents~1publish-info/post

func (*Client) GetIncidentSubscribers

func (c *Client) GetIncidentSubscribers(input *GetIncidentSubscribersInput) (*GetIncidentSubscribersOutput, error)

GetIncidentSubscribers gets subscribers of an incident by id. https://api.ilert.com/api-docs/#tag/Incidents/paths/~1incidents~1{id}~1private-subscribers/get

func (*Client) GetIncidentTemplate

func (c *Client) GetIncidentTemplate(input *GetIncidentTemplateInput) (*GetIncidentTemplateOutput, error)

GetIncidentTemplate gets a incidentTemplate by id. https://api.ilert.com/api-docs/#tag/Incident-Templates/paths/~1incident-templates~1{id}/get

func (*Client) GetIncidentTemplates

func (c *Client) GetIncidentTemplates(input *GetIncidentTemplatesInput) (*GetIncidentTemplatesOutput, error)

GetIncidentTemplates lists existing incident templates. https://api.ilert.com/api-docs/#tag/Incident-Templates/paths/~1incident-templates/get

func (*Client) GetIncidents

func (c *Client) GetIncidents(input *GetIncidentsInput) (*GetIncidentsOutput, error)

GetIncidents lists existing incidents. https://api.ilert.com/api-docs/#tag/Incidents/paths/~1incidents/get

func (*Client) GetMetric

func (c *Client) GetMetric(input *GetMetricInput) (*GetMetricOutput, error)

GetMetric gets a metric by id. https://api.ilert.com/api-docs/#tag/Metrics/paths/~1metrics~1{id}/get

func (*Client) GetMetricDataSource

func (c *Client) GetMetricDataSource(input *GetMetricDataSourceInput) (*GetMetricDataSourceOutput, error)

GetMetricDataSource gets a metric data source by ID. https://api.ilert.com/api-docs/#tag/Metric-Data-Sources/paths/~1metric-data-sources~1{id}/get

func (*Client) GetMetricDataSources

func (c *Client) GetMetricDataSources(input *GetMetricDataSourcesInput) (*GetMetricDataSourcesOutput, error)

GetMetricDataSources lists existing metric data sources. https://api.ilert.com/api-docs/#tag/Metric-Data-Sources/paths/~1metric-data-sources/get

func (*Client) GetMetrics

func (c *Client) GetMetrics(input *GetMetricsInput) (*GetMetricsOutput, error)

GetMetrics lists existing metrics. https://api.ilert.com/api-docs/#tag/Metrics/paths/~1metrics/get

func (*Client) GetNumbers

func (c *Client) GetNumbers(input *GetNumbersInput) (*GetNumbersOutput, error)

GetNumbers gets list available ilert phone numbers. https://api.ilert.com/api-docs/#tag/Numbers/paths/~1numbers/get

func (*Client) GetSchedule

func (c *Client) GetSchedule(input *GetScheduleInput) (*GetScheduleOutput, error)

GetSchedule gets the on-call schedule with the specified id. https://api.ilert.com/api-docs/#tag/Schedules/paths/~1schedules~1{id}/get

func (*Client) GetScheduleOverrides

func (c *Client) GetScheduleOverrides(input *GetScheduleOverridesInput) (*GetScheduleOverridesOutput, error)

GetScheduleOverrides lists overrides for the specified schedule. https://api.ilert.com/api-docs/#tag/Schedules/paths/~1schedules~1{id}~1overrides/get

func (*Client) GetScheduleShifts

func (c *Client) GetScheduleShifts(input *GetScheduleShiftsInput) (*GetScheduleShiftsOutput, error)

GetScheduleShifts lists shifts for the specified schedule and date range. https://api.ilert.com/api-docs/#tag/Schedules/paths/~1schedules~1{id}~1shifts/get

func (*Client) GetScheduleUserOnCall

func (c *Client) GetScheduleUserOnCall(input *GetScheduleUserOnCallInput) (*GetScheduleUserOnCallOutput, error)

GetScheduleUserOnCall gets the current user on call for specified schedule. https://api.ilert.com/api-docs/#tag/Schedules/paths/~1schedules~1{id}~1user-on-call/get

func (*Client) GetSchedules

func (c *Client) GetSchedules(input *GetSchedulesInput) (*GetSchedulesOutput, error)

GetSchedules lists existing on-call schedules. https://api.ilert.com/api-docs/#tag/Schedules/paths/~1schedules/get

func (*Client) GetService

func (c *Client) GetService(input *GetServiceInput) (*GetServiceOutput, error)

GetService gets a service by id. https://api.ilert.com/api-docs/#tag/Services/paths/~1services~1{id}/get

func (*Client) GetServiceSubscribers

func (c *Client) GetServiceSubscribers(input *GetServiceSubscribersInput) (*GetServiceSubscribersOutput, error)

GetServiceSubscribers gets subscribers of a service by id. https://api.ilert.com/api-docs/#tag/Services/paths/~1services~1{id}~1private-subscribers/get

func (*Client) GetServices

func (c *Client) GetServices(input *GetServicesInput) (*GetServicesOutput, error)

GetServices lists existing services. https://api.ilert.com/api-docs/#tag/Services/paths/~1services/get

func (*Client) GetStatusPage

func (c *Client) GetStatusPage(input *GetStatusPageInput) (*GetStatusPageOutput, error)

GetStatusPage gets a status page by id. https://api.ilert.com/api-docs/#tag/Status-Pages/paths/~1status-pages~1{id}/get

func (*Client) GetStatusPageGroup

func (c *Client) GetStatusPageGroup(input *GetStatusPageGroupInput) (*GetStatusPageGroupOutput, error)

GetStatusPageGroup gets the status page group with specified id. https://api.ilert.com/api-docs/#tag/Status-Pages/paths/~1status-pages~1{id}~1groups~1{group-id}/get

func (*Client) GetStatusPageGroups

func (c *Client) GetStatusPageGroups(input *GetStatusPageGroupsInput) (*GetStatusPageGroupsOutput, error)

GetStatusPageGroups lists existing status page groups. https://api.ilert.com/api-docs/#tag/Status-Pages/paths/~1status-pages~1{id}~1groups/get

func (*Client) GetStatusPageSubscribers

func (c *Client) GetStatusPageSubscribers(input *GetStatusPageSubscribersInput) (*GetStatusPageSubscribersOutput, error)

GetStatusPageSubscribers gets subscribers of a status page by id. https://api.ilert.com/api-docs/#tag/Status-Pages/paths/~1status-pages~1{id}~1private-subscribers/get

func (*Client) GetStatusPages

func (c *Client) GetStatusPages(input *GetStatusPagesInput) (*GetStatusPagesOutput, error)

GetStatusPages lists existing status page. https://api.ilert.com/api-docs/#tag/Status-Pages/paths/~1status-pages/get

func (*Client) GetSupportHour added in v3.4.0

func (c *Client) GetSupportHour(input *GetSupportHourInput) (*GetSupportHourOutput, error)

GetSupportHour gets the support hours resource with specified id. https://api.ilert.com/api-docs/#tag/Support-Hours/paths/~1support-hours~1{id}/get

func (*Client) GetSupportHours added in v3.4.0

func (c *Client) GetSupportHours(input *GetSupportHoursInput) (*GetSupportHoursOutput, error)

GetSupportHours lists existing support hours resources. https://api.ilert.com/api-docs/#tag/Support-Hours/paths/~1support-hours/get

func (*Client) GetTeam

func (c *Client) GetTeam(input *GetTeamInput) (*GetTeamOutput, error)

GetTeam gets the team with specified id. https://api.ilert.com/api-docs/#tag/Teams/paths/~1teams~1{id}/get

func (*Client) GetTeams

func (c *Client) GetTeams(input *GetTeamsInput) (*GetTeamsOutput, error)

GetTeams lists existing teams. https://api.ilert.com/api-docs/#tag/Teams/paths/~1teams/get

func (*Client) GetUptimeMonitor

func (c *Client) GetUptimeMonitor(input *GetUptimeMonitorInput) (*GetUptimeMonitorOutput, error)

GetUptimeMonitor gets the uptime monitor with specified id. https://api.ilert.com/api-docs/#tag/Uptime-Monitors/paths/~1uptime-monitors~1{id}/get

func (*Client) GetUptimeMonitors

func (c *Client) GetUptimeMonitors(input *GetUptimeMonitorsInput) (*GetUptimeMonitorsOutput, error)

GetUptimeMonitors lists existing uptime monitors. https://api.ilert.com/api-docs/#tag/Uptime-Monitors/paths/~1uptime-monitors/get

func (*Client) GetUptimeMonitorsCount

func (c *Client) GetUptimeMonitorsCount(input *GetUptimeMonitorsCountInput) (*GetUptimeMonitorsCountOutput, error)

GetUptimeMonitorsCount gets the count of uptime monitors. https://api.ilert.com/api-docs/#tag/Uptime-Monitors/paths/~1uptime-monitors~1count/get

func (*Client) GetUser

func (c *Client) GetUser(input *GetUserInput) (*GetUserOutput, error)

GetUser gets the user with specified id or username. https://api.ilert.com/api-docs/#tag/Users/paths/~1users~1{user-id}/get

func (*Client) GetUserAlertPreference

func (c *Client) GetUserAlertPreference(input *GetUserAlertPreferenceInput) (*GetUserAlertPreferenceOutput, error)

GetUserAlertPreference gets an alert notification preference of a user by id. https://api.ilert.com/api-docs/#tag/Notification-Preferences/paths/~1users~1{user-id}~1notification-preferences~1alerts~1{id}/get

func (*Client) GetUserAlertPreferences

func (c *Client) GetUserAlertPreferences(input *GetUserAlertPreferencesInput) (*GetUserAlertPreferencesOutput, error)

GetUserAlertPreferences lists existing alert notification preferences of a user. https://api.ilert.com/api-docs/#tag/Notification-Preferences/paths/~1users~1{user-id}~1notification-preferences~1alerts/get

func (*Client) GetUserDutyPreferences

func (c *Client) GetUserDutyPreferences(input *GetUserDutyPreferencesInput) (*GetUserDutyPreferencesOutput, error)

GetUserDutyPreferences lists existing duty notification preferences of a user. https://api.ilert.com/api-docs/#tag/Notification-Preferences/paths/~1users~1{user-id}~1notification-preferences~1duties/get

func (*Client) GetUserEmailContact

func (c *Client) GetUserEmailContact(input *GetUserEmailContactInput) (*GetUserEmailContactOutput, error)

GetUserEmailContact gets an email contact of a user by id. https://api.ilert.com/api-docs/#tag/Contacts/paths/~1users~1{user-id}~1contacts~1emails~1{id}/get

func (*Client) GetUserEmailContacts

func (c *Client) GetUserEmailContacts(input *GetUserEmailContactsInput) (*GetUserEmailContactsOutput, error)

GetUserEmailContacts lists existing email contacts of a user. https://api.ilert.com/api-docs/#tag/Contacts/paths/~1users~1{user-id}~1contacts~1emails/get

func (*Client) GetUserPhoneNumberContact

func (c *Client) GetUserPhoneNumberContact(input *GetUserPhoneNumberContactInput) (*GetUserPhoneNumberContactOutput, error)

GetUserPhoneNumberContact gets a phone number contact of a user by id. https://api.ilert.com/api-docs/#tag/Contacts/paths/~1users~1{user-id}~1contacts~1phone-numbers~1{id}/get

func (*Client) GetUserPhoneNumberContacts

func (c *Client) GetUserPhoneNumberContacts(input *GetUserPhoneNumberContactsInput) (*GetUserPhoneNumberContactsOutput, error)

GetUserPhoneNumberContacts lists existing phone number contacts of a user. https://api.ilert.com/api-docs/#tag/Contacts/paths/~1users~1{user-id}~1contacts~1phone-numbers/get

func (*Client) GetUserSubscriptionPreference

func (c *Client) GetUserSubscriptionPreference(input *GetUserSubscriptionPreferenceInput) (*GetUserSubscriptionPreferenceOutput, error)

GetUserSubscriptionPreference gets an subscription notification preference of a user by id. https://api.ilert.com/api-docs/#tag/Notification-Preferences/paths/~1users~1{user-id}~1notification-preferences~1subscriptions~1{id}/get

func (*Client) GetUserSubscriptionPreferences

func (c *Client) GetUserSubscriptionPreferences(input *GetUserSubscriptionPreferencesInput) (*GetUserSubscriptionPreferencesOutput, error)

GetUserSubscriptionPreferences lists existing subscription notification preferences of a user. https://api.ilert.com/api-docs/#tag/Notification-Preferences/paths/~1users~1{user-id}~1notification-preferences~1subscriptions/get

func (*Client) GetUserUpdatePreference

func (c *Client) GetUserUpdatePreference(input *GetUserUpdatePreferenceInput) (*GetUserUpdatePreferenceOutput, error)

GetUserUpdatePreference gets an update notification preference of a user by id. https://api.ilert.com/api-docs/#tag/Notification-Preferences/paths/~1users~1{user-id}~1notification-preferences~1updates~1{id}/get

func (*Client) GetUserUpdatePreferences

func (c *Client) GetUserUpdatePreferences(input *GetUserUpdatePreferencesInput) (*GetUserUpdatePreferencesOutput, error)

GetUserUpdatePreferences lists existing update notification preferences of a user. https://api.ilert.com/api-docs/#tag/Notification-Preferences/paths/~1users~1{user-id}~1notification-preferences~1updates/get

func (*Client) GetUsers

func (c *Client) GetUsers(input *GetUsersInput) (*GetUsersOutput, error)

GetUsers lists existing users. https://api.ilert.com/api-docs/#tag/Users/paths/~1users/get

func (*Client) PingHeartbeat

func (c *Client) PingHeartbeat(input *PingHeartbeatInput) (*PingHeartbeatOutput, error)

PingHeartbeat gets list available ilert phone numbers. https://api.ilert.com/api-docs/#tag/Heartbeats/paths/~1heartbeats~1{key}/get

func (*Client) ResolveAlert

func (c *Client) ResolveAlert(input *ResolveAlertInput) (*ResolveAlertOutput, error)

ResolveAlert resolves an alert with specified id. https://api.ilert.com/api-docs/#tag/Alerts/paths/~1alerts~1{id}~1resolve/put

func (*Client) SearchAlertAction

func (c *Client) SearchAlertAction(input *SearchAlertActionInput) (*SearchAlertActionOutput, error)

SearchAlertAction gets the alert action with specified name.

func (*Client) SearchAlertSource

func (c *Client) SearchAlertSource(input *SearchAlertSourceInput) (*SearchAlertSourceOutput, error)

SearchAlertSource gets the alert source with specified name.

func (*Client) SearchConnector

func (c *Client) SearchConnector(input *SearchConnectorInput) (*SearchConnectorOutput, error)

SearchConnector gets the connector with specified name.

func (*Client) SearchEscalationPolicy

func (c *Client) SearchEscalationPolicy(input *SearchEscalationPolicyInput) (*SearchEscalationPolicyOutput, error)

SearchEscalationPolicy gets the escalationPolicy with specified name.

func (*Client) SearchIncidentTemplate

func (c *Client) SearchIncidentTemplate(input *SearchIncidentTemplateInput) (*SearchIncidentTemplateOutput, error)

SearchIncidentTemplate gets the incident template with specified name.

func (*Client) SearchMetric

func (c *Client) SearchMetric(input *SearchMetricInput) (*SearchMetricOutput, error)

SearchMetric gets the metric with specified name.

func (*Client) SearchMetricDataSource

func (c *Client) SearchMetricDataSource(input *SearchMetricDataSourceInput) (*SearchMetricDataSourceOutput, error)

SearchMetricDataSource gets the metric data source with specified name.

func (*Client) SearchSchedule

func (c *Client) SearchSchedule(input *SearchScheduleInput) (*SearchScheduleOutput, error)

SearchSchedule gets the schedule with specified name.

func (*Client) SearchService

func (c *Client) SearchService(input *SearchServiceInput) (*SearchServiceOutput, error)

SearchService gets the service with specified name.

func (*Client) SearchStatusPage

func (c *Client) SearchStatusPage(input *SearchStatusPageInput) (*SearchStatusPageOutput, error)

SearchStatusPage gets the status page with specified name.

func (*Client) SearchStatusPageGroup

func (c *Client) SearchStatusPageGroup(input *SearchStatusPageGroupInput) (*SearchStatusPageGroupOutput, error)

SearchStatusPageGroup gets the status page group with specified name.

func (*Client) SearchSupportHour added in v3.4.0

func (c *Client) SearchSupportHour(input *SearchSupportHourInput) (*SearchSupportHourOutput, error)

SearchSupportHour gets the support hours resource with specified name.

func (*Client) SearchTeam

func (c *Client) SearchTeam(input *SearchTeamInput) (*SearchTeamOutput, error)

SearchTeam gets the team with specified name.

func (*Client) SearchUptimeMonitor

func (c *Client) SearchUptimeMonitor(input *SearchUptimeMonitorInput) (*SearchUptimeMonitorOutput, error)

SearchUptimeMonitor gets the uptime monitor with specified name.

func (*Client) SearchUser

func (c *Client) SearchUser(input *SearchUserInput) (*SearchUserOutput, error)

SearchUser gets the user with specified name.

func (*Client) SearchUserEmailContact

func (c *Client) SearchUserEmailContact(input *SearchUserEmailContactInput) (*SearchUserEmailContactOutput, error)

SearchUserEmailContact gets the email contact with specified target of a user.

func (*Client) SearchUserPhoneNumberContact

func (c *Client) SearchUserPhoneNumberContact(input *SearchUserPhoneNumberContactInput) (*SearchUserPhoneNumberContactOutput, error)

SearchUserPhoneNumberContact gets the phone number contact with specified target of a user.

func (*Client) UpdateAlertAction

func (c *Client) UpdateAlertAction(input *UpdateAlertActionInput) (*UpdateAlertActionOutput, error)

UpdateAlertAction updates an existing alert action. https://api.ilert.com/api-docs/#tag/Alert-Actions/paths/~1alert-actions~1{id}/put

func (*Client) UpdateAlertSource

func (c *Client) UpdateAlertSource(input *UpdateAlertSourceInput) (*UpdateAlertSourceOutput, error)

UpdateAlertSource updates an existing alert source. https://api.ilert.com/api-docs/#tag/Alert-Sources/paths/~1alert-sources~1{id}/put

func (*Client) UpdateAutomationRule

func (c *Client) UpdateAutomationRule(input *UpdateAutomationRuleInput) (*UpdateAutomationRuleOutput, error)

Legacy API - please use alert-actions of type 'automation_rule' - for more information see https://api.ilert.com/api-docs/#tag/Alert-Actions/paths/~1alert-actions/post

func (*Client) UpdateConnection

func (c *Client) UpdateConnection(input *UpdateConnectionInput) (*UpdateConnectionOutput, error)

Legacy API - please use alert-actions - for more information see https://docs.ilert.com/rest-api/api-version-history#renaming-connections-to-alert-actions

func (*Client) UpdateConnector

func (c *Client) UpdateConnector(input *UpdateConnectorInput) (*UpdateConnectorOutput, error)

UpdateConnector updates an existing connector. https://api.ilert.com/api-docs/#tag/Connectors/paths/~1connectors~1{id}/put

func (*Client) UpdateCurrentUser

func (c *Client) UpdateCurrentUser(input *UpdateUserInput) (*UpdateUserOutput, error)

UpdateCurrentUser updates the currently authenticated user. https://api.ilert.com/api-docs/#tag/Users/paths/~1users~1current/put

func (*Client) UpdateEscalationPolicy

func (c *Client) UpdateEscalationPolicy(input *UpdateEscalationPolicyInput) (*UpdateEscalationPolicyOutput, error)

UpdateEscalationPolicy updates an existing escalation policy. https://api.ilert.com/api-docs/#tag/Escalation-Policies/paths/~1escalation-policies~1{id}/put

func (*Client) UpdateIncident

func (c *Client) UpdateIncident(input *UpdateIncidentInput) (*UpdateIncidentOutput, error)

UpdateIncident updates the specific incident. https://api.ilert.com/api-docs/#tag/Incidents/paths/~1incidents~1{id}/put

func (*Client) UpdateIncidentTemplate

func (c *Client) UpdateIncidentTemplate(input *UpdateIncidentTemplateInput) (*UpdateIncidentTemplateOutput, error)

UpdateIncidentTemplate updates the specific incident template. https://api.ilert.com/api-docs/#tag/Incident-Templates/paths/~1incident-templates~1{id}/put

func (*Client) UpdateMetric

func (c *Client) UpdateMetric(input *UpdateMetricInput) (*UpdateMetricOutput, error)

UpdateMetric updates the specific metric. https://api.ilert.com/api-docs/#tag/Metrics/paths/~1metrics~1{id}/put

func (*Client) UpdateMetricDataSource

func (c *Client) UpdateMetricDataSource(input *UpdateMetricDataSourceInput) (*UpdateMetricDataSourceOutput, error)

UpdateMetricDataSource updates the specific metric data source. https://api.ilert.com/api-docs/#tag/Metric-Data-Sources/paths/~1metric-data-sources~1{id}/put

func (*Client) UpdateSchedule

func (c *Client) UpdateSchedule(input *UpdateScheduleInput) (*UpdateScheduleOutput, error)

UpdateSchedule updates the specific schedule. https://api.ilert.com/api-docs/#tag/Schedules/paths/~1schedules~1{id}/put

func (*Client) UpdateService

func (c *Client) UpdateService(input *UpdateServiceInput) (*UpdateServiceOutput, error)

UpdateService updates the specific service. https://api.ilert.com/api-docs/#tag/Services/paths/~1services~1{id}/put

func (*Client) UpdateStatusPage

func (c *Client) UpdateStatusPage(input *UpdateStatusPageInput) (*UpdateStatusPageOutput, error)

UpdateStatusPage updates the specific status page. https://api.ilert.com/api-docs/#tag/Status-Pages/paths/~1status-pages~1{id}/put

func (*Client) UpdateStatusPageGroup

func (c *Client) UpdateStatusPageGroup(input *UpdateStatusPageGroupInput) (*UpdateStatusPageGroupOutput, error)

UpdateStatusPageGroup updates an existing status page group. https://api.ilert.com/api-docs/#tag/Status-Pages/paths/~1status-pages~1{id}~1groups~1{group-id}/put

func (*Client) UpdateSupportHour added in v3.4.0

func (c *Client) UpdateSupportHour(input *UpdateSupportHourInput) (*UpdateSupportHourOutput, error)

UpdateSupportHour updates an existing support hours resource. https://api.ilert.com/api-docs/#tag/Support-Hours/paths/~1support-hours~1{id}/put

func (*Client) UpdateTeam

func (c *Client) UpdateTeam(input *UpdateTeamInput) (*UpdateTeamOutput, error)

UpdateTeam updates an existing team. https://api.ilert.com/api-docs/#tag/Teams/paths/~1teams~1{id}/put

func (*Client) UpdateUptimeMonitor

func (c *Client) UpdateUptimeMonitor(input *UpdateUptimeMonitorInput) (*UpdateUptimeMonitorOutput, error)

UpdateUptimeMonitor updates an existing uptime monitor. https://api.ilert.com/api-docs/#tag/Uptime-Monitors/paths/~1uptime-monitors~1{id}/put

func (*Client) UpdateUser

func (c *Client) UpdateUser(input *UpdateUserInput) (*UpdateUserOutput, error)

UpdateUser updates an existing user. https://api.ilert.com/api-docs/#tag/Users/paths/~1users~1{user-id}/put

func (*Client) UpdateUserAlertPreference

func (c *Client) UpdateUserAlertPreference(input *UpdateUserAlertPreferenceInput) (*UpdateUserAlertPreferenceOutput, error)

UpdateUserAlertPreference updates an existing alert notification preference of a user. https://api.ilert.com/api-docs/#tag/Notification-Preferences/paths/~1users~1{user-id}~1notification-preferences~1alerts~1{id}/put

func (*Client) UpdateUserDutyPreference

func (c *Client) UpdateUserDutyPreference(input *UpdateUserDutyPreferenceInput) (*UpdateUserDutyPreferenceOutput, error)

UpdateUserDutyPreference updates an existing duty notification preference of a user. https://api.ilert.com/api-docs/#tag/Notification-Preferences/paths/~1users~1{user-id}~1notification-preferences~1duties~1{id}/put

func (*Client) UpdateUserEmailContact

func (c *Client) UpdateUserEmailContact(input *UpdateUserEmailContactInput) (*UpdateUserEmailContactOutput, error)

UpdateUserEmailContact updates an existing email contact of a user. https://api.ilert.com/api-docs/#tag/Contacts/paths/~1users~1{user-id}~1contacts~1emails~1{id}/put

func (*Client) UpdateUserPhoneNumberContact

func (c *Client) UpdateUserPhoneNumberContact(input *UpdateUserPhoneNumberContactInput) (*UpdateUserPhoneNumberContactOutput, error)

UpdateUserPhoneNumberContact updates an existing phone number contact of a user. https://api.ilert.com/api-docs/#tag/Contacts/paths/~1users~1{user-id}~1contacts~1phone-numbers~1{id}/put

func (*Client) UpdateUserSubscriptionPreference

func (c *Client) UpdateUserSubscriptionPreference(input *UpdateUserSubscriptionPreferenceInput) (*UpdateUserSubscriptionPreferenceOutput, error)

UpdateUserSubscriptionPreference updates an existing subscription notification preference of a user. https://api.ilert.com/api-docs/#tag/Notification-Preferences/paths/~1users~1{user-id}~1notification-preferences~1subscriptions~1{id}/put

func (*Client) UpdateUserUpdatePreference

func (c *Client) UpdateUserUpdatePreference(input *UpdateUserUpdatePreferenceInput) (*UpdateUserUpdatePreferenceOutput, error)

UpdateUserUpdatePreference updates an existing update notification preference of a user. https://api.ilert.com/api-docs/#tag/Notification-Preferences/paths/~1users~1{user-id}~1notification-preferences~1updates~1{id}/put

type ClientOptions

type ClientOptions func(*Client)

ClientOptions allows for options to be passed into the Client for customization

func WithAPIEndpoint

func WithAPIEndpoint(endpoint string) ClientOptions

WithAPIEndpoint allows for a custom API endpoint to be passed into the client

func WithAPIToken

func WithAPIToken(apiToken string) ClientOptions

WithAPIToken adds an api token to the client

func WithBasicAuth

func WithBasicAuth(organizationID string, username string, password string) ClientOptions

WithBasicAuth adds an basic auth credentials to the client

func WithProxy

func WithProxy(url string) ClientOptions

WithProxy setting a Proxy URL and Port

func WithRetry

func WithRetry(retryCount int, retryWaitTime time.Duration, retryMaxWaitTime time.Duration) ClientOptions

WithRetry enables retry logic with exponential backoff for the following errors:

- any network errors

- 5xx errors: this indicates an error in iLert

- 429 Too Many Requests: you have reached your rate limit

func WithUserAgent

func WithUserAgent(agent string) ClientOptions

WithUserAgent replace user agent to the client

type Connection

type Connection struct {
	ID             string      `json:"id,omitempty"`
	Name           string      `json:"name"`
	AlertSourceIDs []int64     `json:"alertSourceIds"`
	ConnectorID    string      `json:"connectorId"`
	ConnectorType  string      `json:"connectorType"`
	TriggerMode    string      `json:"triggerMode"`
	TriggerTypes   []string    `json:"triggerTypes,omitempty"`
	CreatedAt      string      `json:"createdAt,omitempty"` // date time string in ISO 8601
	UpdatedAt      string      `json:"updatedAt,omitempty"` // date time string in ISO 8601
	Params         interface{} `json:"params"`
}

Legacy API - please use alert-actions - for more information see https://docs.ilert.com/rest-api/api-version-history#renaming-connections-to-alert-actions

type ConnectionOutput

type ConnectionOutput struct {
	ID             string                  `json:"id"`
	Name           string                  `json:"name"`
	AlertSourceIDs []int64                 `json:"alertSourceIds"`
	ConnectorID    string                  `json:"connectorId"`
	ConnectorType  string                  `json:"connectorType"`
	TriggerMode    string                  `json:"triggerMode"`
	TriggerTypes   []string                `json:"triggerTypes,omitempty"`
	CreatedAt      string                  `json:"createdAt"` // date time string in ISO 8601
	UpdatedAt      string                  `json:"updatedAt"` // date time string in ISO 8601
	Params         *ConnectionOutputParams `json:"params"`
}

ConnectionOutput definition https://api.ilert.com/api-docs/#!/Connections

type ConnectionOutputParams

type ConnectionOutputParams struct {
	BodyTemplate    string   `json:"bodyTemplate,omitempty"`    // Custom, Jira, Email. Used to post data to external server
	CallerID        string   `json:"callerId,omitempty"`        // ServiceNow: user email
	ChannelID       string   `json:"channelId,omitempty"`       // Slack
	ChannelName     string   `json:"channelName,omitempty"`     // Slack
	CompanyID       int64    `json:"companyId,omitempty"`       // Autotask: Company ID
	EventFilter     string   `json:"eventFilter,omitempty"`     // Sysdig
	Impact          string   `json:"impact,omitempty"`          // ServiceNow: 1 - High, 2 - Medium, 3 - Low (Default)
	IssueType       string   `json:"issueType,omitempty"`       // Jira: "Bug" | "Epic" | "Subtask" | "Story" | "Task"
	IssueTypeNumber int64    `json:"issueTypeNumber,omitempty"` // Autotask: Issue type
	Labels          []string `json:"labels,omitempty"`          // Github
	Name            string   `json:"name,omitempty"`            // Jira or MicrosoftTeams or Zendesk
	Owner           string   `json:"owner,omitempty"`           // Github
	Priority        string   `json:"priority,omitempty"`        // Datadog: "normal" | "low". Zendesk: "urgent" | "high" | "normal" | "low".
	Project         string   `json:"project,omitempty"`         // Jira
	QueueID         int64    `json:"queueId,omitempty"`         // Autotask: Queue ID
	Recipients      []string `json:"recipients,omitempty"`      // Email
	Repository      string   `json:"repository,omitempty"`      // Github
	Site            string   `json:"site,omitempty"`            // Datadog: default `US`. Values: `US` or `EU`
	Status          string   `json:"status,omitempty"`          // Topdesk: firstLine, secondLine, partial
	Subject         string   `json:"subject,omitempty"`         // Email
	Tags            []string `json:"tags,omitempty"`            // Datadog or Sysdig
	TeamDomain      string   `json:"teamDomain,omitempty"`      // Slack
	TeamID          string   `json:"teamId,omitempty"`          // Slack
	TicketCategory  string   `json:"ticketCategory,omitempty"`  // Autotask
	TicketType      string   `json:"ticketType,omitempty"`      // Autotask
	Urgency         string   `json:"urgency,omitempty"`         // ServiceNow: 1 - High, 2 - Medium, 3 - Low (Default)
	WebhookURL      string   `json:"webhookUrl,omitempty"`      // Custom
	Email           string   `json:"email,omitempty"`           // Zammad
	PageID          string   `json:"pageId,omitempty"`          // StatusPage.io
	URL             string   `json:"url,omitempty"`             // DingTalk
}

ConnectionOutputParams definition

type ConnectionParamsAWSLambda

type ConnectionParamsAWSLambda struct {
	WebhookURL   string `json:"webhookUrl,omitempty"`
	BodyTemplate string `json:"bodyTemplate,omitempty"`
}

ConnectionParamsAWSLambda definition

type ConnectionParamsAutotask

type ConnectionParamsAutotask struct {
	CompanyID      string `json:"companyId,omitempty"`      // Autotask: Company ID
	IssueType      string `json:"issueType,omitempty"`      // Autotask: Issue type
	QueueID        int64  `json:"queueId,omitempty"`        // Autotask: Queue ID
	TicketCategory string `json:"ticketCategory,omitempty"` // Autotask ticket category
	TicketType     string `json:"ticketType,omitempty"`     // Autotask ticket type
}

ConnectionParamsAutotask definition

type ConnectionParamsAzureFunction

type ConnectionParamsAzureFunction struct {
	WebhookURL   string `json:"webhookUrl,omitempty"`
	BodyTemplate string `json:"bodyTemplate,omitempty"`
}

ConnectionParamsAzureFunction definition

type ConnectionParamsDatadog

type ConnectionParamsDatadog struct {
	Tags     []string `json:"tags,omitempty"`
	Priority string   `json:"priority,omitempty"` // "normal" | "low"
	Site     string   `json:"site,omitempty"`     // `US` | `EU`
}

ConnectionParamsDatadog definition

type ConnectionParamsDingTalkAction

type ConnectionParamsDingTalkAction struct {
	URL string `json:"url,omitempty"`
}

ConnectionParamsDingTalkAction definition

type ConnectionParamsDiscord

type ConnectionParamsDiscord struct{}

ConnectionParamsDiscord definition

type ConnectionParamsEmail

type ConnectionParamsEmail struct {
	Recipients   []string `json:"recipients,omitempty"`
	Subject      string   `json:"subject,omitempty"`
	BodyTemplate string   `json:"bodyTemplate,omitempty"`
}

ConnectionParamsEmail definition

type ConnectionParamsGithub

type ConnectionParamsGithub struct {
	Owner      string   `json:"owner,omitempty"`
	Repository string   `json:"repository,omitempty"`
	Labels     []string `json:"labels,omitempty"`
}

ConnectionParamsGithub definition

type ConnectionParamsGoogleFunction

type ConnectionParamsGoogleFunction struct {
	WebhookURL   string `json:"webhookUrl,omitempty"`
	BodyTemplate string `json:"bodyTemplate,omitempty"`
}

ConnectionParamsGoogleFunction definition

type ConnectionParamsJira

type ConnectionParamsJira struct {
	Project      string `json:"project,omitempty"`
	IssueType    string `json:"issueType,omitempty"` // "Bug" | "Epic" | "Subtask" | "Story" | "Task"
	BodyTemplate string `json:"bodyTemplate,omitempty"`
}

ConnectionParamsJira definition

type ConnectionParamsMicrosoftTeams

type ConnectionParamsMicrosoftTeams struct{}

ConnectionParamsMicrosoftTeams definition

type ConnectionParamsServiceNow

type ConnectionParamsServiceNow struct {
	CallerID string `json:"callerId,omitempty"` // user email
	Impact   string `json:"impact,omitempty"`   // 1 - High, 2 - Medium, 3 - Low (Default)
	Urgency  string `json:"urgency,omitempty"`  // 1 - High, 2 - Medium, 3 - Low (Default)
}

ConnectionParamsServiceNow definition

type ConnectionParamsSlack

type ConnectionParamsSlack struct {
	ChannelID   string `json:"channelId,omitempty"`
	ChannelName string `json:"channelName,omitempty"`
	TeamDomain  string `json:"teamDomain,omitempty"`
	TeamID      string `json:"teamId,omitempty"`
}

ConnectionParamsSlack definition

type ConnectionParamsStatusPageIO

type ConnectionParamsStatusPageIO struct {
	PageID string `json:"pageId,omitempty"`
}

ConnectionParamsStatusPageIO definition

type ConnectionParamsSysdig

type ConnectionParamsSysdig struct {
	Tags        []string `json:"tags,omitempty"`
	EventFilter string   `json:"eventFilter,omitempty"`
}

ConnectionParamsSysdig definition

type ConnectionParamsTopdesk

type ConnectionParamsTopdesk struct {
	Status string `json:"status,omitempty"` // `firstLine`| `secondLine` | `partial`
}

ConnectionParamsTopdesk definition

type ConnectionParamsWebhook

type ConnectionParamsWebhook struct {
	WebhookURL   string `json:"webhookUrl,omitempty"`
	BodyTemplate string `json:"bodyTemplate,omitempty"`
}

ConnectionParamsWebhook definition

type ConnectionParamsZammad

type ConnectionParamsZammad struct {
	Email string `json:"email,omitempty"`
}

ConnectionParamsZammad definition

type ConnectionParamsZapier

type ConnectionParamsZapier struct {
	WebhookURL string `json:"webhookUrl,omitempty"`
}

ConnectionParamsZapier definition

type ConnectionParamsZendesk

type ConnectionParamsZendesk struct {
	Priority string `json:"priority,omitempty"` // "urgent" | "high" | "normal" | "low"
}

ConnectionParamsZendesk definition

type Connector

type Connector struct {
	ID        string      `json:"id,omitempty"`
	Name      string      `json:"name"`
	Type      string      `json:"type"`
	CreatedAt string      `json:"createdAt,omitempty"` // date time string in ISO 8601
	UpdatedAt string      `json:"updatedAt,omitempty"` // date time string in ISO 8601
	Params    interface{} `json:"params"`
}

Connector definition

type ConnectorOutput

type ConnectorOutput struct {
	ID        string                `json:"id"`
	Name      string                `json:"name"`
	Type      string                `json:"type"`
	CreatedAt string                `json:"createdAt"` // date time string in ISO 8601
	UpdatedAt string                `json:"updatedAt"` // date time string in ISO 8601
	Params    ConnectorOutputParams `json:"params"`
}

ConnectorOutput definition

type ConnectorOutputParams

type ConnectorOutputParams struct {
	APIKey        string `json:"apiKey,omitempty"`        // Datadog or Zendesk or Github or Serverless or Autotask api key
	Authorization string `json:"authorization,omitempty"` // Serverless
	URL           string `json:"url,omitempty"`           // Jira or Microsoft Teams or Zendesk or Discord or Autotask server url
	Email         string `json:"email,omitempty"`         // Jira or ServiceNow or Zendesk username or email
	Username      string `json:"username,omitempty"`      // TOPdesk or ServiceNow or Autotask username
	Password      string `json:"password,omitempty"`      // Jira or ServiceNow or Autotask user password or api token
	Secret        string `json:"secret,omitempty"`        // DingTalk
}

ConnectorOutputParams definition

type ConnectorParamsAWSLambda

type ConnectorParamsAWSLambda struct {
	Authorization string `json:"authorization,omitempty"`
}

ConnectorParamsAWSLambda definition

type ConnectorParamsAutotask

type ConnectorParamsAutotask struct {
	URL      string `json:"url"`
	Email    string `json:"email"`
	Password string `json:"password"`
}

ConnectorParamsAutotask definition

type ConnectorParamsAzureFunction

type ConnectorParamsAzureFunction struct {
	Authorization string `json:"authorization,omitempty"`
}

ConnectorParamsAzureFunction definition

type ConnectorParamsDatadog

type ConnectorParamsDatadog struct {
	APIKey string `json:"apiKey"`
}

ConnectorParamsDatadog definition

type ConnectorParamsDingTalk

type ConnectorParamsDingTalk struct {
	URL    string `json:"url,omitempty"`
	Secret string `json:"secret,omitempty"`
}

ConnectorParamsDingTalk definition

type ConnectorParamsDiscord

type ConnectorParamsDiscord struct {
	URL string `json:"url"`
}

ConnectorParamsDiscord definition

type ConnectorParamsGithub

type ConnectorParamsGithub struct {
	APIKey string `json:"apiKey"`
}

ConnectorParamsGithub definition

type ConnectorParamsGoogleFunction

type ConnectorParamsGoogleFunction struct {
	Authorization string `json:"authorization,omitempty"`
}

ConnectorParamsGoogleFunction definition

type ConnectorParamsJira

type ConnectorParamsJira struct {
	URL      string `json:"url"`
	Email    string `json:"email"`
	Password string `json:"password"`
}

ConnectorParamsJira definition

type ConnectorParamsMattermost

type ConnectorParamsMattermost struct {
	URL string `json:"url"`
}

ConnectorParamsMattermost definition

type ConnectorParamsMicrosoftTeams

type ConnectorParamsMicrosoftTeams struct {
	URL string `json:"url"`
}

ConnectorParamsMicrosoftTeams definition

type ConnectorParamsServiceNow

type ConnectorParamsServiceNow struct {
	URL      string `json:"url"`
	Username string `json:"username"`
	Password string `json:"password"`
}

ConnectorParamsServiceNow definition

type ConnectorParamsSlack

type ConnectorParamsSlack struct{}

ConnectorParamsSlack definition

type ConnectorParamsStatusPageIO

type ConnectorParamsStatusPageIO struct {
	APIKey string `json:"apiKey"`
}

ConnectorParamsStatusPageIO definition

type ConnectorParamsSysdig

type ConnectorParamsSysdig struct {
	APIKey string `json:"apiKey"`
}

ConnectorParamsSysdig definition

type ConnectorParamsTopdesk

type ConnectorParamsTopdesk struct {
	URL      string `json:"url"`
	Username string `json:"username"`
	Password string `json:"password"`
}

ConnectorParamsTopdesk definition

type ConnectorParamsZammad

type ConnectorParamsZammad struct {
	URL    string `json:"url"`
	APIKey string `json:"apiKey"`
}

ConnectorParamsZammad definition

type ConnectorParamsZendesk

type ConnectorParamsZendesk struct {
	URL    string `json:"url"`
	Email  string `json:"email"`
	APIKey string `json:"apiKey"`
}

ConnectorParamsZendesk definition

type CreateAlertActionInput

type CreateAlertActionInput struct {
	AlertAction *AlertAction
	// contains filtered or unexported fields
}

CreateAlertActionInput represents the input of a CreateAlertAction operation.

type CreateAlertActionOutput

type CreateAlertActionOutput struct {
	AlertAction *AlertActionOutput
	// contains filtered or unexported fields
}

CreateAlertActionOutput represents the output of a CreateAlertAction operation.

type CreateAlertSourceInput

type CreateAlertSourceInput struct {
	AlertSource *AlertSource
	// contains filtered or unexported fields
}

CreateAlertSourceInput represents the input of a CreateAlertSource operation.

type CreateAlertSourceOutput

type CreateAlertSourceOutput struct {
	AlertSource *AlertSource
	// contains filtered or unexported fields
}

CreateAlertSourceOutput represents the output of a CreateAlertSource operation.

type CreateAutomationRuleInput

type CreateAutomationRuleInput struct {
	AutomationRule *AutomationRule
	// contains filtered or unexported fields
}

CreateAutomationRuleInput represents the input of a CreateAutomationRule operation.

type CreateAutomationRuleOutput

type CreateAutomationRuleOutput struct {
	AutomationRule *AutomationRule
	// contains filtered or unexported fields
}

CreateAutomationRuleOutput represents the output of a CreateAutomationRule operation.

type CreateConnectionInput

type CreateConnectionInput struct {
	Connection *Connection
	// contains filtered or unexported fields
}

CreateConnectionInput represents the input of a CreateConnection operation.

type CreateConnectionOutput

type CreateConnectionOutput struct {
	Connection *ConnectionOutput
	// contains filtered or unexported fields
}

CreateConnectionOutput represents the output of a CreateConnection operation.

type CreateConnectorInput

type CreateConnectorInput struct {
	Connector *Connector
	// contains filtered or unexported fields
}

CreateConnectorInput represents the input of a CreateConnector operation.

type CreateConnectorOutput

type CreateConnectorOutput struct {
	Connector *ConnectorOutput
	// contains filtered or unexported fields
}

CreateConnectorOutput represents the output of a CreateConnector operation.

type CreateEscalationPolicyInput

type CreateEscalationPolicyInput struct {
	EscalationPolicy *EscalationPolicy
	// contains filtered or unexported fields
}

CreateEscalationPolicyInput represents the input of a CreateEscalationPolicy operation.

type CreateEscalationPolicyOutput

type CreateEscalationPolicyOutput struct {
	EscalationPolicy *EscalationPolicy
	// contains filtered or unexported fields
}

CreateEscalationPolicyOutput represents the output of a CreateEscalationPolicy operation.

type CreateEventInput

type CreateEventInput struct {

	// alert event
	Event *Event
	// (optional) request url
	URL *string
	// contains filtered or unexported fields
}

CreateEventInput represents the input of a CreateEvent operation.

type CreateEventOutput

type CreateEventOutput struct {
	EventResponse *EventResponse
	// contains filtered or unexported fields
}

CreateEventOutput represents the output of a CreateEvent operation.

type CreateIncidentInput

type CreateIncidentInput struct {
	Incident *Incident
	// contains filtered or unexported fields
}

CreateIncidentInput represents the input of a CreateIncident operation.

type CreateIncidentOutput

type CreateIncidentOutput struct {
	Incident *Incident
	// contains filtered or unexported fields
}

CreateIncidentOutput represents the output of a CreateIncident operation.

type CreateIncidentTemplateInput

type CreateIncidentTemplateInput struct {
	IncidentTemplate *IncidentTemplate
	// contains filtered or unexported fields
}

CreateIncidentTemplateInput represents the input of a CreateIncidentTemplate operation.

type CreateIncidentTemplateOutput

type CreateIncidentTemplateOutput struct {
	IncidentTemplate *IncidentTemplate
	// contains filtered or unexported fields
}

CreateIncidentTemplateOutput represents the output of a CreateIncidentTemplate operation.

type CreateMetricDataSourceInput

type CreateMetricDataSourceInput struct {
	MetricDataSource *MetricDataSource
	// contains filtered or unexported fields
}

CreateMetricDataSourceInput represents the input of a CreateMetricDataSource operation.

type CreateMetricDataSourceOutput

type CreateMetricDataSourceOutput struct {
	MetricDataSource *MetricDataSource
	// contains filtered or unexported fields
}

CreateMetricDataSourceOutput represents the output of a CreateMetricDataSource operation.

type CreateMetricInput

type CreateMetricInput struct {
	Metric *Metric
	// contains filtered or unexported fields
}

CreateMetricInput represents the input of a CreateMetric operation.

type CreateMetricOutput

type CreateMetricOutput struct {
	Metric *Metric
	// contains filtered or unexported fields
}

CreateMetricOutput represents the output of a CreateMetric operation.

type CreateMultipleSeriesInput

type CreateMultipleSeriesInput struct {
	Series    *MultipleSeries
	MetricKey *string
	// contains filtered or unexported fields
}

CreateMultipleSeriesInput represents the input of a CreateMultipleSeries operation.

type CreateScheduleInput

type CreateScheduleInput struct {
	Schedule    *Schedule
	AbortOnGaps *bool
	// contains filtered or unexported fields
}

CreateScheduleInput represents the input of a CreateSchedule operation.

type CreateScheduleOutput

type CreateScheduleOutput struct {
	Schedule *Schedule
	// contains filtered or unexported fields
}

CreateScheduleOutput represents the output of a CreateSchedule operation.

type CreateServiceInput

type CreateServiceInput struct {
	Service *Service
	// contains filtered or unexported fields
}

CreateServiceInput represents the input of a CreateService operation.

type CreateServiceOutput

type CreateServiceOutput struct {
	Service *Service
	// contains filtered or unexported fields
}

CreateServiceOutput represents the output of a CreateService operation.

type CreateSingleSeriesInput

type CreateSingleSeriesInput struct {
	Series    *SingleSeries
	MetricKey *string
	// contains filtered or unexported fields
}

CreateSingleSeriesInput represents the input of a CreateSingleSeries operation.

type CreateStatusPageGroupInput

type CreateStatusPageGroupInput struct {
	StatusPageGroup *StatusPageGroup
	StatusPageID    *int64
	// contains filtered or unexported fields
}

CreateStatusPageGroupInput represents the input of a CreateStatusPageGroup operation.

type CreateStatusPageGroupOutput

type CreateStatusPageGroupOutput struct {
	StatusPageGroup *StatusPageGroup
	// contains filtered or unexported fields
}

CreateStatusPageGroupOutput represents the output of a CreateStatusPageGroup operation.

type CreateStatusPageInput

type CreateStatusPageInput struct {
	StatusPage *StatusPage
	// contains filtered or unexported fields
}

CreateStatusPageInput represents the input of a CreateStatusPage operation.

type CreateStatusPageOutput

type CreateStatusPageOutput struct {
	StatusPage *StatusPage
	// contains filtered or unexported fields
}

CreateStatusPageOutput represents the output of a CreateStatusPage operation.

type CreateSupportHourInput added in v3.4.0

type CreateSupportHourInput struct {
	SupportHour *SupportHour
	// contains filtered or unexported fields
}

CreateSupportHourInput represents the input of a CreateSupportHour operation.

type CreateSupportHourOutput added in v3.4.0

type CreateSupportHourOutput struct {
	SupportHour *SupportHour
	// contains filtered or unexported fields
}

CreateSupportHourOutput represents the output of a CreateSupportHour operation.

type CreateTeamInput

type CreateTeamInput struct {
	Team *Team
	// contains filtered or unexported fields
}

CreateTeamInput represents the input of a CreateTeam operation.

type CreateTeamOutput

type CreateTeamOutput struct {
	Team *Team
	// contains filtered or unexported fields
}

CreateTeamOutput represents the output of a CreateTeam operation.

type CreateUptimeMonitorInput

type CreateUptimeMonitorInput struct {
	UptimeMonitor *UptimeMonitor
	// contains filtered or unexported fields
}

CreateUptimeMonitorInput represents the input of a CreateUptimeMonitor operation.

type CreateUptimeMonitorOutput

type CreateUptimeMonitorOutput struct {
	UptimeMonitor *UptimeMonitor
	// contains filtered or unexported fields
}

CreateUptimeMonitorOutput represents the output of a CreateUptimeMonitor operation.

type CreateUserAlertPreferenceInput

type CreateUserAlertPreferenceInput struct {
	UserID              *int64
	UserAlertPreference *UserAlertPreference
	// contains filtered or unexported fields
}

CreateUserAlertPreferenceInput represents the input of a CreateUserAlertPreference operation.

type CreateUserAlertPreferenceOutput

type CreateUserAlertPreferenceOutput struct {
	UserAlertPreference *UserAlertPreference
	// contains filtered or unexported fields
}

CreateUserAlertPreferenceOutput represents the output of a CreateUserAlertPreference operation.

type CreateUserDutyPreferenceInput

type CreateUserDutyPreferenceInput struct {
	UserID             *int64
	UserDutyPreference *UserDutyPreference
	// contains filtered or unexported fields
}

CreateUserDutyPreferenceInput represents the input of a CreateUserDutyPreference operation.

type CreateUserDutyPreferenceOutput

type CreateUserDutyPreferenceOutput struct {
	UserDutyPreference *UserDutyPreference
	// contains filtered or unexported fields
}

CreateUserDutyPreferenceOutput represents the output of a CreateUserDutyPreference operation.

type CreateUserEmailContactInput

type CreateUserEmailContactInput struct {
	UserID           *int64
	UserEmailContact *UserEmailContact
	// contains filtered or unexported fields
}

CreateUserEmailContactInput represents the input of a CreateUserEmailContact operation.

type CreateUserEmailContactOutput

type CreateUserEmailContactOutput struct {
	UserEmailContact *UserEmailContact
	// contains filtered or unexported fields
}

CreateUserEmailContactOutput represents the output of a CreateUserEmailContact operation.

type CreateUserInput

type CreateUserInput struct {
	User *User
	// contains filtered or unexported fields
}

CreateUserInput represents the input of a CreateUser operation.

type CreateUserOutput

type CreateUserOutput struct {
	User *User
	// contains filtered or unexported fields
}

CreateUserOutput represents the output of a CreateUser operation.

type CreateUserPhoneNumberContactInput

type CreateUserPhoneNumberContactInput struct {
	UserID                 *int64
	UserPhoneNumberContact *UserPhoneNumberContact
	// contains filtered or unexported fields
}

CreateUserPhoneNumberContactInput represents the input of a CreateUserPhoneNumberContact operation.

type CreateUserPhoneNumberContactOutput

type CreateUserPhoneNumberContactOutput struct {
	UserPhoneNumberContact *UserPhoneNumberContact
	// contains filtered or unexported fields
}

CreateUserPhoneNumberContactOutput represents the output of a CreateUserPhoneNumberContact operation.

type CreateUserSubscriptionPreferenceInput

type CreateUserSubscriptionPreferenceInput struct {
	UserID                     *int64
	UserSubscriptionPreference *UserSubscriptionPreference
	// contains filtered or unexported fields
}

CreateUserSubscriptionPreferenceInput represents the input of a CreateUserSubscriptionPreference operation.

type CreateUserSubscriptionPreferenceOutput

type CreateUserSubscriptionPreferenceOutput struct {
	UserSubscriptionPreference *UserSubscriptionPreference
	// contains filtered or unexported fields
}

CreateUserSubscriptionPreferenceOutput represents the output of a CreateUserSubscriptionPreference operation.

type CreateUserUpdatePreferenceInput

type CreateUserUpdatePreferenceInput struct {
	UserID               *int64
	UserUpdatePreference *UserUpdatePreference
	// contains filtered or unexported fields
}

CreateUserUpdatePreferenceInput represents the input of a CreateUserUpdatePreference operation.

type CreateUserUpdatePreferenceOutput

type CreateUserUpdatePreferenceOutput struct {
	UserUpdatePreference *UserUpdatePreference
	// contains filtered or unexported fields
}

CreateUserUpdatePreferenceOutput represents the output of a CreateUserUpdatePreference operation.

type DeleteAlertActionInput

type DeleteAlertActionInput struct {
	AlertActionID *string
	// contains filtered or unexported fields
}

DeleteAlertActionInput represents the input of a DeleteAlertAction operation.

type DeleteAlertActionOutput

type DeleteAlertActionOutput struct {
	// contains filtered or unexported fields
}

DeleteAlertActionOutput represents the output of a DeleteAlertAction operation.

type DeleteAlertSourceInput

type DeleteAlertSourceInput struct {
	AlertSourceID *int64
	// contains filtered or unexported fields
}

DeleteAlertSourceInput represents the input of a DeleteAlertSource operation.

type DeleteAlertSourceOutput

type DeleteAlertSourceOutput struct {
	// contains filtered or unexported fields
}

DeleteAlertSourceOutput represents the output of a DeleteAlertSource operation.

type DeleteAutomationRuleInput

type DeleteAutomationRuleInput struct {
	AutomationRuleID *string
	// contains filtered or unexported fields
}

DeleteAutomationRuleInput represents the input of a DeleteAutomationRule operation.

type DeleteAutomationRuleOutput

type DeleteAutomationRuleOutput struct {
	// contains filtered or unexported fields
}

DeleteAutomationRuleOutput represents the output of a DeleteAutomationRule operation.

type DeleteConnectionInput

type DeleteConnectionInput struct {
	ConnectionID *string
	// contains filtered or unexported fields
}

DeleteConnectionInput represents the input of a DeleteConnection operation.

type DeleteConnectionOutput

type DeleteConnectionOutput struct {
	// contains filtered or unexported fields
}

DeleteConnectionOutput represents the output of a DeleteConnection operation.

type DeleteConnectorInput

type DeleteConnectorInput struct {
	ConnectorID *string
	// contains filtered or unexported fields
}

DeleteConnectorInput represents the input of a DeleteConnector operation.

type DeleteConnectorOutput

type DeleteConnectorOutput struct {
	// contains filtered or unexported fields
}

DeleteConnectorOutput represents the output of a DeleteConnector operation.

type DeleteEscalationPolicyInput

type DeleteEscalationPolicyInput struct {
	EscalationPolicyID *int64
	// contains filtered or unexported fields
}

DeleteEscalationPolicyInput represents the input of a DeleteEscalationPolicy operation.

type DeleteEscalationPolicyOutput

type DeleteEscalationPolicyOutput struct {
	// contains filtered or unexported fields
}

DeleteEscalationPolicyOutput represents the output of a DeleteEscalationPolicy operation.

type DeleteIncidentTemplateInput

type DeleteIncidentTemplateInput struct {
	IncidentTemplateID *int64
	// contains filtered or unexported fields
}

DeleteIncidentTemplateInput represents the input of a DeleteIncidentTemplate operation.

type DeleteIncidentTemplateOutput

type DeleteIncidentTemplateOutput struct {
	// contains filtered or unexported fields
}

DeleteIncidentTemplateOutput represents the output of a DeleteIncidentTemplate operation.

type DeleteMetricDataSourceInput

type DeleteMetricDataSourceInput struct {
	MetricDataSourceID *int64
	// contains filtered or unexported fields
}

DeleteMetricDataSourceInput represents the input of a DeleteMetricDataSource operation.

type DeleteMetricDataSourceOutput

type DeleteMetricDataSourceOutput struct {
	// contains filtered or unexported fields
}

DeleteMetricDataSourceOutput represents the output of a DeleteMetricDataSource operation.

type DeleteMetricInput

type DeleteMetricInput struct {
	MetricID *int64
	// contains filtered or unexported fields
}

DeleteMetricInput represents the input of a DeleteMetric operation.

type DeleteMetricOutput

type DeleteMetricOutput struct {
	// contains filtered or unexported fields
}

DeleteMetricOutput represents the output of a DeleteMetric operation.

type DeleteScheduleInput

type DeleteScheduleInput struct {
	ScheduleID *int64
	// contains filtered or unexported fields
}

DeleteScheduleInput represents the input of a DeleteSchedule operation.

type DeleteScheduleOutput

type DeleteScheduleOutput struct {
	// contains filtered or unexported fields
}

DeleteScheduleOutput represents the output of a DeleteSchedule operation.

type DeleteServiceInput

type DeleteServiceInput struct {
	ServiceID *int64
	// contains filtered or unexported fields
}

DeleteServiceInput represents the input of a DeleteService operation.

type DeleteServiceOutput

type DeleteServiceOutput struct {
	// contains filtered or unexported fields
}

DeleteServiceOutput represents the output of a DeleteService operation.

type DeleteStatusPageGroupInput

type DeleteStatusPageGroupInput struct {
	StatusPageGroupID *int64
	StatusPageID      *int64
	// contains filtered or unexported fields
}

DeleteStatusPageGroupInput represents the input of a DeleteStatusPageGroup operation.

type DeleteStatusPageGroupOutput

type DeleteStatusPageGroupOutput struct {
	// contains filtered or unexported fields
}

DeleteStatusPageGroupOutput represents the output of a DeleteStatusPageGroup operation.

type DeleteStatusPageInput

type DeleteStatusPageInput struct {
	StatusPageID *int64
	// contains filtered or unexported fields
}

DeleteStatusPageInput represents the input of a DeleteStatusPage operation.

type DeleteStatusPageOutput

type DeleteStatusPageOutput struct {
	// contains filtered or unexported fields
}

DeleteStatusPageOutput represents the output of a DeleteStatusPage operation.

type DeleteStatusPageSubscriberInput

type DeleteStatusPageSubscriberInput struct {
	StatusPageID *int64
	Subscriber   *Subscriber
	// contains filtered or unexported fields
}

DeleteStatusPageSubscriberInput represents the input of a DeleteStatusPageSubscriber operation.

type DeleteStatusPageSubscriberOutput

type DeleteStatusPageSubscriberOutput struct {
	// contains filtered or unexported fields
}

DeleteStatusPageSubscriberOutput represents the output of a DeleteStatusPageSubscriber operation.

type DeleteSupportHourInput added in v3.4.0

type DeleteSupportHourInput struct {
	SupportHourID *int64
	// contains filtered or unexported fields
}

DeleteSupportHourInput represents the input of a DeleteSupportHour operation.

type DeleteSupportHourOutput added in v3.4.0

type DeleteSupportHourOutput struct {
	// contains filtered or unexported fields
}

DeleteSupportHourOutput represents the output of a DeleteSupportHour operation.

type DeleteTeamInput

type DeleteTeamInput struct {
	TeamID *int64
	// contains filtered or unexported fields
}

DeleteTeamInput represents the input of a DeleteTeam operation.

type DeleteTeamOutput

type DeleteTeamOutput struct {
	// contains filtered or unexported fields
}

DeleteTeamOutput represents the output of a DeleteTeam operation.

type DeleteUptimeMonitorInput

type DeleteUptimeMonitorInput struct {
	UptimeMonitorID *int64
	// contains filtered or unexported fields
}

DeleteUptimeMonitorInput represents the input of a DeleteUptimeMonitor operation.

type DeleteUptimeMonitorOutput

type DeleteUptimeMonitorOutput struct {
	// contains filtered or unexported fields
}

DeleteUptimeMonitorOutput represents the output of a DeleteUptimeMonitor operation.

type DeleteUserAlertPreferenceInput

type DeleteUserAlertPreferenceInput struct {
	UserID                *int64
	UserAlertPreferenceID *int64
	// contains filtered or unexported fields
}

DeleteUserAlertPreferenceInput represents the input of a DeleteUserAlertPreference operation.

type DeleteUserAlertPreferenceOutput

type DeleteUserAlertPreferenceOutput struct {
	// contains filtered or unexported fields
}

DeleteUserAlertPreferenceOutput represents the output of a DeleteUserAlertPreference operation.

type DeleteUserDutyPreferenceInput

type DeleteUserDutyPreferenceInput struct {
	UserID               *int64
	UserDutyPreferenceID *int64
	// contains filtered or unexported fields
}

DeleteUserDutyPreferenceInput represents the input of a DeleteUserDutyPreference operation.

type DeleteUserDutyPreferenceOutput

type DeleteUserDutyPreferenceOutput struct {
	// contains filtered or unexported fields
}

DeleteUserDutyPreferenceOutput represents the output of a DeleteUserDutyPreference operation.

type DeleteUserEmailContactInput

type DeleteUserEmailContactInput struct {
	UserID             *int64
	UserEmailContactID *int64
	// contains filtered or unexported fields
}

DeleteUserEmailContactInput represents the input of a DeleteUserEmailContact operation.

type DeleteUserEmailContactOutput

type DeleteUserEmailContactOutput struct {
	// contains filtered or unexported fields
}

DeleteUserEmailContactOutput represents the output of a DeleteUserEmailContact operation.

type DeleteUserInput

type DeleteUserInput struct {
	UserID   *int64
	Username *string
	// contains filtered or unexported fields
}

DeleteUserInput represents the input of a DeleteUser operation.

type DeleteUserOutput

type DeleteUserOutput struct {
	// contains filtered or unexported fields
}

DeleteUserOutput represents the output of a DeleteUser operation.

type DeleteUserPhoneNumberContactInput

type DeleteUserPhoneNumberContactInput struct {
	UserID                   *int64
	UserPhoneNumberContactID *int64
	// contains filtered or unexported fields
}

DeleteUserPhoneNumberContactInput represents the input of a DeleteUserPhoneNumberContact operation.

type DeleteUserPhoneNumberContactOutput

type DeleteUserPhoneNumberContactOutput struct {
	// contains filtered or unexported fields
}

DeleteUserPhoneNumberContactOutput represents the output of a DeleteUserPhoneNumberContact operation.

type DeleteUserSubscriptionPreferenceInput

type DeleteUserSubscriptionPreferenceInput struct {
	UserID                       *int64
	UserSubscriptionPreferenceID *int64
	// contains filtered or unexported fields
}

DeleteUserSubscriptionPreferenceInput represents the input of a DeleteUserSubscriptionPreference operation.

type DeleteUserSubscriptionPreferenceOutput

type DeleteUserSubscriptionPreferenceOutput struct {
	// contains filtered or unexported fields
}

DeleteUserSubscriptionPreferenceOutput represents the output of a DeleteUserSubscriptionPreference operation.

type DeleteUserUpdatePreferenceInput

type DeleteUserUpdatePreferenceInput struct {
	UserID                 *int64
	UserUpdatePreferenceID *int64
	// contains filtered or unexported fields
}

DeleteUserUpdatePreferenceInput represents the input of a DeleteUserUpdatePreference operation.

type DeleteUserUpdatePreferenceOutput

type DeleteUserUpdatePreferenceOutput struct {
	// contains filtered or unexported fields
}

DeleteUserUpdatePreferenceOutput represents the output of a DeleteUserUpdatePreference operation.

type EmailPredicate

type EmailPredicate struct {
	Field    string `json:"field"`
	Criteria string `json:"criteria"`
	Value    string `json:"value"`
}

EmailPredicate definition

type EscalationPolicy

type EscalationPolicy struct {
	ID              int64            `json:"id,omitempty"`
	Name            string           `json:"name"`
	EscalationRules []EscalationRule `json:"escalationRules"`
	Teams           []TeamShort      `json:"teams,omitempty"`
	Repeating       bool             `json:"repeating,omitempty"`
	Frequency       int              `json:"frequency,omitempty"`
	DelayMin        int              `json:"delayMin,omitempty"`
	RoutingKey      string           `json:"routingKey,omitempty"`
}

EscalationPolicy definition https://api.ilert.com/api-docs/#!/Escalation_Policies

type EscalationRule

type EscalationRule struct {
	User              *User      `json:"user,omitempty"`
	Users             []User     `json:"users,omitempty"`
	Schedule          *Schedule  `json:"schedule,omitempty"`
	Schedules         []Schedule `json:"schedules,omitempty"`
	EscalationTimeout int        `json:"escalationTimeout"`
}

EscalationRule definition

type Event

type Event struct {
	// Required. The API key of the alert source.
	APIKey string `json:"apiKey"`

	// Required. Must be either ALERT, ACCEPT, or RESOLVE
	EventType string `json:"eventType"`

	// Required. The event summary. Will be used as the alert summary if a new alert is created.
	Summary string `json:"summary"`

	// Optional. The event details. Will be used as the alert details if a new alert is created.
	Details string `json:"details,omitempty"`

	// Optional. For ALERT events, the alert key can be used to deduplicate or group events. If an open alert with the key already exists, the event will be appended to the alert's event log. Otherwise a new alert will be created. For ACCEPT and RESOLVE events, the alert key is used to reference the open alert which is to be accepted or resolved by this event.
	AlertKey string `json:"alertKey,omitempty"`

	// Optional. For ALERT events, the alert key can be used to deduplicate or group events. If an open alert with the key already exists, the event will be appended to the alert's event log. Otherwise a new alert will be created. For ACCEPT and RESOLVE events, the alert key is used to reference the open alert which is to be accepted or resolved by this event.
	Priority string `json:"priority,omitempty"`

	// Optional. A list of images containing src, href and alt.
	Images []AlertImage `json:"images,omitempty"`

	// Optional. A list of links, containing href and text.
	Links []AlertLink `json:"links,omitempty"`

	// Optional. Additional custom details for the event.
	CustomDetails map[string]interface{} `json:"customDetails,omitempty"`
}

Event represents the alert event https://api.ilert.com/api-docs/#tag/Events

type EventResponse

type EventResponse struct {
	AlertKey     string `json:"alertKey"`
	AlertURL     string `json:"alertUrl"`
	ResponseCode string `json:"responseCode"`
}

EventResponse describes event API response body

type GenericAPIError

type GenericAPIError struct {
	Status  int    `json:"status"`
	Message string `json:"message"`
	Code    string `json:"code"`
	// contains filtered or unexported fields
}

GenericAPIError describes generic API response error e.g. bad request

func (*GenericAPIError) Error

func (aerr *GenericAPIError) Error() string

type GenericCountResponse

type GenericCountResponse struct {
	Count int `json:"count"`
}

GenericCountResponse describes generic resources count response

type GetAlertActionInput

type GetAlertActionInput struct {
	AlertActionID *string
	Version       *int
	// contains filtered or unexported fields
}

GetAlertActionInput represents the input of a GetAlertAction operation.

type GetAlertActionOutput

type GetAlertActionOutput struct {
	AlertAction *AlertActionOutput
	// contains filtered or unexported fields
}

GetAlertActionOutput represents the output of a GetAlertAction operation.

type GetAlertActionsInput

type GetAlertActionsInput struct {

	// an integer specifying the starting point (beginning with 0) when paging through a list of entities
	// Default: 0
	StartIndex *int

	// the maximum number of results when paging through a list of entities.
	// Default: 50, Maximum: 100
	MaxResults *int
	// contains filtered or unexported fields
}

GetAlertActionsInput represents the input of a GetAlertActions operation.

type GetAlertActionsOutput

type GetAlertActionsOutput struct {
	AlertActions []*AlertActionOutput
	// contains filtered or unexported fields
}

GetAlertActionsOutput represents the output of a GetAlertActions operation.

type GetAlertInput

type GetAlertInput struct {
	AlertID *int64

	// describes optional properties that should be included in the response
	Include []*string
	// contains filtered or unexported fields
}

GetAlertInput represents the input of a GetAlert operation.

type GetAlertLogEntriesInput

type GetAlertLogEntriesInput struct {
	AlertID  *int64
	Language *string
	// contains filtered or unexported fields
}

GetAlertLogEntriesInput represents the input of a GetAlertLogEntries operation.

type GetAlertLogEntriesOutput

type GetAlertLogEntriesOutput struct {
	LogEntries []*AlertLogEntry
	// contains filtered or unexported fields
}

GetAlertLogEntriesOutput represents the output of a GetAlertLogEntries operation.

type GetAlertOutput

type GetAlertOutput struct {
	Alert *Alert
	// contains filtered or unexported fields
}

GetAlertOutput represents the output of a GetAlert operation.

type GetAlertResponderInput

type GetAlertResponderInput struct {
	AlertID  *int64
	Language *string
	// contains filtered or unexported fields
}

GetAlertResponderInput represents the input of a GetAlertResponder operation.

type GetAlertResponderOutput

type GetAlertResponderOutput struct {
	Responders []*AlertResponder
	// contains filtered or unexported fields
}

GetAlertResponderOutput represents the output of a GetAlertResponder operation.

type GetAlertSourceInput

type GetAlertSourceInput struct {
	AlertSourceID *int64

	// describes optional properties that should be included in the response
	// possible values: "summaryTemplate", "detailsTemplate", "routingTemplate", "textTemplate", "linkTemplates", "priorityTemplate"
	Include []*string
	// contains filtered or unexported fields
}

GetAlertSourceInput represents the input of a GetAlertSource operation.

type GetAlertSourceOutput

type GetAlertSourceOutput struct {
	AlertSource *AlertSource
	// contains filtered or unexported fields
}

GetAlertSourceOutput represents the output of a GetAlertSource operation.

type GetAlertSourcesInput

type GetAlertSourcesInput struct {

	// an integer specifying the starting point (beginning with 0) when paging through a list of entities
	StartIndex *int

	// the maximum number of results when paging through a list of entities.
	// Maximum: 50
	MaxResults *int
	// contains filtered or unexported fields
}

GetAlertSourcesInput represents the input of a GetAlertSources operation.

type GetAlertSourcesOutput

type GetAlertSourcesOutput struct {
	AlertSources []*AlertSource
	// contains filtered or unexported fields
}

GetAlertSourcesOutput represents the output of a GetAlertSources operation.

type GetAlertsCountInput

type GetAlertsCountInput struct {

	// state of the alert
	States []*string

	// alert source ids of the alert's alert source
	AlertSources []*int64

	// user ids of the user that the alert is assigned to
	AssignedToUserIDs []*int64

	// usernames of the user that the alert is assigned to
	AssignedToUserNames []*string

	// Date time string in ISO format
	From *string

	// Date time string in ISO format
	Until *string
	// contains filtered or unexported fields
}

GetAlertsCountInput represents the input of a GetAlertsCount operation.

type GetAlertsCountOutput

type GetAlertsCountOutput struct {
	Count int
	// contains filtered or unexported fields
}

GetAlertsCountOutput represents the output of a GetAlertsCount operation.

type GetAlertsInput

type GetAlertsInput struct {

	// an integer specifying the starting point (beginning with 0) when paging through a list of entities
	// Default: 0
	StartIndex *int

	// the maximum number of results when paging through a list of entities.
	// Default: 50, Maximum: 100
	MaxResults *int

	// state of the alert
	States []*string

	// alert source IDs of the alert's alert source
	AlertSources []*int64

	// user IDs of the user that the alert is assigned to
	AssignedToUserIDs []*int64

	// usernames of the user that the alert is assigned to
	AssignedToUserNames []*string

	// Date time string in ISO format
	From *string

	// Date time string in ISO format
	Until *string
	// contains filtered or unexported fields
}

GetAlertsInput represents the input of a GetAlerts operation.

type GetAlertsOutput

type GetAlertsOutput struct {
	Alerts []*Alert
	// contains filtered or unexported fields
}

GetAlertsOutput represents the output of a GetAlerts operation.

type GetAutomationRuleInput

type GetAutomationRuleInput struct {
	AutomationRuleID *string
	// contains filtered or unexported fields
}

GetAutomationRuleInput represents the input of a GetAutomationRule operation.

type GetAutomationRuleOutput

type GetAutomationRuleOutput struct {
	AutomationRule *AutomationRule
	// contains filtered or unexported fields
}

GetAutomationRuleOutput represents the output of a GetAutomationRule operation.

type GetAutomationRulesInput

type GetAutomationRulesInput struct {

	// an integer specifying the starting point (beginning with 0) when paging through a list of entities
	// Default: 0
	StartIndex *int

	// the maximum number of results when paging through a list of entities.
	// Default: 50, Maximum: 100
	MaxResults *int

	// The service id for which automation rules are filtered for, this param is required
	Service *int
	// contains filtered or unexported fields
}

GetAutomationRulesInput represents the input of a GetAutomationRules operation.

type GetAutomationRulesOutput

type GetAutomationRulesOutput struct {
	AutomationRules []*AutomationRule
	// contains filtered or unexported fields
}

GetAutomationRulesOutput represents the output of a GetAutomationRules operation.

type GetConnectionInput

type GetConnectionInput struct {
	ConnectionID *string
	// contains filtered or unexported fields
}

GetConnectionInput represents the input of a GetConnection operation.

type GetConnectionOutput

type GetConnectionOutput struct {
	Connection *ConnectionOutput
	// contains filtered or unexported fields
}

GetConnectionOutput represents the output of a GetConnection operation.

type GetConnectionsInput

type GetConnectionsInput struct {
	// contains filtered or unexported fields
}

GetConnectionsInput represents the input of a GetConnections operation.

type GetConnectionsOutput

type GetConnectionsOutput struct {
	Connections []*ConnectionOutput
	// contains filtered or unexported fields
}

GetConnectionsOutput represents the output of a GetConnections operation.

type GetConnectorInput

type GetConnectorInput struct {
	ConnectorID *string
	// contains filtered or unexported fields
}

GetConnectorInput represents the input of a GetConnector operation.

type GetConnectorOutput

type GetConnectorOutput struct {
	Connector *ConnectorOutput
	// contains filtered or unexported fields
}

GetConnectorOutput represents the output of a GetConnector operation.

type GetConnectorsInput

type GetConnectorsInput struct {

	// an integer specifying the starting point (beginning with 0) when paging through a list of entities
	// Default: 0
	StartIndex *int

	// the maximum number of results when paging through a list of entities.
	// Default: 50, Maximum: 100
	MaxResults *int
	// contains filtered or unexported fields
}

GetConnectorsInput represents the input of a GetConnectors operation.

type GetConnectorsOutput

type GetConnectorsOutput struct {
	Connectors []*ConnectorOutput
	// contains filtered or unexported fields
}

GetConnectorsOutput represents the output of a GetConnectors operation.

type GetEscalationPoliciesInput

type GetEscalationPoliciesInput struct {

	// an integer specifying the starting point (beginning with 0) when paging through a list of entities
	StartIndex *int

	// the maximum number of results when paging through a list of entities.
	// Maximum: 50
	MaxResults *int
	// contains filtered or unexported fields
}

GetEscalationPoliciesInput represents the input of a GetEscalationPolicies operation.

type GetEscalationPoliciesOutput

type GetEscalationPoliciesOutput struct {
	EscalationPolicies []*EscalationPolicy
	// contains filtered or unexported fields
}

GetEscalationPoliciesOutput represents the output of a GetEscalationPolicies operation.

type GetEscalationPolicyInput

type GetEscalationPolicyInput struct {
	EscalationPolicyID *int64
	// contains filtered or unexported fields
}

GetEscalationPolicyInput represents the input of a GetEscalationPolicy operation.

type GetEscalationPolicyOutput

type GetEscalationPolicyOutput struct {
	EscalationPolicy *EscalationPolicy
	// contains filtered or unexported fields
}

GetEscalationPolicyOutput represents the output of a GetEscalationPolicy operation.

type GetIncidentAffectedInput

type GetIncidentAffectedInput struct {
	Incident *Incident
	// contains filtered or unexported fields
}

GetIncidentAffectedInput represents the input of a GetIncidentAffected operation.

type GetIncidentAffectedOutput

type GetIncidentAffectedOutput struct {
	Affected *Affected
	// contains filtered or unexported fields
}

GetIncidentAffectedOutput represents the output of a GetIncidentAffected operation.

type GetIncidentInput

type GetIncidentInput struct {
	IncidentID *int64

	// describes optional properties that should be included in the response
	Include []*string
	// contains filtered or unexported fields
}

GetIncidentInput represents the input of a GetIncident operation.

type GetIncidentOutput

type GetIncidentOutput struct {
	Incident *Incident
	ETag     *string
	// contains filtered or unexported fields
}

GetIncidentOutput represents the output of a GetIncident operation.

type GetIncidentSubscribersInput

type GetIncidentSubscribersInput struct {
	IncidentID *int64
	// contains filtered or unexported fields
}

GetIncidentSubscribersInput represents the input of a GetIncidentSubscribers operation.

type GetIncidentSubscribersOutput

type GetIncidentSubscribersOutput struct {
	Subscribers []*Subscriber
	// contains filtered or unexported fields
}

GetIncidentSubscribersOutput represents the output of a GetIncidentSubscribers operation.

type GetIncidentTemplateInput

type GetIncidentTemplateInput struct {
	IncidentTemplateID *int64
	// contains filtered or unexported fields
}

GetIncidentTemplateInput represents the input of a GetIncidentTemplate operation.

type GetIncidentTemplateOutput

type GetIncidentTemplateOutput struct {
	IncidentTemplate *IncidentTemplate
	// contains filtered or unexported fields
}

GetIncidentTemplateOutput represents the output of a GetIncidentTemplate operation.

type GetIncidentTemplatesInput

type GetIncidentTemplatesInput struct {

	// an integer specifying the starting point (beginning with 0) when paging through a list of entities
	// Default: 0
	StartIndex *int

	// the maximum number of results when paging through a list of entities.
	// Default: 50, Maximum: 100
	MaxResults *int
	// contains filtered or unexported fields
}

GetIncidentTemplatesInput represents the input of a GetIncidentTemplates operation.

type GetIncidentTemplatesOutput

type GetIncidentTemplatesOutput struct {
	IncidentTemplates []*IncidentTemplate
	// contains filtered or unexported fields
}

GetIncidentTemplatesOutput represents the output of a GetIncidentTemplates operation.

type GetIncidentsInput

type GetIncidentsInput struct {

	// an integer specifying the starting point (beginning with 0) when paging through a list of entities
	// Default: 0
	StartIndex *int

	// the maximum number of results when paging through a list of entities.
	// Default: 10, Maximum: 25 or 100 without include
	MaxResults *int

	// describes optional properties that should be included in the response
	Include []*string

	// state of the incident
	States []*string

	// service IDs of the incident's affected services
	Services []*int64

	// Date time string in ISO format
	From *string

	// Date time string in ISO format
	Until *string
	// contains filtered or unexported fields
}

GetIncidentsInput represents the input of a GetIncidents operation.

type GetIncidentsOutput

type GetIncidentsOutput struct {
	Incidents []*Incident
	// contains filtered or unexported fields
}

GetIncidentsOutput represents the output of a GetIncidents operation.

type GetMetricDataSourceInput

type GetMetricDataSourceInput struct {
	MetricDataSourceID *int64
	// contains filtered or unexported fields
}

GetMetricDataSourceInput represents the input of a GetMetricDataSource operation.

type GetMetricDataSourceOutput

type GetMetricDataSourceOutput struct {
	MetricDataSource *MetricDataSource
	// contains filtered or unexported fields
}

GetMetricDataSourceOutput represents the output of a GetMetricDataSource operation.

type GetMetricDataSourcesInput

type GetMetricDataSourcesInput struct {

	// an integer specifying the starting point (beginning with 0) when paging through a list of entities
	// Default: 0
	StartIndex *int

	// the maximum number of results when paging through a list of entities.
	// Default: 10, Maximum: 100
	MaxResults *int
	// contains filtered or unexported fields
}

GetMetricDataSourcesInput represents the input of a GetMetricDataSources operation.

type GetMetricDataSourcesOutput

type GetMetricDataSourcesOutput struct {
	MetricDataSources []*MetricDataSource
	// contains filtered or unexported fields
}

GetMetricDataSourcesOutput represents the output of a GetMetricDataSources operation.

type GetMetricInput

type GetMetricInput struct {
	MetricID *int64
	// contains filtered or unexported fields
}

GetMetricInput represents the input of a GetMetric operation.

type GetMetricOutput

type GetMetricOutput struct {
	Metric *Metric
	// contains filtered or unexported fields
}

GetMetricOutput represents the output of a GetMetric operation.

type GetMetricsInput

type GetMetricsInput struct {

	// an integer specifying the starting point (beginning with 0) when paging through a list of entities
	// Default: 0
	StartIndex *int

	// the maximum number of results when paging through a list of entities.
	// Default: 10, Maximum: 25 or 100 without include
	MaxResults *int

	// describes optional properties that should be included in the response
	// possible values: "dataSource", "integrationKey"
	Include []*string
	// contains filtered or unexported fields
}

GetMetricsInput represents the input of a GetMetrics operation.

type GetMetricsOutput

type GetMetricsOutput struct {
	Metrics []*Metric
	// contains filtered or unexported fields
}

GetMetricsOutput represents the output of a GetMetrics operation.

type GetNumbersInput

type GetNumbersInput struct {
	// contains filtered or unexported fields
}

GetNumbersInput represents the input of a GetNumbers operation.

type GetNumbersOutput

type GetNumbersOutput struct {
	Numbers []*Number
	// contains filtered or unexported fields
}

GetNumbersOutput represents the output of a GetNumbers operation.

type GetScheduleInput

type GetScheduleInput struct {
	ScheduleID *int64

	// describes optional properties that should be included in the response
	Include []*string
	// contains filtered or unexported fields
}

GetScheduleInput represents the input of a GetSchedule operation.

type GetScheduleOutput

type GetScheduleOutput struct {
	Schedule *Schedule
	// contains filtered or unexported fields
}

GetScheduleOutput represents the output of a GetSchedule operation.

type GetScheduleOverridesInput

type GetScheduleOverridesInput struct {
	ScheduleID *int64
	// contains filtered or unexported fields
}

GetScheduleOverridesInput represents the input of a GetScheduleOverrides operation.

type GetScheduleOverridesOutput

type GetScheduleOverridesOutput struct {
	Overrides []*Shift
	// contains filtered or unexported fields
}

GetScheduleOverridesOutput represents the output of a GetScheduleOverrides operation.

type GetScheduleShiftsInput

type GetScheduleShiftsInput struct {
	ScheduleID       *int64
	From             *string // Date time string in ISO format
	Until            *string // Date time string in ISO format
	ExcludeOverrides *bool
	// contains filtered or unexported fields
}

GetScheduleShiftsInput represents the input of a GetScheduleShifts operation.

type GetScheduleShiftsOutput

type GetScheduleShiftsOutput struct {
	Shifts []*Shift
	// contains filtered or unexported fields
}

GetScheduleShiftsOutput represents the output of a GetScheduleShifts operation.

type GetScheduleUserOnCallInput

type GetScheduleUserOnCallInput struct {
	ScheduleID *int64
	// contains filtered or unexported fields
}

GetScheduleUserOnCallInput represents the input of a GetScheduleUserOnCall operation.

type GetScheduleUserOnCallOutput

type GetScheduleUserOnCallOutput struct {
	Shift *Shift
	// contains filtered or unexported fields
}

GetScheduleUserOnCallOutput represents the output of a GetScheduleUserOnCall operation.

type GetSchedulesInput

type GetSchedulesInput struct {

	// an integer specifying the starting point (beginning with 0) when paging through a list of entities
	// Default: 0
	StartIndex *int

	// the maximum number of results when paging through a list of entities.
	// Default: 20, Maximum: 20
	MaxResults *int

	// describes optional properties that should be included in the response
	Include []*string
	// contains filtered or unexported fields
}

GetSchedulesInput represents the input of a GetSchedules operation.

type GetSchedulesOutput

type GetSchedulesOutput struct {
	Schedules []*Schedule
	// contains filtered or unexported fields
}

GetSchedulesOutput represents the output of a GetSchedules operation.

type GetServiceInput

type GetServiceInput struct {
	ServiceID *int64

	// describes optional properties that should be included in the response
	Include []*string
	// contains filtered or unexported fields
}

GetServiceInput represents the input of a GetService operation.

type GetServiceOutput

type GetServiceOutput struct {
	Service *Service
	// contains filtered or unexported fields
}

GetServiceOutput represents the output of a GetService operation.

type GetServiceSubscribersInput

type GetServiceSubscribersInput struct {
	ServiceID *int64
	// contains filtered or unexported fields
}

GetServiceSubscribersInput represents the input of a GetServiceSubscribers operation.

type GetServiceSubscribersOutput

type GetServiceSubscribersOutput struct {
	Subscribers []*Subscriber
	// contains filtered or unexported fields
}

GetServiceSubscribersOutput represents the output of a GetServiceSubscribers operation.

type GetServicesInput

type GetServicesInput struct {

	// an integer specifying the starting point (beginning with 0) when paging through a list of entities
	// Default: 0
	StartIndex *int

	// the maximum number of results when paging through a list of entities.
	// Default: 10, Maximum: 25 or 100 without include
	MaxResults *int

	// describes optional properties that should be included in the response
	Include []*string
	// contains filtered or unexported fields
}

GetServicesInput represents the input of a GetServices operation.

type GetServicesOutput

type GetServicesOutput struct {
	Services []*Service
	// contains filtered or unexported fields
}

GetServicesOutput represents the output of a GetServices operation.

type GetStatusPageGroupInput

type GetStatusPageGroupInput struct {
	StatusPageGroupID *int64
	StatusPageID      *int64
	// contains filtered or unexported fields
}

GetStatusPageGroupInput represents the input of a GetStatusPageGroup operation.

type GetStatusPageGroupOutput

type GetStatusPageGroupOutput struct {
	StatusPageGroup *StatusPageGroup
	// contains filtered or unexported fields
}

GetStatusPageGroupOutput represents the output of a GetStatusPageGroup operation.

type GetStatusPageGroupsInput

type GetStatusPageGroupsInput struct {

	// an integer specifying the starting point (beginning with 0) when paging through a list of entities
	StartIndex *int

	// the maximum number of results when paging through a list of entities.
	// Default: 50, Maximum: 100
	MaxResults   *int
	StatusPageID *int64
	// contains filtered or unexported fields
}

GetStatusPageGroupsInput represents the input of a GetStatusPageGroups operation.

type GetStatusPageGroupsOutput

type GetStatusPageGroupsOutput struct {
	StatusPageGroups []*StatusPageGroup
	// contains filtered or unexported fields
}

GetStatusPageGroupsOutput represents the output of a GetStatusPageGroups operation.

type GetStatusPageInput

type GetStatusPageInput struct {
	StatusPageID *int64

	// describes optional properties that should be included in the response
	Include []*string
	// contains filtered or unexported fields
}

GetStatusPageInput represents the input of a GetStatusPage operation.

type GetStatusPageOutput

type GetStatusPageOutput struct {
	StatusPage *StatusPage
	// contains filtered or unexported fields
}

GetStatusPageOutput represents the output of a GetStatusPage operation.

type GetStatusPageSubscribersInput

type GetStatusPageSubscribersInput struct {
	StatusPageID *int64
	// contains filtered or unexported fields
}

GetStatusPageSubscribersInput represents the input of a GetStatusPageSubscribers operation.

type GetStatusPageSubscribersOutput

type GetStatusPageSubscribersOutput struct {
	Subscribers []*Subscriber
	// contains filtered or unexported fields
}

GetStatusPageSubscribersOutput represents the output of a GetStatusPageSubscribers operation.

type GetStatusPagesInput

type GetStatusPagesInput struct {

	// an integer specifying the starting point (beginning with 0) when paging through a list of entities
	// Default: 0
	StartIndex *int

	// the maximum number of results when paging through a list of entities.
	// Default: 50, Maximum: 100
	MaxResults *int

	// describes optional properties that should be included in the response
	Include []*string
	// contains filtered or unexported fields
}

GetStatusPagesInput represents the input of a GetStatusPagesInput operation.

type GetStatusPagesOutput

type GetStatusPagesOutput struct {
	StatusPages []*StatusPage
	// contains filtered or unexported fields
}

GetStatusPagesOutput represents the output of a GetStatusPages operation.

type GetSupportHourInput added in v3.4.0

type GetSupportHourInput struct {
	SupportHourID *int64
	// contains filtered or unexported fields
}

GetSupportHourInput represents the input of a GetSupportHour operation.

type GetSupportHourOutput added in v3.4.0

type GetSupportHourOutput struct {
	SupportHour *SupportHour
	// contains filtered or unexported fields
}

GetSupportHourOutput represents the output of a GetSupportHour operation.

type GetSupportHoursInput added in v3.4.0

type GetSupportHoursInput struct {

	// an integer specifying the starting point (beginning with 0) when paging through a list of entities
	StartIndex *int

	// the maximum number of results when paging through a list of entities.
	// Maximum: 100
	MaxResults *int
	// contains filtered or unexported fields
}

GetSupportHoursInput represents the input of a GetSupportHours operation.

type GetSupportHoursOutput added in v3.4.0

type GetSupportHoursOutput struct {
	SupportHours []*SupportHour
	// contains filtered or unexported fields
}

GetSupportHoursOutput represents the output of a GetSupportHours operation.

type GetTeamInput

type GetTeamInput struct {
	TeamID *int64
	// contains filtered or unexported fields
}

GetTeamInput represents the input of a GetTeam operation.

type GetTeamOutput

type GetTeamOutput struct {
	Team *Team
	// contains filtered or unexported fields
}

GetTeamOutput represents the output of a GetTeam operation.

type GetTeamsInput

type GetTeamsInput struct {

	// an integer specifying the starting point (beginning with 0) when paging through a list of entities
	StartIndex *int

	// the maximum number of results when paging through a list of entities.
	// Maximum: 100
	MaxResults *int
	// contains filtered or unexported fields
}

GetTeamsInput represents the input of a GetTeams operation.

type GetTeamsOutput

type GetTeamsOutput struct {
	Teams []*Team
	// contains filtered or unexported fields
}

GetTeamsOutput represents the output of a GetTeams operation.

type GetUptimeMonitorInput

type GetUptimeMonitorInput struct {
	UptimeMonitorID *int64
	// contains filtered or unexported fields
}

GetUptimeMonitorInput represents the input of a GetUptimeMonitor operation.

type GetUptimeMonitorOutput

type GetUptimeMonitorOutput struct {
	UptimeMonitor *UptimeMonitor
	// contains filtered or unexported fields
}

GetUptimeMonitorOutput represents the output of a GetUptimeMonitor operation.

type GetUptimeMonitorsCountInput

type GetUptimeMonitorsCountInput struct {
	// contains filtered or unexported fields
}

GetUptimeMonitorsCountInput represents the input of a GetUptimeMonitorsCount operation.

type GetUptimeMonitorsCountOutput

type GetUptimeMonitorsCountOutput struct {
	Count int
	// contains filtered or unexported fields
}

GetUptimeMonitorsCountOutput represents the output of a GetUptimeMonitorsCount operation.

type GetUptimeMonitorsInput

type GetUptimeMonitorsInput struct {

	// an integer specifying the starting point (beginning with 0) when paging through a list of entities
	StartIndex *int

	// the maximum number of results when paging through a list of entities.
	// Maximum: 100
	MaxResults *int
	// contains filtered or unexported fields
}

GetUptimeMonitorsInput represents the input of a GetUptimeMonitors operation.

type GetUptimeMonitorsOutput

type GetUptimeMonitorsOutput struct {
	UptimeMonitors []*UptimeMonitor
	// contains filtered or unexported fields
}

GetUptimeMonitorsOutput represents the output of a GetUptimeMonitors operation.

type GetUserAlertPreferenceInput

type GetUserAlertPreferenceInput struct {
	UserID                *int64
	UserAlertPreferenceID *int64
	// contains filtered or unexported fields
}

GetUserAlertPreferenceInput represents the input of a GetUserAlertPreference operation.

type GetUserAlertPreferenceOutput

type GetUserAlertPreferenceOutput struct {
	UserAlertPreference *UserAlertPreference
	// contains filtered or unexported fields
}

GetUserAlertPreferenceOutput represents the output of a GetUserAlertPreference operation.

type GetUserAlertPreferencesInput

type GetUserAlertPreferencesInput struct {
	UserID *int64
	// contains filtered or unexported fields
}

GetUserAlertPreferencesInput represents the input of a GetUserAlertPreferences operation.

type GetUserAlertPreferencesOutput

type GetUserAlertPreferencesOutput struct {
	UserAlertPreferences []*UserAlertPreference
	// contains filtered or unexported fields
}

GetUserAlertPreferencesOutput represents the output of a GetUserAlertPreferences operation.

type GetUserDutyPreferenceInput

type GetUserDutyPreferenceInput struct {
	UserID               *int64
	UserDutyPreferenceID *int64
	// contains filtered or unexported fields
}

GetUserDutyPreferenceInput represents the input of a GetUserDutyPreference operation.

type GetUserDutyPreferenceOutput

type GetUserDutyPreferenceOutput struct {
	UserDutyPreference *UserDutyPreference
	// contains filtered or unexported fields
}

GetUserDutyPreferenceOutput represents the output of a GetUserDutyPreference operation.

type GetUserDutyPreferencesInput

type GetUserDutyPreferencesInput struct {
	UserID *int64
	// contains filtered or unexported fields
}

GetUserDutyPreferencesInput represents the input of a GetUserDutyPreferences operation.

type GetUserDutyPreferencesOutput

type GetUserDutyPreferencesOutput struct {
	UserDutyPreferences []*UserDutyPreference
	// contains filtered or unexported fields
}

GetUserDutyPreferencesOutput represents the output of a GetUserDutyPreferences operation.

type GetUserEmailContactInput

type GetUserEmailContactInput struct {
	UserID             *int64
	UserEmailContactID *int64
	// contains filtered or unexported fields
}

GetUserEmailContactInput represents the input of a GetUserEmailContact operation.

type GetUserEmailContactOutput

type GetUserEmailContactOutput struct {
	UserEmailContact *UserEmailContact
	// contains filtered or unexported fields
}

GetUserEmailContactOutput represents the output of a GetUserEmailContact operation.

type GetUserEmailContactsInput

type GetUserEmailContactsInput struct {
	UserID *int64
	// contains filtered or unexported fields
}

GetUserEmailContactsInput represents the input of a GetUserEmailContacts operation.

type GetUserEmailContactsOutput

type GetUserEmailContactsOutput struct {
	UserEmailContacts []*UserEmailContact
	// contains filtered or unexported fields
}

GetUserEmailContactsOutput represents the output of a GetUserEmailContacts operation.

type GetUserInput

type GetUserInput struct {
	UserID   *int64
	Username *string
	// contains filtered or unexported fields
}

GetUserInput represents the input of a GetUser operation.

type GetUserOutput

type GetUserOutput struct {
	User *User
	// contains filtered or unexported fields
}

GetUserOutput represents the output of a GetUser operation.

type GetUserPhoneNumberContactInput

type GetUserPhoneNumberContactInput struct {
	UserID                   *int64
	UserPhoneNumberContactID *int64
	// contains filtered or unexported fields
}

GetUserPhoneNumberContactInput represents the input of a GetUserPhoneNumberContact operation.

type GetUserPhoneNumberContactOutput

type GetUserPhoneNumberContactOutput struct {
	UserPhoneNumberContact *UserPhoneNumberContact
	// contains filtered or unexported fields
}

GetUserPhoneNumberContactOutput represents the output of a GetUserPhoneNumberContact operation.

type GetUserPhoneNumberContactsInput

type GetUserPhoneNumberContactsInput struct {
	UserID *int64
	// contains filtered or unexported fields
}

GetUserPhoneNumberContactsInput represents the input of a GetUserPhoneNumberContacts operation.

type GetUserPhoneNumberContactsOutput

type GetUserPhoneNumberContactsOutput struct {
	UserPhoneNumberContacts []*UserPhoneNumberContact
	// contains filtered or unexported fields
}

GetUserPhoneNumberContactsOutput represents the output of a GetUserPhoneNumberContacts operation.

type GetUserSubscriptionPreferenceInput

type GetUserSubscriptionPreferenceInput struct {
	UserID                       *int64
	UserSubscriptionPreferenceID *int64
	// contains filtered or unexported fields
}

GetUserSubscriptionPreferenceInput represents the input of a GetUserSubscriptionPreference operation.

type GetUserSubscriptionPreferenceOutput

type GetUserSubscriptionPreferenceOutput struct {
	UserSubscriptionPreference *UserSubscriptionPreference
	// contains filtered or unexported fields
}

GetUserSubscriptionPreferenceOutput represents the output of a GetUserSubscriptionPreference operation.

type GetUserSubscriptionPreferencesInput

type GetUserSubscriptionPreferencesInput struct {
	UserID *int64
	// contains filtered or unexported fields
}

GetUserSubscriptionPreferencesInput represents the input of a GetUserSubscriptionPreferences operation.

type GetUserSubscriptionPreferencesOutput

type GetUserSubscriptionPreferencesOutput struct {
	UserSubscriptionPreferences []*UserSubscriptionPreference
	// contains filtered or unexported fields
}

GetUserSubscriptionPreferencesOutput represents the output of a GetUserSubscriptionPreferences operation.

type GetUserUpdatePreferenceInput

type GetUserUpdatePreferenceInput struct {
	UserID                 *int64
	UserUpdatePreferenceID *int64
	// contains filtered or unexported fields
}

GetUserUpdatePreferenceInput represents the input of a GetUserUpdatePreference operation.

type GetUserUpdatePreferenceOutput

type GetUserUpdatePreferenceOutput struct {
	UserUpdatePreference *UserUpdatePreference
	// contains filtered or unexported fields
}

GetUserUpdatePreferenceOutput represents the output of a GetUserUpdatePreference operation.

type GetUserUpdatePreferencesInput

type GetUserUpdatePreferencesInput struct {
	UserID *int64
	// contains filtered or unexported fields
}

GetUserUpdatePreferencesInput represents the input of a GetUserUpdatePreferences operation.

type GetUserUpdatePreferencesOutput

type GetUserUpdatePreferencesOutput struct {
	UserUpdatePreferences []*UserUpdatePreference
	// contains filtered or unexported fields
}

GetUserUpdatePreferencesOutput represents the output of a GetUserUpdatePreferences operation.

type GetUsersInput

type GetUsersInput struct {

	// an integer specifying the starting point (beginning with 0) when paging through a list of entities
	StartIndex *int

	// the maximum number of results when paging through a list of entities.
	// Maximum: 100
	MaxResults *int
	// contains filtered or unexported fields
}

GetUsersInput represents the input of a GetUsers operation.

type GetUsersOutput

type GetUsersOutput struct {
	Users []*User
	// contains filtered or unexported fields
}

GetUsersOutput represents the output of a GetUsers operation.

type Heartbeat

type Heartbeat struct {
	Summary     string `json:"summary"`
	IntervalSec int    `json:"intervalSec"`
	Status      string `json:"status"`
}

Heartbeat definition

type Incident

type Incident struct {
	ID               int64              `json:"id"`
	Summary          string             `json:"summary"`
	Status           string             `json:"status"`
	Message          string             `json:"message"`
	SendNotification bool               `json:"sendNotification"`
	CreatedAt        string             `json:"createdAt"` // Date time string in ISO format
	UpdatedAt        string             `json:"updatedAt"` // Date time string in ISO format
	AffectedServices []AffectedServices `json:"affectedServices"`
	ResolvedOn       string             `json:"resolvedOn,omitempty"` // Date time string in ISO format
	Subscribed       bool               `json:"subscribed,omitempty"`
	AffectedTeams    []TeamShort        `json:"affectedTeams,omitempty"`
}

Incident definition https://api.ilert.com/api-docs/#tag/Incidents

type IncidentTemplate

type IncidentTemplate struct {
	ID               int64       `json:"id"`
	Name             string      `json:"name"`
	Summary          string      `json:"summary"`
	Status           string      `json:"status"`
	Message          string      `json:"message"`
	SendNotification bool        `json:"send_notification"`
	Teams            []TeamShort `json:"teams,omitempty"`
}

Incident Template definition https://api.ilert.com/api-docs/#tag/Incident-Templates

type LayerRestriction

type LayerRestriction struct {
	From *TimeOfWeek `json:"from"`
	To   *TimeOfWeek `json:"to"`
}

type LinkTemplate added in v3.3.0

type LinkTemplate struct {
	Text         string    `json:"text,omitempty"`
	HrefTemplate *Template `json:"hrefTemplate,omitempty"`
}

LinkTemplate definition

type Mapping added in v3.3.0

type Mapping struct {
	Value    string `json:"value"`
	Priority string `json:"priority"`
}

Mapping definition

type Metric

type Metric struct {
	ID                    int64                   `json:"id,omitempty"`
	Name                  string                  `json:"name"`
	Description           string                  `json:"description,omitempty"`
	AggregationType       string                  `json:"aggregationType"`
	DisplayType           string                  `json:"displayType"`
	InterpolateGaps       bool                    `json:"interpolateGaps,omitempty"`
	LockYAxisMax          float64                 `json:"lockYAxisMax,omitempty"`
	LockYAxisMin          float64                 `json:"lockYAxisMin,omitempty"`
	MouseOverDecimal      float64                 `json:"mouseOverDecimal,omitempty"`
	ShowValuesOnMouseOver bool                    `json:"showValuesOnMouseOver,omitempty"`
	Teams                 []TeamShort             `json:"teams,omitempty"`
	UnitLabel             string                  `json:"unitLabel,omitempty"`
	IntegrationKey        string                  `json:"integrationKey,omitempty"`
	Metadata              *MetricProviderMetadata `json:"metadata,omitempty"`
	DataSource            *MetricDataSource       `json:"dataSource,omitempty"`
}

Metric definition https://api.ilert.com/api-docs/#tag/Metrics

type MetricDataSource

type MetricDataSource struct {
	ID       int64                     `json:"id,omitempty"`
	Name     string                    `json:"name"`
	Type     string                    `json:"type"`
	Teams    []TeamShort               `json:"teams,omitempty"`
	Metadata *MetricDataSourceMetadata `json:"metadata"`
}

MetricDataSource definition https://api.ilert.com/api-docs/#tag/Metric-Data-Sources

type MetricDataSourceMetadata

type MetricDataSourceMetadata struct {
	Region         string `json:"region,omitempty"`         // used for Datadog
	ApiKey         string `json:"apiKey,omitempty"`         // used for Datadog
	ApplicationKey string `json:"applicationKey,omitempty"` // used for Datadog
	AuthType       string `json:"authType,omitempty"`       // used for Prometheus
	BasicUser      string `json:"basicUser,omitempty"`      // used for Prometheus
	BasicPass      string `json:"basicPass,omitempty"`      // used for Prometheus
	HeaderKey      string `json:"headerKey,omitempty"`      // used for Prometheus
	HeaderValue    string `json:"headerValue,omitempty"`    // used for Prometheus
	Url            string `json:"url,omitempty"`            // used for Prometheus
}

MetricDataSourceMetadata defines provider metadata for the metric data source

type MetricProviderMetadata

type MetricProviderMetadata struct {
	Query string `json:"query,omitempty"` // used for Datadog, Prometheus
}

MetricProviderMetadata defines provider metadata for the metric

type MultipleSeries

type MultipleSeries struct {
	Series []SingleSeries `json:"series"`
}

MultipleSeries definition https://api.ilert.com/api-docs/#tag/Series

type NotFoundAPIError

type NotFoundAPIError struct {
	Status  int    `json:"status"`
	Message string `json:"message"`
	Code    string `json:"code"`
	// contains filtered or unexported fields
}

NotFoundAPIError describes not-found API response error e.g. resource deleted or never exists

func (*NotFoundAPIError) Error

func (aerr *NotFoundAPIError) Error() string

type Number

type Number struct {
	CountryCode        string   `json:"countryCode"`
	PhoneNumber        string   `json:"phoneNumber"`
	SupportsInboundSMS bool     `json:"supportsInboundSms"`
	Types              []string `json:"types"`
}

Number definition https://api.ilert.com/api-docs/#tag/Numbers

type Ownership

type Ownership struct {
	TeamID int64 `json:"teamId"`
}

Ownership definition

type Phone

type Phone struct {
	RegionCode string `json:"regionCode"`
	Number     string `json:"number"`
}

Phone definition

type PingHeartbeatInput

type PingHeartbeatInput struct {
	Method *string
	APIKey *string
	// contains filtered or unexported fields
}

PingHeartbeatInput represents the input of a PingHeartbeat operation.

type PingHeartbeatOutput

type PingHeartbeatOutput struct {
	// contains filtered or unexported fields
}

PingHeartbeatOutput represents the output of a PingHeartbeat operation.

type PriorityTemplate added in v3.3.0

type PriorityTemplate struct {
	ValueTemplate *Template `json:"valueTemplate,omitempty"`
	Mappings      []Mapping `json:"mappings,omitempty"`
}

PriorityTemplate definition

type ResolveAlertInput

type ResolveAlertInput struct {
	AlertID *int64
	// contains filtered or unexported fields
}

ResolveAlertInput represents the input of a ResolveAlert operation.

type ResolveAlertOutput

type ResolveAlertOutput struct {
	Alert *Alert
	// contains filtered or unexported fields
}

ResolveAlertOutput represents the output of a ResolveAlert operation.

type RetryableAPIError

type RetryableAPIError struct {
	Status  int    `json:"status"`
	Message string `json:"message"`
	Code    string `json:"code"`
	// contains filtered or unexported fields
}

RetryableAPIError describes retryable API response error e.g. too many requests

func (*RetryableAPIError) Error

func (aerr *RetryableAPIError) Error() string

type Schedule

type Schedule struct {
	ID                   int64           `json:"id"`
	Name                 string          `json:"name"`
	Timezone             string          `json:"timezone"`
	Type                 string          `json:"type"`
	StartsOn             string          `json:"startsOn,omitempty"` // Date time string in ISO format, @deprecated
	ScheduleLayers       []ScheduleLayer `json:"scheduleLayers,omitempty"`
	Shifts               []Shift         `json:"shifts,omitempty"`
	ShowGaps             bool            `json:"showGaps,omitempty"`
	DefaultShiftDuration string          `json:"defaultShiftDuration,omitempty"` // for ex. P7D (7 Days) or PT8H (8 Hours)
	CurrentShift         *Shift          `json:"currentShift,omitempty"`
	NextShift            *Shift          `json:"nextShift,omitempty"`
	Teams                []TeamShort     `json:"teams,omitempty"`
}

Schedule definition https://api.ilert.com/api-docs/#tag/Schedules

type ScheduleLayer

type ScheduleLayer struct {
	Name            string             `json:"name"`
	StartsOn        string             `json:"startsOn"`         // Date time string in ISO format
	EndsOn          string             `json:"endsOn,omitempty"` // Date time string in ISO format
	Users           []User             `json:"users"`
	Rotation        string             `json:"rotation"` // P7D
	RestrictionType string             `json:"restrictionType,omitempty"`
	Restrictions    []LayerRestriction `json:"restrictions,omitempty"`
}

Schedule layer definition

type SearchAlertActionInput

type SearchAlertActionInput struct {
	AlertActionName *string
	// contains filtered or unexported fields
}

SearchAlertActionInput represents the input of a SearchAlertAction operation.

type SearchAlertActionOutput

type SearchAlertActionOutput struct {
	AlertAction *AlertActionOutput
	// contains filtered or unexported fields
}

SearchAlertActionOutput represents the output of a SearchAlertAction operation.

type SearchAlertSourceInput

type SearchAlertSourceInput struct {
	AlertSourceName *string
	// contains filtered or unexported fields
}

SearchAlertSourceInput represents the input of a SearchAlertSource operation.

type SearchAlertSourceOutput

type SearchAlertSourceOutput struct {
	AlertSource *AlertSource
	// contains filtered or unexported fields
}

SearchAlertSourceOutput represents the output of a SearchAlertSource operation.

type SearchConnectorInput

type SearchConnectorInput struct {
	ConnectorName *string
	// contains filtered or unexported fields
}

SearchConnectorInput represents the input of a SearchConnector operation.

type SearchConnectorOutput

type SearchConnectorOutput struct {
	Connector *ConnectorOutput
	// contains filtered or unexported fields
}

SearchConnectorOutput represents the output of a SearchConnector operation.

type SearchEscalationPolicyInput

type SearchEscalationPolicyInput struct {
	EscalationPolicyName *string
	// contains filtered or unexported fields
}

SearchEscalationPolicyInput represents the input of a SearchEscalationPolicy operation.

type SearchEscalationPolicyOutput

type SearchEscalationPolicyOutput struct {
	EscalationPolicy *EscalationPolicy
	// contains filtered or unexported fields
}

SearchEscalationPolicyOutput represents the output of a SearchEscalationPolicy operation.

type SearchIncidentTemplateInput

type SearchIncidentTemplateInput struct {
	IncidentTemplateName *string
	// contains filtered or unexported fields
}

SearchIncidentTemplateInput represents the input of a SearchIncidentTemplate operation.

type SearchIncidentTemplateOutput

type SearchIncidentTemplateOutput struct {
	IncidentTemplate *IncidentTemplate
	// contains filtered or unexported fields
}

SearchIncidentTemplateOutput represents the output of a SearchIncidentTemplate operation.

type SearchMetricDataSourceInput

type SearchMetricDataSourceInput struct {
	MetricDataSourceName *string
	// contains filtered or unexported fields
}

SearchMetricDataSourceInput represents the input of a SearchMetricDataSource operation.

type SearchMetricDataSourceOutput

type SearchMetricDataSourceOutput struct {
	MetricDataSource *MetricDataSource
	// contains filtered or unexported fields
}

SearchMetricDataSourceOutput represents the output of a SearchMetricDataSource operation.

type SearchMetricInput

type SearchMetricInput struct {
	MetricName *string
	// contains filtered or unexported fields
}

SearchMetricInput represents the input of a SearchMetric operation.

type SearchMetricOutput

type SearchMetricOutput struct {
	Metric *Metric
	// contains filtered or unexported fields
}

SearchMetricOutput represents the output of a SearchMetric operation.

type SearchScheduleInput

type SearchScheduleInput struct {
	ScheduleName *string
	// contains filtered or unexported fields
}

SearchScheduleInput represents the input of a SearchSchedule operation.

type SearchScheduleOutput

type SearchScheduleOutput struct {
	Schedule *Schedule
	// contains filtered or unexported fields
}

SearchScheduleOutput represents the output of a SearchSchedule operation.

type SearchServiceInput

type SearchServiceInput struct {
	ServiceName *string
	// contains filtered or unexported fields
}

SearchServiceInput represents the input of a SearchService operation.

type SearchServiceOutput

type SearchServiceOutput struct {
	Service *Service
	// contains filtered or unexported fields
}

SearchServiceOutput represents the output of a SearchService operation.

type SearchStatusPageGroupInput

type SearchStatusPageGroupInput struct {
	StatusPageGroupName *string
	StatusPageID        *int64
	// contains filtered or unexported fields
}

SearchStatusPageGroupInput represents the input of a SearchStatusPageGroup operation.

type SearchStatusPageGroupOutput

type SearchStatusPageGroupOutput struct {
	StatusPageGroup *StatusPageGroup
	// contains filtered or unexported fields
}

SearchStatusPageGroupOutput represents the output of a SearchStatusPageGroup operation.

type SearchStatusPageInput

type SearchStatusPageInput struct {
	StatusPageName *string
	// contains filtered or unexported fields
}

SearchStatusPageInput represents the input of a SearchStatusPage operation.

type SearchStatusPageOutput

type SearchStatusPageOutput struct {
	StatusPage *StatusPage
	// contains filtered or unexported fields
}

SearchStatusPageOutput represents the output of a SearchStatusPage operation.

type SearchSupportHourInput added in v3.4.0

type SearchSupportHourInput struct {
	SupportHourName *string
	// contains filtered or unexported fields
}

SearchSupportHourInput represents the input of a SearchSupportHour operation.

type SearchSupportHourOutput added in v3.4.0

type SearchSupportHourOutput struct {
	SupportHour *SupportHour
	// contains filtered or unexported fields
}

SearchSupportHourOutput represents the output of a SearchSupportHour operation.

type SearchTeamInput

type SearchTeamInput struct {
	TeamName *string
	// contains filtered or unexported fields
}

SearchTeamInput represents the input of a SearchTeam operation.

type SearchTeamOutput

type SearchTeamOutput struct {
	Team *Team
	// contains filtered or unexported fields
}

SearchTeamOutput represents the output of a SearchTeam operation.

type SearchUptimeMonitorInput

type SearchUptimeMonitorInput struct {
	UptimeMonitorName *string
	// contains filtered or unexported fields
}

SearchUptimeMonitorInput represents the input of a SearchUptimeMonitor operation.

type SearchUptimeMonitorOutput

type SearchUptimeMonitorOutput struct {
	UptimeMonitor *UptimeMonitor
	// contains filtered or unexported fields
}

SearchUptimeMonitorOutput represents the output of a SearchUptimeMonitor operation.

type SearchUserEmailContactInput

type SearchUserEmailContactInput struct {
	UserID                 *int64
	UserEmailContactTarget *string
	// contains filtered or unexported fields
}

SearchUserEmailContactInput represents the input of a SearchUserEmailContact operation.

type SearchUserEmailContactOutput

type SearchUserEmailContactOutput struct {
	UserEmailContact *UserEmailContact
	// contains filtered or unexported fields
}

SearchUserEmailContactOutput represents the output of a SearchUserEmailContact operation.

type SearchUserInput

type SearchUserInput struct {
	UserEmail *string
	// contains filtered or unexported fields
}

SearchUserInput represents the input of a SearchUser operation.

type SearchUserOutput

type SearchUserOutput struct {
	User *User
	// contains filtered or unexported fields
}

SearchUserOutput represents the output of a SearchUser operation.

type SearchUserPhoneNumberContactInput

type SearchUserPhoneNumberContactInput struct {
	UserID                       *int64
	UserPhoneNumberContactTarget *string
	// contains filtered or unexported fields
}

SearchUserPhoneNumberContactInput represents the input of a SearchUserPhoneNumberContact operation.

type SearchUserPhoneNumberContactOutput

type SearchUserPhoneNumberContactOutput struct {
	UserPhoneNumberContact *UserPhoneNumberContact
	// contains filtered or unexported fields
}

SearchUserPhoneNumberContactOutput represents the output of a SearchUserPhoneNumberContact operation.

type Service

type Service struct {
	ID                  int64          `json:"id"`
	Name                string         `json:"name"`
	Status              string         `json:"status"`
	Description         string         `json:"description"`
	OneOpenIncidentOnly bool           `json:"oneOpenIncidentOnly"`
	ShowUptimeHistory   bool           `json:"showUptimeHistory"`
	Teams               []TeamShort    `json:"teams"`
	Subscribed          bool           `json:"subscribed,omitempty"`
	Uptime              *ServiceUptime `json:"uptime,omitempty"`
	Incidents           []Incident     `json:"incidents,omitempty"`
}

Service definition https://api.ilert.com/api-docs/#tag/Services

type ServiceOutage

type ServiceOutage struct {
	Status string `json:"status"`
	From   string `json:"from"`  // Date time string in ISO format
	Until  string `json:"until"` // Date time string in ISO format
}

ServiceOutage defines services outage

type ServiceUptime

type ServiceUptime struct {
	RangeStart       string                   `json:"rangeStart"` // Date time string in ISO format
	RangeEnd         string                   `json:"rangeEnd"`   // Date time string in ISO format
	Outages          []ServiceOutage          `json:"outages"`
	UptimePercentage *ServiceUptimePercentage `json:"uptimePercentage"`
}

ServiceUptime defines services uptime

type ServiceUptimePercentage

type ServiceUptimePercentage struct {
	P90 float64 `json:"p90"`
	P60 float64 `json:"p60"`
	P30 float64 `json:"p30"`
}

ServiceUptimePercentage defines service uptime percentage

type Shift

type Shift struct {
	User  User   `json:"user"`
	Start string `json:"start"` // Date time string in ISO format
	End   string `json:"end"`   // Date time string in ISO format
}

Shift definition

type SingleSeries

type SingleSeries struct {
	Timestamp int64   `json:"timestamp,omitempty"`
	Value     float64 `json:"value"`
}

SingleSeries definition https://api.ilert.com/api-docs/#tag/Series

type StatusPage

type StatusPage struct {
	ID                        int64                `json:"id"`
	Name                      string               `json:"name"`
	Domain                    string               `json:"domain"`
	Subdomain                 string               `json:"subdomain"`
	CustomCss                 string               `json:"customCss"`
	FaviconUrl                string               `json:"faviconUrl"`
	LogoUrl                   string               `json:"logoUrl"`
	Visibility                string               `json:"visibility"`
	HiddenFromSearch          bool                 `json:"hiddenFromSearch"`
	ShowSubscribeAction       bool                 `json:"showSubscribeAction"`
	ShowIncidentHistoryOption bool                 `json:"showIncidentHistoryOption"`
	PageTitle                 string               `json:"pageTitle"`
	PageDescription           string               `json:"pageDescription"`
	PageLayout                string               `json:"pageLayout,omitempty"`
	LogoRedirectUrl           string               `json:"logoRedirectUrl"`
	Activated                 bool                 `json:"activated"`
	Status                    string               `json:"status"`
	Teams                     []TeamShort          `json:"teams"`
	Timezone                  string               `json:"timezone,omitempty"`
	Services                  []Service            `json:"services,omitempty"`
	Subscribed                bool                 `json:"subscribed,omitempty"`
	IpWhitelist               []string             `json:"ipWhitelist,omitempty"`
	AccountWideView           bool                 `json:"accountWideView,omitempty"`
	Structure                 *StatusPageStructure `json:"structure,omitempty"`
	ThemeMode                 string               `json:"themeMode,omitempty"` // please use field `Appearance` instead
	Appearance                string               `json:"appearance,omitempty"`
}

StatusPage definition https://api.ilert.com/api-docs/#tag/Status-Pages

type StatusPageElement

type StatusPageElement struct {
	// Must be either a service ID or status page service group ID.
	// Provided service or status page service group must already be included in current status page
	ID int64 `json:"id"`

	// Must be either "SERVICE" or "GROUP", corresponding to given ID
	Type string `json:"type"`

	// Allowed values are "expand" | "no-graph"
	Options []string `json:"options,omitempty"`

	// Can only contain StatusPageElement of type "SERVICE".
	// Must not be set on type "SERVICE".
	// Must be set on type "GROUP".
	Children []StatusPageElement `json:"children,omitempty"`
}

StatusPageElement defines status page element

type StatusPageGroup

type StatusPageGroup struct {
	ID   int64  `json:"id"`
	Name string `json:"name"`
}

StatusPageGroup definition https://api.ilert.com/api-docs/#tag/Status-Pages/paths/~1status-pages~1{id}~1groups/post

type StatusPageStructure

type StatusPageStructure struct {
	Elements []StatusPageElement `json:"elements"`
}

StatusPageStructure defines status page structure

type Subscriber

type Subscriber struct {
	ID   int64  `json:"id"`
	Name string `json:"name"`
	Type string `json:"type"`
}

Subscriber defines a subscriber

type SupportDay

type SupportDay struct {
	Start string `json:"start"`
	End   string `json:"end"`
}

SupportDay definition

type SupportDays

type SupportDays struct {
	MONDAY    *SupportDay `json:"MONDAY"`
	TUESDAY   *SupportDay `json:"TUESDAY"`
	WEDNESDAY *SupportDay `json:"WEDNESDAY"`
	THURSDAY  *SupportDay `json:"THURSDAY"`
	FRIDAY    *SupportDay `json:"FRIDAY"`
	SATURDAY  *SupportDay `json:"SATURDAY"`
	SUNDAY    *SupportDay `json:"SUNDAY"`
}

SupportDays definition

type SupportHour added in v3.4.0

type SupportHour struct {
	ID          int64        `json:"id"`
	Name        string       `json:"name"`
	Teams       []TeamShort  `json:"teams,omitempty"`
	Timezone    string       `json:"timezone,omitempty"`
	SupportDays *SupportDays `json:"supportDays"`
}

SupportHour definition https://api.ilert.com/api-docs/#tag/SupportHours

type SupportHours

type SupportHours struct {
	Timezone           string      `json:"timezone"`
	AutoRaiseAlerts    bool        `json:"autoRaiseAlerts,omitempty"`    // Raise priority of all pending alerts for this alert source to 'high' when support hours begin
	AutoRaiseIncidents bool        `json:"autoRaiseIncidents,omitempty"` // @deprecated
	SupportDays        SupportDays `json:"supportDays"`
}

@deprecated SupportHours definition

func (*SupportHours) RemoveLegacyFields added in v3.4.0

func (s *SupportHours) RemoveLegacyFields()

type SupportHoursReference added in v3.4.0

type SupportHoursReference struct {
	ID int64 `json:"id"`
}

SupportHoursReference definition

type Team

type Team struct {
	ID         int64        `json:"id"`
	Name       string       `json:"name"`
	Visibility string       `json:"visibility"`
	Members    []TeamMember `json:"members"`
}

Team definition https://api.ilert.com/api-docs/#tag/Teams

type TeamMember

type TeamMember struct {
	User User   `json:"user"`
	Role string `json:"role"` // "ADMIN" or "USER" or "RESPONDER" or "STAKEHOLDER"
}

TeamMember definition

type TeamShort

type TeamShort struct {
	ID   int64  `json:"id"`
	Name string `json:"name,omitempty"`
}

TeamShort definition

type Template added in v3.1.0

type Template struct {
	TextTemplate string `json:"textTemplate,omitempty"`
}

Template definition

type TimeOfWeek

type TimeOfWeek struct {
	DayOfWeek string `json:"dayOfWeek"`
	Time      string `json:"time"` // Time string in format <15:00>
}

type UIMenuItem

type UIMenuItem struct {
	ID    int64  `json:"id"`
	Label string `json:"label"`
}

UIMenuItem defines the ui menu item

type UpdateAlertActionInput

type UpdateAlertActionInput struct {
	AlertActionID *string
	AlertAction   *AlertAction
	// contains filtered or unexported fields
}

UpdateAlertActionInput represents the input of an UpdateAlertAction operation.

type UpdateAlertActionOutput

type UpdateAlertActionOutput struct {
	AlertAction *AlertActionOutput
	// contains filtered or unexported fields
}

UpdateAlertActionOutput represents the output of an UpdateAlertAction operation.

type UpdateAlertSourceInput

type UpdateAlertSourceInput struct {
	AlertSourceID *int64
	AlertSource   *AlertSource
	// contains filtered or unexported fields
}

UpdateAlertSourceInput represents the input of a UpdateAlertSource operation.

type UpdateAlertSourceOutput

type UpdateAlertSourceOutput struct {
	AlertSource *AlertSource
	// contains filtered or unexported fields
}

UpdateAlertSourceOutput represents the output of a UpdateAlertSource operation.

type UpdateAutomationRuleInput

type UpdateAutomationRuleInput struct {
	AutomationRuleID *string
	AutomationRule   *AutomationRule
	// contains filtered or unexported fields
}

UpdateAutomationRuleInput represents the input of a UpdateAutomationRule operation.

type UpdateAutomationRuleOutput

type UpdateAutomationRuleOutput struct {
	AutomationRule *AutomationRule
	// contains filtered or unexported fields
}

UpdateAutomationRuleOutput represents the output of a UpdateAutomationRule operation.

type UpdateConnectionInput

type UpdateConnectionInput struct {
	ConnectionID *string
	Connection   *Connection
	// contains filtered or unexported fields
}

UpdateConnectionInput represents the input of a UpdateConnection operation.

type UpdateConnectionOutput

type UpdateConnectionOutput struct {
	Connection *ConnectionOutput
	// contains filtered or unexported fields
}

UpdateConnectionOutput represents the output of a UpdateConnection operation.

type UpdateConnectorInput

type UpdateConnectorInput struct {
	ConnectorID *string
	Connector   *Connector
	// contains filtered or unexported fields
}

UpdateConnectorInput represents the input of a UpdateConnector operation.

type UpdateConnectorOutput

type UpdateConnectorOutput struct {
	Connector *ConnectorOutput
	// contains filtered or unexported fields
}

UpdateConnectorOutput represents the output of a UpdateConnector operation.

type UpdateEscalationPolicyInput

type UpdateEscalationPolicyInput struct {
	EscalationPolicyID *int64
	EscalationPolicy   *EscalationPolicy
	// contains filtered or unexported fields
}

UpdateEscalationPolicyInput represents the input of a UpdateEscalationPolicy operation.

type UpdateEscalationPolicyOutput

type UpdateEscalationPolicyOutput struct {
	EscalationPolicy *EscalationPolicy
	// contains filtered or unexported fields
}

UpdateEscalationPolicyOutput represents the output of a UpdateEscalationPolicy operation.

type UpdateIncidentInput

type UpdateIncidentInput struct {
	IncidentID *int64
	Incident   *Incident
	ETag       *string
	// contains filtered or unexported fields
}

UpdateIncidentInput represents the input of a UpdateIncident operation.

type UpdateIncidentOutput

type UpdateIncidentOutput struct {
	Incident *Incident
	// contains filtered or unexported fields
}

UpdateIncidentOutput represents the output of a UpdateIncident operation.

type UpdateIncidentTemplateInput

type UpdateIncidentTemplateInput struct {
	IncidentTemplateID *int64
	IncidentTemplate   *IncidentTemplate
	// contains filtered or unexported fields
}

UpdateIncidentTemplateInput represents the input of a UpdateIncidentTemplate operation.

type UpdateIncidentTemplateOutput

type UpdateIncidentTemplateOutput struct {
	IncidentTemplate *IncidentTemplate
	// contains filtered or unexported fields
}

UpdateIncidentTemplateOutput represents the output of a UpdateIncidentTemplate operation.

type UpdateMetricDataSourceInput

type UpdateMetricDataSourceInput struct {
	MetricDataSourceID *int64
	MetricDataSource   *MetricDataSource
	// contains filtered or unexported fields
}

UpdateMetricDataSourceInput represents the input of a UpdateMetricDataSource operation.

type UpdateMetricDataSourceOutput

type UpdateMetricDataSourceOutput struct {
	MetricDataSource *MetricDataSource
	// contains filtered or unexported fields
}

UpdateMetricDataSourceOutput represents the output of a UpdateMetricDataSource operation.

type UpdateMetricInput

type UpdateMetricInput struct {
	MetricID *int64
	Metric   *Metric
	// contains filtered or unexported fields
}

UpdateMetricInput represents the input of a UpdateMetric operation.

type UpdateMetricOutput

type UpdateMetricOutput struct {
	Metric *Metric
	// contains filtered or unexported fields
}

UpdateMetricOutput represents the output of a UpdateMetric operation.

type UpdateScheduleInput

type UpdateScheduleInput struct {
	ScheduleID  *int64
	Schedule    *Schedule
	AbortOnGaps *bool
	// contains filtered or unexported fields
}

UpdateScheduleInput represents the input of a UpdateSchedule operation.

type UpdateScheduleOutput

type UpdateScheduleOutput struct {
	Schedule *Schedule
	// contains filtered or unexported fields
}

UpdateScheduleOutput represents the output of a UpdateSchedule operation.

type UpdateServiceInput

type UpdateServiceInput struct {
	ServiceID *int64
	Service   *Service
	// contains filtered or unexported fields
}

UpdateServiceInput represents the input of a UpdateService operation.

type UpdateServiceOutput

type UpdateServiceOutput struct {
	Service *Service
	// contains filtered or unexported fields
}

UpdateServiceOutput represents the output of a UpdateService operation.

type UpdateStatusPageGroupInput

type UpdateStatusPageGroupInput struct {
	StatusPageGroup   *StatusPageGroup
	StatusPageGroupID *int64
	StatusPageID      *int64
	// contains filtered or unexported fields
}

UpdateStatusPageGroupInput represents the input of a UpdateStatusPageGroup operation.

type UpdateStatusPageGroupOutput

type UpdateStatusPageGroupOutput struct {
	StatusPageGroup *StatusPageGroup
	// contains filtered or unexported fields
}

UpdateStatusPageGroupOutput represents the output of a UpdateStatusPageGroup operation.

type UpdateStatusPageInput

type UpdateStatusPageInput struct {
	StatusPageID *int64
	StatusPage   *StatusPage
	// contains filtered or unexported fields
}

UpdateStatusPageInput represents the input of a UpdateStatusPage operation.

type UpdateStatusPageOutput

type UpdateStatusPageOutput struct {
	StatusPage *StatusPage
	// contains filtered or unexported fields
}

UpdateStatusPageOutput represents the output of a UpdateStatusPage operation.

type UpdateSupportHourInput added in v3.4.0

type UpdateSupportHourInput struct {
	SupportHourID *int64
	SupportHour   *SupportHour
	// contains filtered or unexported fields
}

UpdateSupportHourInput represents the input of a UpdateSupportHour operation.

type UpdateSupportHourOutput added in v3.4.0

type UpdateSupportHourOutput struct {
	SupportHour *SupportHour
	// contains filtered or unexported fields
}

UpdateSupportHourOutput represents the output of a UpdateSupportHour operation.

type UpdateTeamInput

type UpdateTeamInput struct {
	TeamID *int64
	Team   *Team
	// contains filtered or unexported fields
}

UpdateTeamInput represents the input of a UpdateTeam operation.

type UpdateTeamOutput

type UpdateTeamOutput struct {
	Team *Team
	// contains filtered or unexported fields
}

UpdateTeamOutput represents the output of a UpdateTeam operation.

type UpdateUptimeMonitorInput

type UpdateUptimeMonitorInput struct {
	UptimeMonitorID *int64
	UptimeMonitor   *UptimeMonitor
	// contains filtered or unexported fields
}

UpdateUptimeMonitorInput represents the input of a UpdateUptimeMonitor operation.

type UpdateUptimeMonitorOutput

type UpdateUptimeMonitorOutput struct {
	UptimeMonitor *UptimeMonitor
	// contains filtered or unexported fields
}

UpdateUptimeMonitorOutput represents the output of a UpdateUptimeMonitor operation.

type UpdateUserAlertPreferenceInput

type UpdateUserAlertPreferenceInput struct {
	UserID                *int64
	UserAlertPreferenceID *int64
	UserAlertPreference   *UserAlertPreference
	// contains filtered or unexported fields
}

UpdateUserAlertPreferenceInput represents the input of a UpdateUserAlertPreference operation.

type UpdateUserAlertPreferenceOutput

type UpdateUserAlertPreferenceOutput struct {
	UserAlertPreference *UserAlertPreference
	// contains filtered or unexported fields
}

UpdateUserAlertPreferenceOutput represents the output of a UpdateUserAlertPreference operation.

type UpdateUserDutyPreferenceInput

type UpdateUserDutyPreferenceInput struct {
	UserID               *int64
	UserDutyPreferenceID *int64
	UserDutyPreference   *UserDutyPreference
	// contains filtered or unexported fields
}

UpdateUserDutyPreferenceInput represents the input of a UpdateUserDutyPreference operation.

type UpdateUserDutyPreferenceOutput

type UpdateUserDutyPreferenceOutput struct {
	UserDutyPreference *UserDutyPreference
	// contains filtered or unexported fields
}

UpdateUserDutyPreferenceOutput represents the output of a UpdateUserDutyPreference operation.

type UpdateUserEmailContactInput

type UpdateUserEmailContactInput struct {
	UserID             *int64
	UserEmailContactID *int64
	UserEmailContact   *UserEmailContact
	// contains filtered or unexported fields
}

UpdateUserEmailContactInput represents the input of a UpdateUserEmailContact operation.

type UpdateUserEmailContactOutput

type UpdateUserEmailContactOutput struct {
	UserEmailContact *UserEmailContact
	// contains filtered or unexported fields
}

UpdateUserEmailContactOutput represents the output of a UpdateUserEmailContact operation.

type UpdateUserInput

type UpdateUserInput struct {
	UserID   *int64
	Username *string
	User     *User
	// contains filtered or unexported fields
}

UpdateUserInput represents the input of a UpdateUser operation.

type UpdateUserOutput

type UpdateUserOutput struct {
	User *User
	// contains filtered or unexported fields
}

UpdateUserOutput represents the output of a UpdateUser operation.

type UpdateUserPhoneNumberContactInput

type UpdateUserPhoneNumberContactInput struct {
	UserID                   *int64
	UserPhoneNumberContactID *int64
	UserPhoneNumberContact   *UserPhoneNumberContact
	// contains filtered or unexported fields
}

UpdateUserPhoneNumberContactInput represents the input of a UpdateUserPhoneNumberContact operation.

type UpdateUserPhoneNumberContactOutput

type UpdateUserPhoneNumberContactOutput struct {
	UserPhoneNumberContact *UserPhoneNumberContact
	// contains filtered or unexported fields
}

UpdateUserPhoneNumberContactOutput represents the output of a UpdateUserPhoneNumberContact operation.

type UpdateUserSubscriptionPreferenceInput

type UpdateUserSubscriptionPreferenceInput struct {
	UserID                       *int64
	UserSubscriptionPreferenceID *int64
	UserSubscriptionPreference   *UserSubscriptionPreference
	// contains filtered or unexported fields
}

UpdateUserSubscriptionPreferenceInput represents the input of a UpdateUserSubscriptionPreference operation.

type UpdateUserSubscriptionPreferenceOutput

type UpdateUserSubscriptionPreferenceOutput struct {
	UserSubscriptionPreference *UserSubscriptionPreference
	// contains filtered or unexported fields
}

UpdateUserSubscriptionPreferenceOutput represents the output of a UpdateUserSubscriptionPreference operation.

type UpdateUserUpdatePreferenceInput

type UpdateUserUpdatePreferenceInput struct {
	UserID                 *int64
	UserUpdatePreferenceID *int64
	UserUpdatePreference   *UserUpdatePreference
	// contains filtered or unexported fields
}

UpdateUserUpdatePreferenceInput represents the input of a UpdateUserUpdatePreference operation.

type UpdateUserUpdatePreferenceOutput

type UpdateUserUpdatePreferenceOutput struct {
	UserUpdatePreference *UserUpdatePreference
	// contains filtered or unexported fields
}

UpdateUserUpdatePreferenceOutput represents the output of a UpdateUserUpdatePreference operation.

type UptimeMonitor

type UptimeMonitor struct {
	ID                              int64                    `json:"id,omitempty"`
	Name                            string                   `json:"name"`
	Region                          string                   `json:"region"`
	CheckType                       string                   `json:"checkType"`
	CheckParams                     UptimeMonitorCheckParams `json:"checkParams"`
	IntervalSec                     int                      `json:"intervalSec,omitempty"`                     // default: 300
	TimeoutMs                       int                      `json:"timeoutMs,omitempty"`                       // default: 30000
	CreateIncidentAfterFailedChecks int                      `json:"createIncidentAfterFailedChecks,omitempty"` // @deprecated
	CreateAlertAfterFailedChecks    int                      `json:"createAlertAfterFailedChecks,omitempty"`    // default: 1
	EscalationPolicy                *EscalationPolicy        `json:"escalationPolicy,omitempty"`
	Paused                          bool                     `json:"paused,omitempty"`   // default: false
	EmbedURL                        string                   `json:"embedURL,omitempty"` // read only
	ShareURL                        string                   `json:"shareURL,omitempty"` // read only
	Status                          string                   `json:"status,omitempty"`
	LastStatusChange                string                   `json:"lastStatusChange,omitempty"` // Date time string in ISO format
}

Legacy API - uptime monitors deprecated and will be removed in the next major version of the sdk

type UptimeMonitorCheckParams

type UptimeMonitorCheckParams struct {
	Host                     string   `json:"host,omitempty"`
	Port                     int      `json:"port,omitempty"`
	URL                      string   `json:"url,omitempty"`
	ResponseKeywords         []string `json:"responseKeywords,omitempty"` // only for `http`
	AlertBeforeSec           int      `json:"alertBeforeSec,omitempty"`   // only for `ssl`
	AlertOnFingerprintChange bool     `json:"alertOnFingerprintChange"`   // only for `ssl`
}

UptimeMonitorCheckParams definition

type User

type User struct {
	ID         int64  `json:"id,omitempty"`
	FirstName  string `json:"firstName,omitempty"`
	LastName   string `json:"lastName,omitempty"`
	Username   string `json:"username,omitempty"`
	Email      string `json:"email,omitempty"`
	Timezone   string `json:"timezone,omitempty"`
	Position   string `json:"position,omitempty"`
	Department string `json:"department,omitempty"`
	Language   string `json:"language,omitempty"`
	Role       string `json:"role,omitempty"`
	ShiftColor string `json:"shiftColor,omitempty"`
}

User definition https://api.ilert.com/api-docs/#tag/Users

func (*User) GetUsername

func (u *User) GetUsername() string

type UserAlertPreference

type UserAlertPreference struct {
	ID       int64             `json:"id,omitempty"`
	Method   string            `json:"method"`
	Contact  *UserContactShort `json:"contact"` // is either UserEmailContact or UserPhoneNumberContact
	DelayMin int64             `json:"delayMin"`
	Type     string            `json:"type"`
}

UserNotificationPreference definition https://api.ilert.com/api-docs/#tag/Notification-Preferences

type UserContactShort

type UserContactShort struct {
	ID int64 `json:"id"`
}

type UserDutyPreference

type UserDutyPreference struct {
	ID        int64             `json:"id,omitempty"`
	Method    string            `json:"method"`
	Contact   *UserContactShort `json:"contact"` // is either UserEmailContact or UserPhoneNumberContact
	BeforeMin int64             `json:"beforeMin"`
	Type      string            `json:"type"`
}

UserNotificationPreference definition https://api.ilert.com/api-docs/#tag/Notification-Preferences

type UserEmailContact

type UserEmailContact struct {
	ID     int64  `json:"id,omitempty"`
	Target string `json:"target"`
	Status string `json:"status,omitempty"`
}

UserEmailContact definition https://api.ilert.com/api-docs/#tag/Contacts

type UserPhoneNumberContact

type UserPhoneNumberContact struct {
	ID         int64  `json:"id,omitempty"`
	RegionCode string `json:"regionCode"`
	Target     string `json:"target"`
	Status     string `json:"status,omitempty"`
}

UserPhoneNumberContact definition https://api.ilert.com/api-docs/#tag/Contacts

type UserSubscriptionPreference

type UserSubscriptionPreference struct {
	ID      int64             `json:"id,omitempty"`
	Method  string            `json:"method"`
	Contact *UserContactShort `json:"contact"` // is either UserEmailContact or UserPhoneNumberContact
}

UserNotificationPreference definition https://api.ilert.com/api-docs/#tag/Notification-Preferences

type UserUpdatePreference

type UserUpdatePreference struct {
	ID      int64             `json:"id,omitempty"`
	Method  string            `json:"method"`
	Contact *UserContactShort `json:"contact"` // is either UserEmailContact or UserPhoneNumberContact
	Type    string            `json:"type"`
}

UserNotificationPreference definition https://api.ilert.com/api-docs/#tag/Notification-Preferences

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL