ilert

package module
v2.6.0 Latest Latest
Warning

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

 Go to latest Published: Jan 18, 2023 License: Apache-2.0 Imports: 9 Imported by: 1

README

ilert-go

The official iLert Go api bindings.

Legacy API

If you want to use the old client with v1 resources, please install it with the following command: go get github.com/iLert/ilert-go

Create an incident (manually)

package main

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

func main() {

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

	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/v2"
)

func main() {

	client := ilert.NewClient()

	var apiKey = "heartbeat API Key"
	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/v2"
)

func main() {
	client := ilert.NewClient(ilert.WithProxy("http://proxyserver:8888"))
	...
}

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 = "v2.6.0"

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
	AlertResolved      string
	AlertAutoResolved  string
}{
	AlertCreated:       "alert-created",
	AlertAssigned:      "alert-assigned",
	AlertAutoEscalated: "alert-auto-escalated",
	AlertAcknowledged:  "alert-acknowledged",
	AlertRaised:        "alert-raised",
	AlertCommentAdded:  "alert-comment-added",
	AlertResolved:      "alert-resolved",
	AlertAutoResolved:  "alert-auto-resolved",
}

AlertActionTriggerTypes defines alertAction trigger types

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

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 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
}{

	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",
}

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,
}

AlertSourceAlertCreationsAll defines alert source alert creations 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
}{
	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",
}

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,
}

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 {
	AWSLambda         string
	AzureFAAS         string
	Datadog           string
	Discord           string
	Email             string
	Github            string
	GoogleFAAS        string
	Jira              string
	MicrosoftTeams    string
	MicrosoftTeamsBot string
	ServiceNow        string
	Slack             string
	Sysdig            string
	Topdesk           string
	Webhook           string
	Zapier            string
	Zendesk           string
	Autotask          string
	Mattermost        string
	Zammad            string
	ZoomChat          string
	ZoomMeeting       string
	StatusPageIO      string
	Webex             string
	DingTalk          string
	DingTalkAction    string
	AutomationRule    string
}{
	AWSLambda:         "aws_lambda",
	AzureFAAS:         "azure_faas",
	Datadog:           "datadog",
	Discord:           "discord",
	Email:             "email",
	Github:            "github",
	GoogleFAAS:        "google_faas",
	Jira:              "jira",
	MicrosoftTeams:    "microsoft_teams",
	MicrosoftTeamsBot: "microsoft_teams_bot",
	ServiceNow:        "servicenow",
	Slack:             "slack",
	Sysdig:            "sysdig",
	Topdesk:           "topdesk",
	Webhook:           "webhook",
	Zapier:            "zapier",
	Zendesk:           "zendesk",
	Autotask:          "autotask",
	Mattermost:        "mattermost",
	Zammad:            "zammad",
	ZoomChat:          "zoom_chat",
	ZoomMeeting:       "zoom_meeting",
	StatusPageIO:      "status_page_io",
	Webex:             "webex",
	DingTalk:          "dingtalk",
	DingTalkAction:    "dingtalk_action",
	AutomationRule:    "automation_rule",
}

ConnectorTypes defines connector types

View Source 
var ConnectorTypesAll = []string{
	ConnectorTypes.AWSLambda,
	ConnectorTypes.AzureFAAS,
	ConnectorTypes.Datadog,
	ConnectorTypes.Discord,
	ConnectorTypes.Email,
	ConnectorTypes.Github,
	ConnectorTypes.GoogleFAAS,
	ConnectorTypes.Jira,
	ConnectorTypes.MicrosoftTeams,
	ConnectorTypes.MicrosoftTeamsBot,
	ConnectorTypes.ServiceNow,
	ConnectorTypes.Slack,
	ConnectorTypes.Sysdig,
	ConnectorTypes.Topdesk,
	ConnectorTypes.Webhook,
	ConnectorTypes.Zapier,
	ConnectorTypes.Zendesk,
	ConnectorTypes.Autotask,
	ConnectorTypes.Mattermost,
	ConnectorTypes.Zammad,
	ConnectorTypes.ZoomChat,
	ConnectorTypes.ZoomMeeting,
	ConnectorTypes.StatusPageIO,
	ConnectorTypes.Webex,
	ConnectorTypes.DingTalk,
	ConnectorTypes.DingTalkAction,
	ConnectorTypes.AutomationRule,
}

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 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 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

View Source 
var UptimeMonitorCheckTypesAll = []string{
	UptimeMonitorCheckTypes.HTTP,
	UptimeMonitorCheckTypes.Ping,
	UptimeMonitorCheckTypes.TCP,
	UptimeMonitorCheckTypes.UDP,
	UptimeMonitorCheckTypes.SSL,
}

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

View Source 
var UptimeMonitorStatusesAll = []string{
	UptimeMonitorStatuses.Up,
	UptimeMonitorStatuses.Down,
	UptimeMonitorStatuses.Warning,
	UptimeMonitorStatuses.Paused,
	UptimeMonitorStatuses.Unknown,
}

UptimeMonitorStatusesAll defines uptime monitor statuses list

View Source 
var UserAlertUpdateNotificationTypes = struct {
	Email         string
	PushAndroid   string
	PushIPhone    string
	SMS           string
	VoiceMobile   string
	VoiceLandline string
	WhatsApp      string
}{
	Email:         "EMAIL",
	PushAndroid:   "ANDROID",
	PushIPhone:    "IPHONE",
	SMS:           "SMS",
	VoiceMobile:   "VOICE_MOBILE",
	VoiceLandline: "VOICE_LANDLINE",
	WhatsApp:      "WHATSAPP",
}

UserAlertUpdateNotificationTypes defines user alert update notification types

View Source 
var UserAlertUpdateNotificationTypesAll = []string{
	UserAlertUpdateNotificationTypes.Email,
	UserAlertUpdateNotificationTypes.PushAndroid,
	UserAlertUpdateNotificationTypes.PushIPhone,
	UserAlertUpdateNotificationTypes.SMS,
	UserAlertUpdateNotificationTypes.VoiceMobile,
	UserAlertUpdateNotificationTypes.VoiceLandline,
	UserAlertUpdateNotificationTypes.WhatsApp,
}

UserAlertUpdateNotificationTypesAll defines user alert update notification types list

View Source 
var UserAlertUpdateStates = struct {
	Accepted  string
	Escalated string
	Resolved  string
}{
	Accepted:  "ACCEPTED",
	Escalated: "ESCALATED",
	Resolved:  "RESOLVED",
}

UserAlertUpdateStates defines user alert update states

View Source 
var UserAlertUpdateStatesAll = []string{
	UserAlertUpdateStates.Accepted,
	UserAlertUpdateStates.Escalated,
	UserAlertUpdateStates.Resolved,
}

UserAlertUpdateStatesAll defines user alert update states 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 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

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 added in v2.1.0 

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

AddScheduleShiftOverrideInput represents the input of a AddScheduleShiftOverride operation.

type AddScheduleShiftOverrideOutput added in v2.1.0 

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"`
	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"`
	AlertFilter    *AlertFilter `json:"alertFilter,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"`
	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         *AlertActionOutputParams `json:"params"`
	AlertFilter    *AlertFilter             `json:"alertFilter,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
	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
	TemplateId       int64    `json:"templateId,omitempty"`       // Automation rule
	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
	URL              string   `json:"url,omitempty"`              // DingTalk
}

AlertActionOutputParams definition

type AlertActionParamsAWSLambda 

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

AlertActionParamsAWSLambda definition

type AlertActionParamsAutomationRule added in v2.3.0 

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 AlertActionParamsAzureFunction 

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

AlertActionParamsAzureFunction definition

type AlertActionParamsDatadog 

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

AlertActionParamsDatadog definition

type AlertActionParamsDingTalk added in v2.3.0 

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

AlertActionParamsDingTalk definition

type AlertActionParamsDingTalkAction added in v2.3.0 

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 AlertActionParamsGoogleFunction 

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

AlertActionParamsGoogleFunction 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 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 AlertActionParamsStatusPageIO 

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

AlertActionParamsStatusPageIO definition

type AlertActionParamsSysdig 

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

AlertActionParamsSysdig 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 AlertActionParamsZapier 

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

AlertActionParamsZapier 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 added in v2.3.2 

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

AlertFilter definition

type AlertFilterPredicate added in v2.3.2 

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           *SupportHours          `json:"supportHours,omitempty"`
	EscalationPolicy       *EscalationPolicy      `json:"escalationPolicy,omitempty"`
	Metadata               map[string]interface{} `json:"metadata,omitempty"`
	AutotaskMetadata       *AutotaskMetadata      `json:"autotaskMetadata,omitempty"`
	Heartbeat              *Heartbeat             `json:"heartbeat,omitempty"`
	Teams                  []TeamShort            `json:"teams,omitempty"`
}

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 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 added in v2.1.0 

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 an 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 an statuspage. 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 statuspage. 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 incidentTemplate. https://api.ilert.com/api-docs/#tag/Incident-Templates/paths/~1incident-templates/post

func (*Client) CreateMetric added in v2.6.0 

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 added in v2.6.0 

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 added in v2.6.0 

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 added in v2.1.0 

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 added in v2.6.0 

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 added in v2.5.0 

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

CreateStatusPageGroup creates a new StatusPageGroup. https://api.ilert.com/api-docs/#tag/Status-Pages/paths/~1status-pages~1{id}~1groups/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/posts

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) 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 incidentTemplate. https://api.ilert.com/api-docs/#tag/Incident-Templates/paths/~1incident-templates~1{id}/delete

func (*Client) DeleteMetric added in v2.6.0 

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 added in v2.6.0 

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 added in v2.1.0 

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 statuspage. https://api.ilert.com/api-docs/#tag/Status-Pages/paths/~1status-pages~1{id}/delete

func (*Client) DeleteStatusPageGroup added in v2.5.0 

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

DeleteStatusPageGroup deletes the specified StatusPageGroup. 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 statuspage. https://api.ilert.com/api-docs/#tag/Status-Pages/paths/~1status-pages~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) 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 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 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 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 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 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 statuspages. 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 incidentTemplate sources. 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 incident sources. https://api.ilert.com/api-docs/#tag/Incidents/paths/~1incidents/get

func (*Client) GetMetric added in v2.6.0 

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 added in v2.6.0 

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 added in v2.6.0 

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

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

func (*Client) GetMetrics added in v2.6.0 

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

GetMetrics lists metric sources. 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 gets 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 gets 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 gets list 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 service sources. 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 statuspage by ID. https://api.ilert.com/api-docs/#tag/Status-Pages/paths/~1status-pages~1{id}/get

func (*Client) GetStatusPageGroup added in v2.5.0 

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

GetStatusPageGroup gets the StatusPageGroup 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 added in v2.5.0 

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

GetStatusPageGroups gets list of StatusPageGroups. 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 statusPage 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 statusPage sources. https://api.ilert.com/api-docs/#tag/Status-Pages/paths/~1status-pages/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 gets list 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 gets list 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 list 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 information about a user including contact methods and notification preferences. https://api.ilert.com/api-docs/#tag/Users/paths/~1users~1{user-id}/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 added in v2.2.0 

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

SearchAlertAction gets the alert action with specified name.

func (*Client) SearchAlertSource added in v2.2.0 

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

SearchAlertSource gets the alertSource with specified name.

func (*Client) SearchConnector added in v2.2.0 

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

SearchConnector gets the connector with specified name.

func (*Client) SearchEscalationPolicy added in v2.2.0 

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

SearchEscalationPolicy gets the escalationPolicy with specified name.

func (*Client) SearchIncidentTemplate added in v2.2.0 

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

SearchIncidentTemplate gets the incidentTemplate with specified name.

func (*Client) SearchMetric added in v2.6.0 

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

SearchMetric gets the metric with specified name.

func (*Client) SearchMetricDataSource added in v2.6.0 

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

SearchMetricDataSource gets the metric data source with specified name.

func (*Client) SearchSchedule added in v2.2.0 

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

SearchSchedule gets the schedule with specified name.

func (*Client) SearchService added in v2.2.0 

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

SearchService gets the service with specified name.

func (*Client) SearchStatusPage added in v2.2.0 

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

SearchStatusPage gets the statusPage with specified name.

func (*Client) SearchStatusPageGroup added in v2.5.0 

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

SearchStatusPageGroup gets the StatusPageGroup with specified name.

func (*Client) SearchTeam added in v2.2.0 

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

SearchTeam gets the team with specified name.

func (*Client) SearchUptimeMonitor added in v2.2.0 

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

SearchUptimeMonitor gets the UptimeMonitor with specified name.

func (*Client) SearchUser added in v2.2.0 

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

SearchUser gets the user with specified name.

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 incidentTemplate. https://api.ilert.com/api-docs/#tag/Incident-Templates/paths/~1incident-templates~1{id}/put

func (*Client) UpdateMetric added in v2.6.0 

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 added in v2.6.0 

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 added in v2.1.0 

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 statuspage. https://api.ilert.com/api-docs/#tag/Status-Pages/paths/~1status-pages~1{id}/put

func (*Client) UpdateStatusPageGroup added in v2.5.0 

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

UpdateStatusPageGroup updates an existing StatusPageGroup. https://api.ilert.com/api-docs/#tag/Status-Pages/paths/~1status-pages~1{id}~1groups~1{group-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

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 added in v2.2.3 

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 added in v2.3.0 

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 added in v2.6.0 

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

CreateMetricDataSourceInput represents the input of a CreateMetricDataSource operation.

type CreateMetricDataSourceOutput added in v2.6.0 

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

CreateMetricDataSourceOutput represents the output of a CreateMetricDataSource operation.

type CreateMetricInput added in v2.6.0 

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

CreateMetricInput represents the input of a CreateMetric operation.

type CreateMetricOutput added in v2.6.0 

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

CreateMetricOutput represents the output of a CreateMetric operation.

type CreateMultipleSeriesInput added in v2.6.0 

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

CreateMultipleSeriesInput represents the input of a CreateMultipleSeries operation.

type CreateScheduleInput added in v2.1.0 

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

CreateScheduleInput represents the input of a CreateSchedule operation.

type CreateScheduleOutput added in v2.1.0 

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 added in v2.6.0 

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

CreateSingleSeriesInput represents the input of a CreateSingleSeries operation.

type CreateStatusPageGroupInput added in v2.5.0 

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

CreateStatusPageGroupInput represents the input of a CreateStatusPageGroup operation.

type CreateStatusPageGroupOutput added in v2.5.0 

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 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 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 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 added in v2.6.0 

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

DeleteMetricDataSourceInput represents the input of a DeleteMetricDataSource operation.

type DeleteMetricDataSourceOutput added in v2.6.0 

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

DeleteMetricDataSourceOutput represents the output of a DeleteMetricDataSource operation.

type DeleteMetricInput added in v2.6.0 

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

DeleteMetricInput represents the input of a DeleteMetric operation.

type DeleteMetricOutput added in v2.6.0 

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

DeleteMetricOutput represents the output of a DeleteMetric operation.

type DeleteScheduleInput added in v2.1.0 

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

DeleteScheduleInput represents the input of a DeleteSchedule operation.

type DeleteScheduleOutput added in v2.1.0 

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 added in v2.5.0 

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

DeleteStatusPageGroupInput represents the input of a DeleteStatusPageGroup operation.

type DeleteStatusPageGroupOutput added in v2.5.0 

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 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 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 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"`
	Repeating       bool             `json:"repeating,omitempty"`
	Frequency       int              `json:"frequency,omitempty"`
	Teams           []TeamShort      `json:"teams,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
	// 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
	// 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 added in v2.6.0 

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

GetMetricDataSourceInput represents the input of a GetMetricDataSource operation.

type GetMetricDataSourceOutput added in v2.6.0 

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

GetMetricDataSourceOutput represents the output of a GetMetricDataSource operation.

type GetMetricDataSourcesInput added in v2.6.0 

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 added in v2.6.0 

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

GetMetricDataSourcesOutput represents the output of a GetMetricDataSources operation.

type GetMetricInput added in v2.6.0 

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

GetMetricInput represents the input of a GetMetric operation.

type GetMetricOutput added in v2.6.0 

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

GetMetricOutput represents the output of a GetMetric operation.

type GetMetricsInput added in v2.6.0 

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 added in v2.6.0 

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 added in v2.5.0 

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

GetStatusPageGroupInput represents the input of a GetStatusPageGroup operation.

type GetStatusPageGroupOutput added in v2.5.0 

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

GetStatusPageGroupOutput represents the output of a GetStatusPageGroup operation.

type GetStatusPageGroupsInput added in v2.5.0 

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 added in v2.5.0 

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 GetStatusPages operation.

type GetStatusPagesOutput 

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

GetStatusPagesOutput represents the output of a GetStatusPages 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 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 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 added in v2.1.0 

type LayerRestriction struct {
	From *TimeOfWeek `json:"from"`
	To   *TimeOfWeek `json:"to"`
}

type Metric added in v2.6.0 

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"`
	Metadata              *MetricProviderMetadata `json:"metadata,omitempty"`
	DataSource            *MetricDataSource       `json:"dataSource,omitempty"`
}

Metric definition https://api.ilert.com/api-docs/#tag/Metrics

type MetricDataSource added in v2.6.0 

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 added in v2.6.0 

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 added in v2.6.0 

type MetricProviderMetadata struct {
	Query string `json:"query,omitempty"` // used for Datadog, Prometheus
}

MetricProviderMetadata defines provider metadata for the metric

type MultipleSeries added in v2.6.0 

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 NotificationPreference 

type NotificationPreference struct {
	Delay  int    `json:"delay"`
	Method string `json:"method"` // e.g. EMAIL
}

NotificationPreference definition

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 OnCallNotificationPreference 

type OnCallNotificationPreference struct {
	BeforeMin int    `json:"beforeMin"`
	Method    string `json:"method"` // e.g. EMAIL
}

OnCallNotificationPreference definition

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 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 added in v2.1.0 

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 added in v2.2.0 

type SearchAlertActionInput struct {
	AlertActionName *string
	// contains filtered or unexported fields
}

SearchAlertActionInput represents the input of a SearchAlertAction operation.

type SearchAlertActionOutput added in v2.2.0 

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

SearchAlertActionOutput represents the output of a SearchAlertAction operation.

type SearchAlertSourceInput added in v2.2.0 

type SearchAlertSourceInput struct {
	AlertSourceName *string
	// contains filtered or unexported fields
}

SearchAlertSourceInput represents the input of a SearchAlertSource operation.

type SearchAlertSourceOutput added in v2.2.0 

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

SearchAlertSourceOutput represents the output of a SearchAlertSource operation.

type SearchConnectorInput added in v2.2.0 

type SearchConnectorInput struct {
	ConnectorName *string
	// contains filtered or unexported fields
}

SearchConnectorInput represents the input of a SearchConnector operation.

type SearchConnectorOutput added in v2.2.0 

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

SearchConnectorOutput represents the output of a SearchConnector operation.

type SearchEscalationPolicyInput added in v2.2.0 

type SearchEscalationPolicyInput struct {
	EscalationPolicyName *string
	// contains filtered or unexported fields
}

SearchEscalationPolicyInput represents the input of a SearchEscalationPolicy operation.

type SearchEscalationPolicyOutput added in v2.2.0 

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

SearchEscalationPolicyOutput represents the output of a SearchEscalationPolicy operation.

type SearchIncidentTemplateInput added in v2.2.0 

type SearchIncidentTemplateInput struct {
	IncidentTemplateName *string
	// contains filtered or unexported fields
}

SearchIncidentTemplateInput represents the input of a SearchIncidentTemplate operation.

type SearchIncidentTemplateOutput added in v2.2.0 

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

SearchIncidentTemplateOutput represents the output of a SearchIncidentTemplate operation.

type SearchMetricDataSourceInput added in v2.6.0 

type SearchMetricDataSourceInput struct {
	MetricDataSourceName *string
	// contains filtered or unexported fields
}

SearchMetricDataSourceInput represents the input of a SearchMetricDataSource operation.

type SearchMetricDataSourceOutput added in v2.6.0 

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

SearchMetricDataSourceOutput represents the output of a SearchMetricDataSource operation.

type SearchMetricInput added in v2.6.0 

type SearchMetricInput struct {
	MetricName *string
	// contains filtered or unexported fields
}

SearchMetricInput represents the input of a SearchMetric operation.

type SearchMetricOutput added in v2.6.0 

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

SearchMetricOutput represents the output of a SearchMetric operation.

type SearchScheduleInput added in v2.2.0 

type SearchScheduleInput struct {
	ScheduleName *string
	// contains filtered or unexported fields
}

SearchScheduleInput represents the input of a SearchSchedule operation.

type SearchScheduleOutput added in v2.2.0 

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

SearchScheduleOutput represents the output of a SearchSchedule operation.

type SearchServiceInput added in v2.2.0 

type SearchServiceInput struct {
	ServiceName *string
	// contains filtered or unexported fields
}

SearchServiceInput represents the input of a SearchService operation.

type SearchServiceOutput added in v2.2.0 

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

SearchServiceOutput represents the output of a SearchService operation.

type SearchStatusPageGroupInput added in v2.5.0 

type SearchStatusPageGroupInput struct {
	StatusPageGroupName *string
	StatusPageID        *int64
	// contains filtered or unexported fields
}

SearchStatusPageGroupInput represents the input of a SearchStatusPageGroup operation.

type SearchStatusPageGroupOutput added in v2.5.0 

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

SearchStatusPageGroupOutput represents the output of a SearchStatusPageGroup operation.

type SearchStatusPageInput added in v2.2.0 

type SearchStatusPageInput struct {
	StatusPageName *string
	// contains filtered or unexported fields
}

SearchStatusPageInput represents the input of a SearchStatusPage operation.

type SearchStatusPageOutput added in v2.2.0 

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

SearchStatusPageOutput represents the output of a SearchStatusPage operation.

type SearchTeamInput added in v2.2.0 

type SearchTeamInput struct {
	TeamName *string
	// contains filtered or unexported fields
}

SearchTeamInput represents the input of a SearchTeam operation.

type SearchTeamOutput added in v2.2.0 

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

SearchTeamOutput represents the output of a SearchTeam operation.

type SearchUptimeMonitorInput added in v2.2.0 

type SearchUptimeMonitorInput struct {
	UptimeMonitorName *string
	// contains filtered or unexported fields
}

SearchUptimeMonitorInput represents the input of a SearchUptimeMonitor operation.

type SearchUptimeMonitorOutput added in v2.2.0 

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

SearchUptimeMonitorOutput represents the output of a SearchUptimeMonitor operation.

type SearchUserInput added in v2.2.0 

type SearchUserInput struct {
	UserEmail *string
	// contains filtered or unexported fields
}

SearchUserInput represents the input of a SearchUser operation.

type SearchUserOutput added in v2.2.0 

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

SearchUserOutput represents the output of a SearchUser 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 added in v2.6.0 

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"`
	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"`
	Structure                 *StatusPageStructure `json:"structure,omitempty"`
}

StatusPage definition https://api.ilert.com/api-docs/#!/Status-Pages

type StatusPageElement added in v2.5.0 

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"`

	// 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 added in v2.5.0 

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 added in v2.5.0 

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 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"`
}

SupportHours 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 TimeOfWeek added in v2.1.0 

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 added in v2.6.0 

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

UpdateMetricDataSourceInput represents the input of a UpdateMetricDataSource operation.

type UpdateMetricDataSourceOutput added in v2.6.0 

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

UpdateMetricDataSourceOutput represents the output of a UpdateMetricDataSource operation.

type UpdateMetricInput added in v2.6.0 

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

UpdateMetricInput represents the input of a UpdateMetric operation.

type UpdateMetricOutput added in v2.6.0 

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

UpdateMetricOutput represents the output of a UpdateMetric operation.

type UpdateScheduleInput added in v2.1.0 

type UpdateScheduleInput struct {
	ScheduleID  *int64
	Schedule    *Schedule
	AbortOnGaps *bool
	// contains filtered or unexported fields
}

UpdateScheduleInput represents the input of a UpdateSchedule operation.

type UpdateScheduleOutput added in v2.1.0 

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 added in v2.5.0 

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

UpdateStatusPageGroupInput represents the input of a UpdateStatusPageGroup operation.

type UpdateStatusPageGroupOutput added in v2.5.0 

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 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 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 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
}

UptimeMonitor definition https://api.ilert.com/api-docs/#tag/Uptime-Monitors

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"`
	Username                                  string                         `json:"username,omitempty"`
	FirstName                                 string                         `json:"firstName,omitempty"`
	LastName                                  string                         `json:"lastName,omitempty"`
	Email                                     string                         `json:"email,omitempty"`
	Mobile                                    *Phone                         `json:"mobile,omitempty"`
	Landline                                  *Phone                         `json:"landline,omitempty"`
	Position                                  string                         `json:"position,omitempty"`
	Department                                string                         `json:"department,omitempty"`
	Timezone                                  string                         `json:"timezone,omitempty"`
	Language                                  string                         `json:"language,omitempty"`
	Role                                      string                         `json:"role,omitempty"`
	NotificationPreferences                   []NotificationPreference       `json:"notificationPreferences,omitempty"`
	LowNotificationPreferences                []NotificationPreference       `json:"lowPriorityNotificationPreferences,omitempty"`
	OnCallNotificationPreferences             []OnCallNotificationPreference `json:"onCallNotificationPreferences,omitempty"`
	SubscribedAlertUpdateStates               []string                       `json:"subscribedAlertUpdateStates,omitempty"`
	SubscribedIncidentUpdateStates            []string                       `json:"subscribedIncidentUpdateStates,omitempty"` // @deprecated
	SubscribedAlertUpdateNotificationTypes    []string                       `json:"subscribedAlertUpdateNotificationTypes,omitempty"`
	SubscribedIncidentUpdateNotificationTypes []string                       `json:"subscribedIncidentUpdateNotificationTypes,omitempty"` // @deprecated
}

User definition https://api.ilert.com/api-docs/#!/Users

func (*User) GetUsername 

func (u *User) GetUsername() string

Source Files

View all Source files

Directories

Path Synopsis
examples
alert
alertaction
alertsource
automationrules
connectors
escalationpolicy
event
heartbeat
incidents
incidenttemplate
metric
metricdatasource
number
schedules
series
services
statuspagegroup
statuspages
uptimemonitor
user

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.