uptrends

package module
v0.0.0-...-7278857 Latest Latest
Warning

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

Go to latest
Published: Jun 3, 2020 License: BSD-3-Clause Imports: 21 Imported by: 0

README

Go API client for uptrends

This document describes Uptrends API version 4. This Swagger environment also lets you execute API methods directly. Please note that this is not a sandbox environment: these API methods operate directly on your actual Uptrends account. For more information, please visit https://www.uptrends.com/api.

Overview

This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.

  • API version: 1.0.0
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.languages.GoClientCodegen

Installation

Put the package under your project folder and add the following in import:

import "./uptrends"

Documentation for API Endpoints

All URIs are relative to https://api.uptrends.com/v4

Class Method HTTP request Description
AccountApi AccountGetAccountStatistics Get /Account Returns the account statistics.
AlertApi AlertGetMonitorAlerts Get /Alert/Monitor/{monitorGuid} Returns alerts for a specific monitor.
AlertApi AlertGetMonitorGroupAlerts Get /Alert/MonitorGroup/{monitorGroupGuid} Returns alerts for a specific monitor group.
AlertDefinitionApi AlertDefinitionAddMonitorGroupToAlertDefinition Post /AlertDefinition/{alertDefinitionGuid}/Members/MonitorGroup/{monitorGroupGuid} Adds a monitor group to the specified alert definition.
AlertDefinitionApi AlertDefinitionAddMonitorToAlertDefinition Post /AlertDefinition/{alertDefinitionGuid}/Members/Monitor/{monitorGuid} Adds a monitor to the specified alert definition.
AlertDefinitionApi AlertDefinitionAddOperatorGroupToEscalationLevel Post /AlertDefinition/{alertDefinitionGuid}/EscalationLevel/{escalationLevelId}/Members/OperatorGroup/{operatorGroupGuid} Adds an operator group to the specified escalation level.
AlertDefinitionApi AlertDefinitionAddOperatorToEscalationLevel Post /AlertDefinition/{alertDefinitionGuid}/EscalationLevel/{escalationLevelId}/Members/Operator/{operatorGuid} Adds an operator to the specified escalation level.
AlertDefinitionApi AlertDefinitionCreateAlertDefinition Post /AlertDefinition Creates a new alert definition.
AlertDefinitionApi AlertDefinitionDeleteAlertDefinition Delete /AlertDefinition/{alertDefinitionGuid} Deletes an existing alert definition.
AlertDefinitionApi AlertDefinitionGetAllAlertDefinitions Get /AlertDefinition Gets a list of all alert definitions.
AlertDefinitionApi AlertDefinitionGetAllMembers Get /AlertDefinition/{alertDefinitionGuid}/Members Gets a list of all monitor and monitor group guids of the specified alert definition.
AlertDefinitionApi AlertDefinitionGetEscalationLevel Get /AlertDefinition/{alertDefinitionGuid}/EscalationLevel/{escalationLevelId} Gets the escalation level information of the specified alert definition.
AlertDefinitionApi AlertDefinitionGetEscalationLevelIntegration Get /AlertDefinition/{alertDefinitionGuid}/EscalationLevel/{escalationLevelId}/Integration Gets the integrations for the specified escalation level.
AlertDefinitionApi AlertDefinitionGetEscalationLevelOperator Get /AlertDefinition/{alertDefinitionGuid}/EscalationLevel/{escalationLevelId}/Members Gets the operator and operator group guids for the specified escalation level.
AlertDefinitionApi AlertDefinitionGetSpecifiedAlertDefinitions Get /AlertDefinition/{alertDefinitionGuid} Gets the specified alert definition.
AlertDefinitionApi AlertDefinitionPatchAlertDefinition Patch /AlertDefinition/{alertDefinitionGuid} Partially updates the definition of the specified alert definition.
AlertDefinitionApi AlertDefinitionPutAlertDefinition Put /AlertDefinition/{alertDefinitionGuid} Updates the definition of the specified alert definition.
AlertDefinitionApi AlertDefinitionRemoveMonitorFromAlertDefinition Delete /AlertDefinition/{alertDefinitionGuid}/Members/Monitor/{monitorGuid} Removes a monitor for the specified alert definition.
AlertDefinitionApi AlertDefinitionRemoveMonitorGroupFromAlertDefinition Delete /AlertDefinition/{alertDefinitionGuid}/Members/MonitorGroup/{monitorGroupGuid} Removes a monitor group for the specified alert definition.
AlertDefinitionApi AlertDefinitionRemoveOperatorFromEscalationLevel Delete /AlertDefinition/{alertDefinitionGuid}/EscalationLevel/{escalationLevelId}/Members/Operator/{operatorGuid} Removes an operator for the specified escalation level.
AlertDefinitionApi AlertDefinitionRemoveOperatorGroupFromEscalationLevel Delete /AlertDefinition/{alertDefinitionGuid}/EscalationLevel/{escalationLevelId}/Members/OperatorGroup/{operatorGroupGuid} Removes an operator group for the specified escalation level.
AlertDefinitionApi AlertDefinitionUpdateIntegrationForEscalationWithPatch Patch /AlertDefinition/{alertDefinitionGuid}/EscalationLevel/{escalationLevelId}/Integration/{integrationGuid} Partially updates an integration to the specified escalation level.
AlertDefinitionApi AlertDefinitionUpdateIntegrationForEscalationWithPut Put /AlertDefinition/{alertDefinitionGuid}/EscalationLevel/{escalationLevelId}/Integration/{integrationGuid} Updates an integration for the specified escalation level.
CheckpointApi CheckpointGetAllCheckpoints Get /Checkpoint Returns all the checkpoints.
CheckpointApi CheckpointGetCheckpoint Get /Checkpoint/{checkpointId} Returns the specified checkpoint.
CheckpointApi CheckpointRegionGetAllCheckpointRegions Get /CheckpointRegion Returns all the checkpoint regions.
CheckpointApi CheckpointRegionGetCheckpointRegionCheckpoints Get /CheckpointRegion/{checkpointRegionId}/Checkpoint Returns the checkpoints for the specified checkpoint region.
CheckpointApi CheckpointRegionGetSpecifiedCheckpointRegion Get /CheckpointRegion/{checkpointRegionId} Returns the specified checkpoint region.
CheckpointApi CheckpointServerGetAllServerIpv4Addresses Get /Checkpoint/Server/Ipv4 Anonymous call that returns all the IPv4 addresses of all the checkpoint servers.
CheckpointApi CheckpointServerGetAllServerIpv6Addresses Get /Checkpoint/Server/Ipv6 Anonymous call that returns all the IPv6 addresses of all the checkpoint servers.
CheckpointApi CheckpointServerGetServer Get /Checkpoint/Server/{serverId} Returns the requested checkpoint server.
DashboardApi DashboardCloneDashboard Post /Dashboard/{dashboardGuid}/Clone Clone the specified dashboard.
DashboardApi DashboardDeleteDashboard Delete /Dashboard/{dashboardGuid} Delete the specified dashboard.
DashboardApi DashboardGetAllDashboards Get /Dashboard Returns data for all dashboards.
DashboardApi DashboardGetOneDashboard Get /Dashboard/{dashboardGuid} Returns data for the specified dashboard.
DashboardApi DashboardPartiallyUpdateDashboard Patch /Dashboard/{dashboardGuid} Partially update the specified dashboard.
DashboardApi DashboardUpdateDashboard Put /Dashboard/{dashboardGuid} Update the specified dashboard.
IntegrationApi IntegrationGetAllIntegrations Get /Integration Gets a list of all integrations.
MiscellaneousApi MiscellaneousGetAllOutgoingPhoneNumbers Get /OutgoingPhoneNumber Gets a list of all outgoing phone numbers available.
MiscellaneousApi MiscellaneousGetAllTimezones Get /Timezone Gets all timezones available.
MiscellaneousApi MiscellaneousGetTimezoneById Get /Timezone/{timezoneId} Gets the timezone with the specified Id.
MonitorApi MonitorCleanupMaintenancePeriods Post /Monitor/{monitorGuid}/MaintenancePeriod/Cleanup/{beforeDate} Clears out all one-time maintenance periods for the specified monitor older than the specified date
MonitorApi MonitorCloneMonitor Post /Monitor/{monitorGuid}/Clone Creates a clone (duplicate) of the specified monitor.
MonitorApi MonitorCreateMaintenancePeriodForMonitor Post /Monitor/{monitorGuid}/MaintenancePeriod Saves the new maintenance period provided for the specified monitor
MonitorApi MonitorDeleteMaintenancePeriodFromMonitor Delete /Monitor/{monitorGuid}/MaintenancePeriod/{maintenancePeriodId} Deletes the specified maintenance period from the specified monitor
MonitorApi MonitorDeleteMonitor Delete /Monitor/{monitorGuid} Deletes the specified monitor.
MonitorApi MonitorGetAllMaintenancePeriodsForMonitor Get /Monitor/{monitorGuid}/MaintenancePeriod Finds all maintenance periods for a monitor.
MonitorApi MonitorGetMonitor Get /Monitor/{monitorGuid} Returns the definition of the specified monitor.
MonitorApi MonitorGetMonitors Get /Monitor Returns the definition of all monitors available in the account.
MonitorApi MonitorPatchMonitor Patch /Monitor/{monitorGuid} Partially updates the definition of the specified monitor.
MonitorApi MonitorPostMonitor Post /Monitor Creates a new monitor.
MonitorApi MonitorPutMonitor Put /Monitor/{monitorGuid} Updates the definition of the specified monitor.
MonitorApi MonitorUpdateMaintenancePeriodForMonitor Put /Monitor/{monitorGuid}/MaintenancePeriod/{maintenancePeriodId} Updates the specified maintenance schedule for the specified monitor
MonitorCheckApi MonitorCheckGetAccountMonitorChecks Get /MonitorCheck Returns all monitor check data.
MonitorCheckApi MonitorCheckGetHttpDetails Get /MonitorCheck/{monitorCheckId}/Http Returns HTTP details for a monitor check.
MonitorCheckApi MonitorCheckGetMonitorCheck Get /MonitorCheck/Monitor/{monitorGuid} Returns monitor check data for a specific monitor.
MonitorCheckApi MonitorCheckGetMonitorGroupData Get /MonitorCheck/MonitorGroup/{monitorGroupGuid} Returns monitor check data for a specific monitor group.
MonitorCheckApi MonitorCheckGetMultistepDetails Get /MonitorCheck/{monitorCheckId}/MultiStepAPI Returns Multi-Step API details for a monitor check.
MonitorCheckApi MonitorCheckGetScreenshots Get /MonitorCheck/{monitorCheckId}/Screenshot/{screenshotId} Gets a specific screenshot for a specified monitor check
MonitorCheckApi MonitorCheckGetSingleMonitorCheck Get /MonitorCheck/{monitorCheckId} Returns a single monitor check.
MonitorCheckApi MonitorCheckGetTransactionDetails Get /MonitorCheck/{monitorCheckId}/Transaction Returns transaction step details for a monitor check.
MonitorCheckApi MonitorCheckGetWaterfallInfo Get /MonitorCheck/{monitorCheckId}/Waterfall Returns waterfall information for a monitor check.
MonitorGroupApi MonitorGroupAddMaintenancePeriodToAllMembers Post /MonitorGroup/{monitorGroupGuid}/AddMaintenancePeriodToAllMembers Adds the provided maintenance period to all monitors in the group specified
MonitorGroupApi MonitorGroupAddMonitorToMonitorGroup Post /MonitorGroup/{monitorGroupGuid}/Members/{monitorGuid} Adds the specified monitor to the monitor group
MonitorGroupApi MonitorGroupCreateMonitorGroup Post /MonitorGroup Creates a new monitor group
MonitorGroupApi MonitorGroupDeleteMonitorGroup Delete /MonitorGroup/{monitorGroupGuid} Deletes the specified monitor group
MonitorGroupApi MonitorGroupGetAllMonitorGroups Get /MonitorGroup Gets all monitor groups
MonitorGroupApi MonitorGroupGetMonitorGroup Get /MonitorGroup/{monitorGroupGuid} Gets the details of a monitor group
MonitorGroupApi MonitorGroupGetMonitorGroupMembers Get /MonitorGroup/{monitorGroupGuid}/Members Gets a list of all members of a monitor group
MonitorGroupApi MonitorGroupRemoveMonitorFromMonitorGroup Delete /MonitorGroup/{monitorGroupGuid}/Members/{monitorGuid} Removes the specified monitor from the monitor group
MonitorGroupApi MonitorGroupStartAllMonitorAlertsInGroup Post /MonitorGroup/{monitorGroupGuid}/StartAllMonitorAlerts Starts alerting for all monitors that are a member of the monitor group specified by the monitor group GUID
MonitorGroupApi MonitorGroupStartAllMonitorsInGroup Post /MonitorGroup/{monitorGroupGuid}/StartAllMonitors Starts all monitors that are a member of the monitor group specified by the monitor group GUID
MonitorGroupApi MonitorGroupStopAllMonitorAlertsInGroup Post /MonitorGroup/{monitorGroupGuid}/StopAllMonitorAlerts Stops alerting for all monitors that are a member of the monitor group specified by the monitor group GUID
MonitorGroupApi MonitorGroupStopAllMonitorsInGroup Post /MonitorGroup/{monitorGroupGuid}/StopAllMonitors Stops all monitors that are a member of the monitor group specified by the monitor group GUID
MonitorGroupApi MonitorGroupUpdateMonitorGroup Put /MonitorGroup/{monitorGroupGuid} Updates the monitor group with the Guid specified
OperatorApi OperatorAddDutyPeriodForOperator Post /Operator/{operatorGuid}/DutySchedule Adds a duty schedule to the specified operator.
OperatorApi OperatorCreateOperator Post /Operator Creates a new operator.
OperatorApi OperatorDeleteAuthorizationForOperator Delete /Operator/{operatorGuid}/Authorization/{authorizationType} Removes the specified authorization of this operator.
OperatorApi OperatorDeleteDutyScheduleFromOperator Delete /Operator/{operatorGuid}/DutySchedule/{dutyScheduleId} Deletes the specified duty schedule of the specified operator.
OperatorApi OperatorDeleteOperator Delete /Operator/{operatorGuid} Deletes an existing operator.
OperatorApi OperatorGetAllOperators Get /Operator Gets a list of all operators.
OperatorApi OperatorGetAuthorizationsForOperator Get /Operator/{operatorGuid}/Authorization Gets all authorizations for the specified operator.
OperatorApi OperatorGetDutyScheduleForOperator Get /Operator/{operatorGuid}/DutySchedule Gets the duty schedules for an specified operator.
OperatorApi OperatorGetOperator Get /Operator/{operatorGuid} Gets the details of the operator with the provided OperatorGuid.
OperatorApi OperatorGetOperatorGroupsForOperator Get /Operator/{operatorGuid}/OperatorGroups Gets a list of all operator groups for the specified operator.
OperatorApi OperatorPostAuthorizationForOperator Post /Operator/{operatorGuid}/Authorization/{authorizationType} Assigns the specified authorization to this operator.
OperatorApi OperatorUpdateDutyPeriodForOperator Put /Operator/{operatorGuid}/DutySchedule/{dutyScheduleId} Updates the specified duty schedule of the specified operator.
OperatorApi OperatorUpdateOperator Put /Operator/{operatorGuid} Updates an existing operator.
OperatorApi OperatorUpdateOperatorWithPatch Patch /Operator/{operatorGuid} Updates an existing operator.
OperatorGroupApi OperatorGroupAddDutyScheduleToAllMembers Post /OperatorGroup/{operatorGroupGuid}/DutySchedule/AddDutyScheduleForAllMembers Adds the provided duty schedule to all operators in the group specified
OperatorGroupApi OperatorGroupAddOperatorToOperatorGroup Post /OperatorGroup/{operatorGroupGuid}/Member/{operatorGuid} Adds the specified operator to the operator group
OperatorGroupApi OperatorGroupAllOperatorsInGroupOffDuty Post /OperatorGroup/{operatorGroupGuid}/AllOperatorsOffDuty Set the OnDuty flag to off for all operators that are a member of the operator group specified by the operator group GUID
OperatorGroupApi OperatorGroupAllOperatorsInGroupOnDuty Post /OperatorGroup/{operatorGroupGuid}/AllOperatorsOnDuty Set the OnDuty flag to on for all operators that are a member of the operator group specified by the operator group GUID
OperatorGroupApi OperatorGroupCreateOperatorGroup Post /OperatorGroup Creates a new operator group
OperatorGroupApi OperatorGroupDeleteOperatorGroup Delete /OperatorGroup/{operatorGroupGuid} Deletes the specified operator group
OperatorGroupApi OperatorGroupGetAllOperatorGroups Get /OperatorGroup Gets all operator groups
OperatorGroupApi OperatorGroupGetOperatorGroup Get /OperatorGroup/{operatorGroupGuid} Gets the details of a operator group
OperatorGroupApi OperatorGroupGetOperatorGroupMembers Get /OperatorGroup/{operatorGroupGuid}/Member Gets a list of all members of an operator group
OperatorGroupApi OperatorGroupRemoveOperatorFromOperatorGroup Delete /OperatorGroup/{operatorGroupGuid}/Member/{operatorGuid} Removes the specified operator from the operator group
OperatorGroupApi OperatorGroupUpdateOperatorGroup Put /OperatorGroup/{operatorGroupGuid} Updates the operator group with the Guid specified
PublicStatusPageApi PublicStatusPageAddAuthorizationToPublicStatusPage Post /PublicStatusPage/{publicStatusPageGuid}/Authorization Creates a new authorization for the specified public status page.
PublicStatusPageApi PublicStatusPageDeletePublicStatusPage Delete /PublicStatusPage/{publicStatusPageGuid} Deletes the definition of the specified public status page.
PublicStatusPageApi PublicStatusPageGetAuthorizationsForPublicStatusPage Get /PublicStatusPage/{publicStatusPageGuid}/Authorization Returns all authorizations for the specified public status page.
PublicStatusPageApi PublicStatusPageGetPublicStatusPage Get /PublicStatusPage/{publicStatusPageGuid} Returns the definition of the specified public status page.
PublicStatusPageApi PublicStatusPageGetPublicStatusPages Get /PublicStatusPage Returns the definition of all public status pages available in the account.
PublicStatusPageApi PublicStatusPagePatchPublicStatusPage Patch /PublicStatusPage/{publicStatusPageGuid} Partially updates the definition of the specified public status page.
PublicStatusPageApi PublicStatusPagePostPublicStatusPage Post /PublicStatusPage Creates a new public status page.
PublicStatusPageApi PublicStatusPagePutPublicStatusPage Put /PublicStatusPage/{publicStatusPageGuid} Updates the definition of the specified public status page.
PublicStatusPageApi PublicStatusPageRemoveAuthorizationFromPublicStatusPage Delete /PublicStatusPage/{publicStatusPageGuid}/Authorization/{authorizationGuid} Removes an authorization from a public status page.
RegisterApi RegisterPost Post /Register Creates a new API account.
SLAApi SlaCreateSla Post /Sla Creates a new SLA.
SLAApi SlaDeleteExclusionPeriod Delete /Sla/{slaGuid}/ExclusionPeriod/{exclusionPeriodId} Deletes the specified exclusion period for the specified SLA.
SLAApi SlaDeleteSla Delete /Sla/{slaGuid} Deletes the specified SLA.
SLAApi SlaGetExclusionPeriod Get /Sla/{slaGuid}/ExclusionPeriod/{exclusionPeriodId} Gets the specified exclusion period for the specified SLA.
SLAApi SlaGetExclusionPeriods Get /Sla/{slaGuid}/ExclusionPeriod Gets a list of all exclusion periods for the specified SLA.
SLAApi SlaGetSla Get /Sla/{slaGuid} Gets the specified SLA definition.
SLAApi SlaGetSlas Get /Sla Gets a list of all SLA definitions.
SLAApi SlaPatchExclusionPeriod Patch /Sla/{slaGuid}/ExclusionPeriod/{exclusionPeriodId} Partially updates the specified exclusion period for the specified SLA.
SLAApi SlaPatchSla Patch /Sla/{slaGuid} Partially updates the definition of the specified SLA.
SLAApi SlaPostExclusionPeriod Post /Sla/{slaGuid}/ExclusionPeriod Creates a new exclusion period for the specified SLA.
SLAApi SlaPutExclusionPeriod Put /Sla/{slaGuid}/ExclusionPeriod/{exclusionPeriodId} Updates the specified exclusion period for the specified SLA.
SLAApi SlaPutSla Put /Sla/{slaGuid} Updates the definition of the specified SLA.
ScheduledReportApi ScheduledReportCreateScheduledReport Post /ScheduledReport Creates a new scheduled report.
ScheduledReportApi ScheduledReportDeleteSpecifiedScheduledReport Delete /ScheduledReport/{scheduledReportGuid} Delete the specified scheduled report.
ScheduledReportApi ScheduledReportGetAllScheduledReports Get /ScheduledReport Returns data for all scheduled reports.
ScheduledReportApi ScheduledReportGetSpecifiedScheduledReport Get /ScheduledReport/{scheduledReportGuid} Returns data for the specified scheduled report.
ScheduledReportApi ScheduledReportPartiallyUpdateScheduledReport Patch /ScheduledReport/{scheduledReportGuid} Partially update the specified scheduled report.
ScheduledReportApi ScheduledReportUpdateScheduledReport Put /ScheduledReport/{scheduledReportGuid} Update the specified scheduled report.
StatisticsApi StatisticsGetMonitorGroupStatistics Get /Statistics/MonitorGroup/{monitorGroupGuid} Gets the monitor group statistics.
StatisticsApi StatisticsGetMonitorStatistics Get /Statistics/Monitor/{monitorGuid} Gets the monitor statistics.
StatusApi StatusGetMonitorGroupStatus Get /Status/MonitorGroup/{monitorGroupGuid} Gets a list of all monitor group status data.
StatusApi StatusGetMonitorStatus Get /Status/Monitor/{monitorGuid} Gets all monitor status data.
VaultApi VaultCreateAuthorizationForVaultSection Post /VaultSection/{vaultSectionGuid}/Authorization Creates a new authorization for the specified vault section.
VaultApi VaultCreateNewVaultItem Post /VaultItem Creates a new vault item.
VaultApi VaultCreateNewVaultSection Post /VaultSection Creates a new vault section.
VaultApi VaultDeleteAuthorizationForVaultSection Delete /VaultSection/{vaultSectionGuid}/Authorization/{authorizationGuid} Deletes the specified authorization for the specified vault section.
VaultApi VaultDeleteVaultItem Delete /VaultItem/{vaultItemGuid} Deletes the specified vault item.
VaultApi VaultDeleteVaultSection Delete /VaultSection/{vaultSectionGuid} Deletes the specified vault section.
VaultApi VaultGetAllVaultItems Get /VaultItem Returns all vault items.
VaultApi VaultGetAllVaultSections Get /VaultSection Returns all vault sections.
VaultApi VaultGetAuthorizationsForVaultSection Get /VaultSection/{vaultSectionGuid}/Authorization Returns all authorizations for the specified vault section.
VaultApi VaultGetVaultItem Get /VaultItem/{vaultItemGuid} Returns the specified vault item.
VaultApi VaultGetVaultSection Get /VaultSection/{vaultSectionGuid} Returns the specified vault section.
VaultApi VaultUpdateVaultItem Put /VaultItem/{vaultItemGuid} Updates the specified vault item.
VaultApi VaultUpdateVaultSection Put /VaultSection/{vaultSectionGuid} Updates the specified vault section.

Documentation For Models

Documentation For Authorization

basicauth

  • Type: HTTP basic authentication

Example

auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
	UserName: "username",
	Password: "password",
})
r, err := client.Service.Operation(auth, args)

user-basicauth

  • Type: HTTP basic authentication

Example

auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
	UserName: "username",
	Password: "password",
})
r, err := client.Service.Operation(auth, args)

Author

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	// ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions

func CacheExpires

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types

type APIClient

type APIClient struct {
	AccountApi *AccountApiService

	AlertApi *AlertApiService

	AlertDefinitionApi *AlertDefinitionApiService

	CheckpointApi *CheckpointApiService

	DashboardApi *DashboardApiService

	IntegrationApi *IntegrationApiService

	MiscellaneousApi *MiscellaneousApiService

	MonitorApi *MonitorApiService

	MonitorCheckApi *MonitorCheckApiService

	MonitorGroupApi *MonitorGroupApiService

	OperatorApi *OperatorApiService

	OperatorGroupApi *OperatorGroupApiService

	PublicStatusPageApi *PublicStatusPageApiService

	RegisterApi *RegisterApiService

	SLAApi *SLAApiService

	ScheduledReportApi *ScheduledReportApiService

	StatisticsApi *StatisticsApiService

	StatusApi *StatusApiService

	VaultApi *VaultApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Uptrends API v4 API v1.0.0 In most cases there should be only one, shared, APIClient.

func NewAPIClient

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

type APIKey

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the swagger operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

func NewAPIResponse

func NewAPIResponse(r *http.Response) *APIResponse

func NewAPIResponseWithError

func NewAPIResponseWithError(errorMessage string) *APIResponse

type AccountApiService

type AccountApiService service

func (*AccountApiService) AccountGetAccountStatistics

func (a *AccountApiService) AccountGetAccountStatistics(ctx context.Context) (AccountStatistics, *http.Response, error)

AccountApiService Returns the account statistics.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return AccountStatistics

type AccountStatistics

type AccountStatistics struct {
	AccountId               string         `json:"AccountId,omitempty"`
	ExpirationDate          time.Time      `json:"ExpirationDate,omitempty"`
	MonitorQuota            *MonitorQuota  `json:"MonitorQuota,omitempty"`
	OperatorQuota           *OperatorQuota `json:"OperatorQuota,omitempty"`
	RemainingMessageCredits int32          `json:"RemainingMessageCredits,omitempty"`
}

type Alert

type Alert struct {
	Attributes    *AlertAttributes  `json:"Attributes,omitempty"`
	Id            string            `json:"Id"`
	Type_         string            `json:"Type,omitempty"`
	Relationships []RelationObject  `json:"Relationships,omitempty"`
	Links         map[string]string `json:"Links,omitempty"`
}

Represents the values/results of a single check done by a monitor

type AlertApiService

type AlertApiService service

func (*AlertApiService) AlertGetMonitorAlerts

func (a *AlertApiService) AlertGetMonitorAlerts(ctx context.Context, monitorGuid string, localVarOptionals *AlertGetMonitorAlertsOpts) (AlertResponse, *http.Response, error)

func (*AlertApiService) AlertGetMonitorGroupAlerts

func (a *AlertApiService) AlertGetMonitorGroupAlerts(ctx context.Context, monitorGroupGuid string, localVarOptionals *AlertGetMonitorGroupAlertsOpts) (AlertResponse, *http.Response, error)

type AlertAttributes

type AlertAttributes struct {
	// Alert type indicating if this was an Error or Ok alert.
	AlertType *interface{} `json:"AlertType"`
	// The monitor identifier.
	MonitorGuid string `json:"MonitorGuid"`
	// Date/time stamp of the alert.
	Timestamp time.Time `json:"Timestamp"`
	// Date/time stamp of the first monitor check.
	FirstError time.Time `json:"FirstError"`
	// The Id of the monitor check that triggered this alert.
	MonitorCheckId int64 `json:"MonitorCheckId"`
	// The Id of the first monitor check error that led to this alert.
	FirstErrorMonitorCheckId int64 `json:"FirstErrorMonitorCheckId"`
	// A text value that describes the error that was found, or OK if no error was found.
	ErrorDescription string `json:"ErrorDescription,omitempty"`
	// Any additional error information, if available.
	ErrorMessage string `json:"ErrorMessage,omitempty"`
	// The incident key of this alert.
	IncidentKey string `json:"IncidentKey,omitempty"`
}

Alert attributes

type AlertDefinition

type AlertDefinition struct {
	// The unique key of this Alert Definition.
	AlertDefinitionGuid string `json:"AlertDefinitionGuid,omitempty"`
	// Hash corresponding with this alert definition.
	Hash string `json:"Hash,omitempty"`
	// Name of this Alert Definition.
	AlertName string `json:"AlertName,omitempty"`
	// Indicates whether this Alert Definition is active.
	IsActive bool `json:"IsActive,omitempty"`
}

type AlertDefinitionApiService

type AlertDefinitionApiService service

func (*AlertDefinitionApiService) AlertDefinitionAddMonitorGroupToAlertDefinition

func (a *AlertDefinitionApiService) AlertDefinitionAddMonitorGroupToAlertDefinition(ctx context.Context, alertDefinitionGuid string, monitorGroupGuid string) (AlertDefinitionMonitorGroup, *http.Response, error)

AlertDefinitionApiService Adds a monitor group to the specified alert definition.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param alertDefinitionGuid The Guid of the alert definition to modify.
  • @param monitorGroupGuid The Guid of the monitor group to add.

@return AlertDefinitionMonitorGroup

func (*AlertDefinitionApiService) AlertDefinitionAddMonitorToAlertDefinition

func (a *AlertDefinitionApiService) AlertDefinitionAddMonitorToAlertDefinition(ctx context.Context, alertDefinitionGuid string, monitorGuid string) (AlertDefinitionMonitor, *http.Response, error)

AlertDefinitionApiService Adds a monitor to the specified alert definition.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param alertDefinitionGuid The Guid of the alert definition to modify.
  • @param monitorGuid The Guid of the monitor to add.

@return AlertDefinitionMonitor

func (*AlertDefinitionApiService) AlertDefinitionAddOperatorGroupToEscalationLevel

func (a *AlertDefinitionApiService) AlertDefinitionAddOperatorGroupToEscalationLevel(ctx context.Context, alertDefinitionGuid string, escalationLevelId int32, operatorGroupGuid string) (AlertDefinitionOperatorGroup, *http.Response, error)

AlertDefinitionApiService Adds an operator group to the specified escalation level.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param alertDefinitionGuid The Guid of the alert definition.
  • @param escalationLevelId The escalation level id.
  • @param operatorGroupGuid The Guid of the operator group to add.

@return AlertDefinitionOperatorGroup

func (*AlertDefinitionApiService) AlertDefinitionAddOperatorToEscalationLevel

func (a *AlertDefinitionApiService) AlertDefinitionAddOperatorToEscalationLevel(ctx context.Context, alertDefinitionGuid string, escalationLevelId int32, operatorGuid string) (AlertDefinitionOperator, *http.Response, error)

AlertDefinitionApiService Adds an operator to the specified escalation level.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param alertDefinitionGuid The Guid of the alert definition.
  • @param escalationLevelId The escalation level id.
  • @param operatorGuid The Guid of the operator to add.

@return AlertDefinitionOperator

func (*AlertDefinitionApiService) AlertDefinitionCreateAlertDefinition

func (a *AlertDefinitionApiService) AlertDefinitionCreateAlertDefinition(ctx context.Context, alertDefinition AlertDefinition) (AlertDefinition, *http.Response, error)

AlertDefinitionApiService Creates a new alert definition.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param alertDefinition The details of the alert definition to create.

@return AlertDefinition

func (*AlertDefinitionApiService) AlertDefinitionDeleteAlertDefinition

func (a *AlertDefinitionApiService) AlertDefinitionDeleteAlertDefinition(ctx context.Context, alertDefinitionGuid string) (*http.Response, error)

AlertDefinitionApiService Deletes an existing alert definition.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param alertDefinitionGuid The Guid of the alert definition to remove.

func (*AlertDefinitionApiService) AlertDefinitionGetAllAlertDefinitions

func (a *AlertDefinitionApiService) AlertDefinitionGetAllAlertDefinitions(ctx context.Context) ([]AlertDefinition, *http.Response, error)

AlertDefinitionApiService Gets a list of all alert definitions.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []AlertDefinition

func (*AlertDefinitionApiService) AlertDefinitionGetAllMembers

func (a *AlertDefinitionApiService) AlertDefinitionGetAllMembers(ctx context.Context, alertDefinitionGuid string) ([]AlertDefinitionMember, *http.Response, error)

AlertDefinitionApiService Gets a list of all monitor and monitor group guids of the specified alert definition.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param alertDefinitionGuid The Guid of the alert definition for which to return the members.

@return []AlertDefinitionMember

func (*AlertDefinitionApiService) AlertDefinitionGetEscalationLevel

func (a *AlertDefinitionApiService) AlertDefinitionGetEscalationLevel(ctx context.Context, alertDefinitionGuid string, escalationLevelId int32) ([]EscalationLevel, *http.Response, error)

AlertDefinitionApiService Gets the escalation level information of the specified alert definition.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param alertDefinitionGuid The Guid of the alert definition.
  • @param escalationLevelId The escalation level id.

@return []EscalationLevel

func (*AlertDefinitionApiService) AlertDefinitionGetEscalationLevelIntegration

func (a *AlertDefinitionApiService) AlertDefinitionGetEscalationLevelIntegration(ctx context.Context, alertDefinitionGuid string, escalationLevelId int32) ([]Integration, *http.Response, error)

AlertDefinitionApiService Gets the integrations for the specified escalation level.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param alertDefinitionGuid The Guid of the alert definition.
  • @param escalationLevelId The escalation level id.

@return []Integration

func (*AlertDefinitionApiService) AlertDefinitionGetEscalationLevelOperator

func (a *AlertDefinitionApiService) AlertDefinitionGetEscalationLevelOperator(ctx context.Context, alertDefinitionGuid string, escalationLevelId int32) ([]AlertEscalationLevelMember, *http.Response, error)

AlertDefinitionApiService Gets the operator and operator group guids for the specified escalation level.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param alertDefinitionGuid The Guid of the alert definition.
  • @param escalationLevelId The escalation level id.

@return []AlertEscalationLevelMember

func (*AlertDefinitionApiService) AlertDefinitionGetSpecifiedAlertDefinitions

func (a *AlertDefinitionApiService) AlertDefinitionGetSpecifiedAlertDefinitions(ctx context.Context, alertDefinitionGuid string) (AlertDefinition, *http.Response, error)

AlertDefinitionApiService Gets the specified alert definition.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param alertDefinitionGuid The Guid of the alert definition.

@return AlertDefinition

func (*AlertDefinitionApiService) AlertDefinitionPatchAlertDefinition

func (a *AlertDefinitionApiService) AlertDefinitionPatchAlertDefinition(ctx context.Context, alertDefinition AlertDefinition, alertDefinitionGuid string) (*http.Response, error)

AlertDefinitionApiService Partially updates the definition of the specified alert definition. This methods accepts parts of an alert definition. Fields that do not require changes can be omitted.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param alertDefinition The partial definition for the alert definition that should be updated.
  • @param alertDefinitionGuid The Guid of the alert definition that should be updated.

func (*AlertDefinitionApiService) AlertDefinitionPutAlertDefinition

func (a *AlertDefinitionApiService) AlertDefinitionPutAlertDefinition(ctx context.Context, alertDefinition AlertDefinition, alertDefinitionGuid string) (*http.Response, error)

AlertDefinitionApiService Updates the definition of the specified alert definition. This methods only accepts a complete alert definition where all fields are specified.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param alertDefinition The partial definition for the alert definition that should be updated.
  • @param alertDefinitionGuid The Guid of the alert definition that should be updated.

func (*AlertDefinitionApiService) AlertDefinitionRemoveMonitorFromAlertDefinition

func (a *AlertDefinitionApiService) AlertDefinitionRemoveMonitorFromAlertDefinition(ctx context.Context, alertDefinitionGuid string, monitorGuid string) (*http.Response, error)

AlertDefinitionApiService Removes a monitor for the specified alert definition.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param alertDefinitionGuid The Guid of the alert definition to modify.
  • @param monitorGuid The Guid of the monitor to remove.

func (*AlertDefinitionApiService) AlertDefinitionRemoveMonitorGroupFromAlertDefinition

func (a *AlertDefinitionApiService) AlertDefinitionRemoveMonitorGroupFromAlertDefinition(ctx context.Context, alertDefinitionGuid string, monitorGroupGuid string) (*http.Response, error)

AlertDefinitionApiService Removes a monitor group for the specified alert definition.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param alertDefinitionGuid The Guid of the alert definition to modify.
  • @param monitorGroupGuid The Guid of the monitor group to remove.

func (*AlertDefinitionApiService) AlertDefinitionRemoveOperatorFromEscalationLevel

func (a *AlertDefinitionApiService) AlertDefinitionRemoveOperatorFromEscalationLevel(ctx context.Context, alertDefinitionGuid string, escalationLevelId int32, operatorGuid string) (*http.Response, error)

AlertDefinitionApiService Removes an operator for the specified escalation level.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param alertDefinitionGuid The Guid of the alert definition.
  • @param escalationLevelId The escalation level id.
  • @param operatorGuid The Guid of the operator to remove.

func (*AlertDefinitionApiService) AlertDefinitionRemoveOperatorGroupFromEscalationLevel

func (a *AlertDefinitionApiService) AlertDefinitionRemoveOperatorGroupFromEscalationLevel(ctx context.Context, alertDefinitionGuid string, escalationLevelId int32, operatorGroupGuid string) (*http.Response, error)

AlertDefinitionApiService Removes an operator group for the specified escalation level.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param alertDefinitionGuid The Guid of the alert definition.
  • @param escalationLevelId The escalation level id.
  • @param operatorGroupGuid The Guid of the operator group to remove.

func (*AlertDefinitionApiService) AlertDefinitionUpdateIntegrationForEscalationWithPatch

func (a *AlertDefinitionApiService) AlertDefinitionUpdateIntegrationForEscalationWithPatch(ctx context.Context, escalationLevelIntegration EscalationLevelIntegration, alertDefinitionGuid string, escalationLevelId int32, integrationGuid string) (*http.Response, error)

AlertDefinitionApiService Partially updates an integration to the specified escalation level.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param escalationLevelIntegration The partial definition for the integration that should be updated.
  • @param alertDefinitionGuid The Guid of the alert definition.
  • @param escalationLevelId The escalation level id.
  • @param integrationGuid The Guid of the integration to update.

func (*AlertDefinitionApiService) AlertDefinitionUpdateIntegrationForEscalationWithPut

func (a *AlertDefinitionApiService) AlertDefinitionUpdateIntegrationForEscalationWithPut(ctx context.Context, escalationLevelIntegration EscalationLevelIntegration, alertDefinitionGuid string, escalationLevelId int32, integrationGuid string) (*http.Response, error)

AlertDefinitionApiService Updates an integration for the specified escalation level.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param escalationLevelIntegration The definition for the integration that should be updated.
  • @param alertDefinitionGuid The Guid of the alert definition.
  • @param escalationLevelId The escalation level id.
  • @param integrationGuid The Guid of the integration to update.

type AlertDefinitionMember

type AlertDefinitionMember struct {
	// Guid of Monitor in Alert Definition
	MonitorGuid string `json:"MonitorGuid,omitempty"`
	// Guid of GroupMonitor in Alert Definition
	MonitorGroupGuid string `json:"MonitorGroupGuid,omitempty"`
}

type AlertDefinitionMonitor

type AlertDefinitionMonitor struct {
	AlertDefinition string `json:"AlertDefinition"`
	Monitor         string `json:"Monitor"`
}

type AlertDefinitionMonitorGroup

type AlertDefinitionMonitorGroup struct {
	AlertDefinition string `json:"AlertDefinition"`
	MonitorGroup    string `json:"MonitorGroup"`
}

type AlertDefinitionOperator

type AlertDefinitionOperator struct {
	AlertDefinition string `json:"AlertDefinition"`
	Escalationlevel int32  `json:"Escalationlevel"`
	Operator        string `json:"Operator"`
}

type AlertDefinitionOperatorGroup

type AlertDefinitionOperatorGroup struct {
	AlertDefinition string `json:"AlertDefinition"`
	Escalationlevel int32  `json:"Escalationlevel"`
	OperatorGroup   string `json:"OperatorGroup"`
}

type AlertEscalationLevelMember

type AlertEscalationLevelMember struct {
	// Guid of Operator in Alert Definition Escalation Level
	OperatorGuid string `json:"OperatorGuid,omitempty"`
	// Guid of Group Operator in Alert Definition Escalation Level
	OperatorGroupGuid string `json:"OperatorGroupGuid,omitempty"`
}

type AlertGetMonitorAlertsOpts

type AlertGetMonitorAlertsOpts struct {
	IncludeReminders optional.Bool
	Cursor           optional.String
	Sorting          optional.String
	Take             optional.Int32
	Start            optional.Time
	End              optional.Time
	PresetPeriod     optional.String
}

type AlertGetMonitorGroupAlertsOpts

type AlertGetMonitorGroupAlertsOpts struct {
	IncludeReminders optional.Bool
	Cursor           optional.String
	Sorting          optional.String
	Take             optional.Int32
	Start            optional.Time
	End              optional.Time
	PresetPeriod     optional.String
}

type AlertResponse

type AlertResponse struct {
	Data          []Alert          `json:"Data,omitempty"`
	Links         *LinksData       `json:"Links,omitempty"`
	Relationships []RelationObject `json:"Relationships,omitempty"`
	Meta          *MetaData        `json:"Meta,omitempty"`
	// Cursors can be used to navigate the dataset in a fixed manner
	Cursors *interface{} `json:"Cursors,omitempty"`
}

type AlertType

type AlertType string

AlertType :

const (
	OK_AlertType       AlertType = "Ok"
	ERROR__AlertType   AlertType = "Error"
	REMINDER_AlertType AlertType = "Reminder"
)

List of AlertType

type ApiAssertion

type ApiAssertion struct {
	Source      *ApiSourceType     `json:"Source"`
	Property    string             `json:"Property,omitempty"`
	Comparison  *ApiComparisonType `json:"Comparison"`
	TargetValue string             `json:"TargetValue,omitempty"`
}

type ApiAuthenticationInfo

type ApiAuthenticationInfo struct {
	Id                 string                     `json:"Id"`
	AuthenticationType *ApiHttpAuthenticationType `json:"AuthenticationType"`
	UserName           string                     `json:"UserName,omitempty"`
	Password           string                     `json:"Password,omitempty"`
	PasswordSpecified  bool                       `json:"PasswordSpecified"`
}

type ApiComparisonType

type ApiComparisonType string

ApiComparisonType :

const (
	EQUAL_ApiComparisonType                 ApiComparisonType = "Equal"
	DOES_NOT_EQUAL_ApiComparisonType        ApiComparisonType = "DoesNotEqual"
	CONTAINS_TEXT_ApiComparisonType         ApiComparisonType = "ContainsText"
	DOES_NOT_CONTAIN_TEXT_ApiComparisonType ApiComparisonType = "DoesNotContainText"
	SHOULD_BE_IGNORED_ApiComparisonType     ApiComparisonType = "ShouldBeIgnored"
	LESS_THAN_ApiComparisonType             ApiComparisonType = "LessThan"
	GREATER_THAN_ApiComparisonType          ApiComparisonType = "GreaterThan"
	LESS_THAN_OR_EQUAL_ApiComparisonType    ApiComparisonType = "LessThanOrEqual"
	GREATER_THAN_OR_EQUAL_ApiComparisonType ApiComparisonType = "GreaterThanOrEqual"
	IS_NOT_EMPTY_ApiComparisonType          ApiComparisonType = "IsNotEmpty"
)

List of ApiComparisonType

type ApiHttpAuthenticationType

type ApiHttpAuthenticationType string

ApiHttpAuthenticationType :

const (
	NONE_ApiHttpAuthenticationType   ApiHttpAuthenticationType = "None"
	BASIC_ApiHttpAuthenticationType  ApiHttpAuthenticationType = "Basic"
	NTLM_ApiHttpAuthenticationType   ApiHttpAuthenticationType = "NTLM"
	DIGEST_ApiHttpAuthenticationType ApiHttpAuthenticationType = "Digest"
)

List of ApiHttpAuthenticationType

type ApiHttpHeaderValue

type ApiHttpHeaderValue struct {
	Key   string `json:"Key,omitempty"`
	Value string `json:"Value,omitempty"`
}

type ApiSourceType

type ApiSourceType string

ApiSourceType :

const (
	NONE_ApiSourceType                        ApiSourceType = "None"
	CONSTANT_ApiSourceType                    ApiSourceType = "Constant"
	VARIABLE_ApiSourceType                    ApiSourceType = "Variable"
	RESPONSE_STATUS_CODE_ApiSourceType        ApiSourceType = "ResponseStatusCode"
	RESPONSE_STATUS_DESCRIPTION_ApiSourceType ApiSourceType = "ResponseStatusDescription"
	RESPONSE_BODY_JSON_ApiSourceType          ApiSourceType = "ResponseBodyJson"
	RESPONSE_COMPLETED_ApiSourceType          ApiSourceType = "ResponseCompleted"
	RESPONSE_BODY_TEXT_ApiSourceType          ApiSourceType = "ResponseBodyText"
	FAIL_ApiSourceType                        ApiSourceType = "Fail"
	CONTENT_LENGTH_CALCULATED_ApiSourceType   ApiSourceType = "ContentLengthCalculated"
	DURATION_ApiSourceType                    ApiSourceType = "Duration"
	SUM_ApiSourceType                         ApiSourceType = "Sum"
	CONCATENATION_ApiSourceType               ApiSourceType = "Concatenation"
	TO_BASE64_ApiSourceType                   ApiSourceType = "ToBase64"
	TO_SHA1_HEX_ApiSourceType                 ApiSourceType = "ToSHA1Hex"
	TO_MD5_HEX_ApiSourceType                  ApiSourceType = "ToMD5Hex"
	RESPONSE_BODY_XML_ApiSourceType           ApiSourceType = "ResponseBodyXml"
	RESPONSE_HEADER_ApiSourceType             ApiSourceType = "ResponseHeader"
	COOKIE_ApiSourceType                      ApiSourceType = "Cookie"
	VARIABLES_RESOLVED_ApiSourceType          ApiSourceType = "VariablesResolved"
	CUMULATIVE_DURATION_ApiSourceType         ApiSourceType = "CumulativeDuration"
	RESPONSE_HAS_EXCEPTION_ApiSourceType      ApiSourceType = "ResponseHasException"
)

List of ApiSourceType

type ApiVariableDefinition

type ApiVariableDefinition struct {
	Source    *ApiSourceType          `json:"Source"`
	Property  string                  `json:"Property,omitempty"`
	Name      string                  `json:"Name,omitempty"`
	Arguments []ApiVariableDefinition `json:"Arguments,omitempty"`
}

type AssertionInfo

type AssertionInfo struct {
	// Was the assertion completed?
	Completed bool `json:"Completed"`
	// Did the assertion pass?
	Passed bool `json:"Passed"`
	// Description
	Description string `json:"Description,omitempty"`
	// Discription of the exception trown if applicable
	ExceptionDescription string `json:"ExceptionDescription,omitempty"`
}

Information about a single assertion

type AssertionResultsInfo

type AssertionResultsInfo struct {
	TotalAssertions  int32           `json:"TotalAssertions"`
	PassedAssertions int32           `json:"PassedAssertions"`
	AssertionInfos   []AssertionInfo `json:"AssertionInfos,omitempty"`
}

type AuthorizationTypeWithoutContext

type AuthorizationTypeWithoutContext string

AuthorizationTypeWithoutContext :

const (
	ACCOUNT_ACCESS_AuthorizationTypeWithoutContext AuthorizationTypeWithoutContext = "AccountAccess"
)

List of AuthorizationTypeWithoutContext

type BasicAuth

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type BrowserType

type BrowserType string

BrowserType :

const (
	IE_BrowserType           BrowserType = "IE"
	FIREFOX_BrowserType      BrowserType = "Firefox"
	CHROME_BrowserType       BrowserType = "Chrome"
	SAFARI_BrowserType       BrowserType = "Safari"
	PHANTOM_JS_BrowserType   BrowserType = "PhantomJS"
	PHANTOM_JS20_BrowserType BrowserType = "PhantomJS20"
)

List of BrowserType

type BrowserWindowDimensions

type BrowserWindowDimensions struct {
	IsMobile     bool   `json:"IsMobile"`
	Width        int32  `json:"Width"`
	Height       int32  `json:"Height"`
	PixelRatio   int32  `json:"PixelRatio"`
	MobileDevice string `json:"MobileDevice,omitempty"`
}

type CapabilityFilter

type CapabilityFilter string

CapabilityFilter :

const (
	I_PV6_CapabilityFilter          CapabilityFilter = "IPv6"
	NATIVE_I_PV6_CapabilityFilter   CapabilityFilter = "NativeIPv6"
	PRIMARY_SERVER_CapabilityFilter CapabilityFilter = "PrimaryServer"
)

List of CapabilityFilter

type CertificateArchive

type CertificateArchive struct {
	// The issuer of this certificate
	Issuer string `json:"Issuer,omitempty"`
	// The start date of this certificate
	NotBefore time.Time `json:"NotBefore"`
	// The certificate expiry date
	NotAfter time.Time `json:"NotAfter"`
	// Used to specify a new or changed password. The value will be encrypted when stored, and will not be displayed when a CertificateArchive is retrieved.
	Password string `json:"Password,omitempty"`
	// Used to specify the certificate content as a base64 string. The value will be encrypted when stored, and will not be displayed when a CertificateArchive is retrieved.
	ArchiveData string `json:"ArchiveData,omitempty"`
}

type Checkpoint

type Checkpoint struct {
	// The Id of the checkpoint
	CheckpointId int32 `json:"CheckpointId"`
	// The name of the checkpoint
	CheckpointName string `json:"CheckpointName,omitempty"`
	// The location code of the checkpoint
	Code string `json:"Code,omitempty"`
	// The IPv4 addresses of the checkpoint
	Ipv4Addresses []string `json:"Ipv4Addresses,omitempty"`
	// The IPv6 addresses of the checkpoint
	Ipv6Addresses []Ipv6Address `json:"Ipv6Addresses,omitempty"`
}

Checkpoint

type CheckpointApiService

type CheckpointApiService service

func (*CheckpointApiService) CheckpointGetAllCheckpoints

func (a *CheckpointApiService) CheckpointGetAllCheckpoints(ctx context.Context) ([]Checkpoint, *http.Response, error)

CheckpointApiService Returns all the checkpoints.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []Checkpoint

func (*CheckpointApiService) CheckpointGetCheckpoint

func (a *CheckpointApiService) CheckpointGetCheckpoint(ctx context.Context, checkpointId int32) (Checkpoint, *http.Response, error)

CheckpointApiService Returns the specified checkpoint.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param checkpointId The Id of the requested checkpoint.

@return Checkpoint

func (*CheckpointApiService) CheckpointRegionGetAllCheckpointRegions

func (a *CheckpointApiService) CheckpointRegionGetAllCheckpointRegions(ctx context.Context) ([]CheckpointRegion, *http.Response, error)

CheckpointApiService Returns all the checkpoint regions.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []CheckpointRegion

func (*CheckpointApiService) CheckpointRegionGetCheckpointRegionCheckpoints

func (a *CheckpointApiService) CheckpointRegionGetCheckpointRegionCheckpoints(ctx context.Context, checkpointRegionId int32) ([]Checkpoint, *http.Response, error)

CheckpointApiService Returns the checkpoints for the specified checkpoint region.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param checkpointRegionId The id for the specified checkpoint region.

@return []Checkpoint

func (*CheckpointApiService) CheckpointRegionGetSpecifiedCheckpointRegion

func (a *CheckpointApiService) CheckpointRegionGetSpecifiedCheckpointRegion(ctx context.Context, checkpointRegionId int32) (CheckpointRegion, *http.Response, error)

CheckpointApiService Returns the specified checkpoint region.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param checkpointRegionId The id for the specified checkpoint region.

@return CheckpointRegion

func (*CheckpointApiService) CheckpointServerGetAllServerIpv4Addresses

func (a *CheckpointApiService) CheckpointServerGetAllServerIpv4Addresses(ctx context.Context) ([]string, *http.Response, error)

CheckpointApiService Anonymous call that returns all the IPv4 addresses of all the checkpoint servers.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []string

func (*CheckpointApiService) CheckpointServerGetAllServerIpv6Addresses

func (a *CheckpointApiService) CheckpointServerGetAllServerIpv6Addresses(ctx context.Context) ([]string, *http.Response, error)

CheckpointApiService Anonymous call that returns all the IPv6 addresses of all the checkpoint servers.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []string

func (*CheckpointApiService) CheckpointServerGetServer

func (a *CheckpointApiService) CheckpointServerGetServer(ctx context.Context, serverId int32) (CheckpointServer, *http.Response, error)

CheckpointApiService Returns the requested checkpoint server.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param serverId The Id of the requested server.

@return CheckpointServer

type CheckpointRegion

type CheckpointRegion struct {
	Id           int32   `json:"Id"`
	Name         string  `json:"Name,omitempty"`
	ChildRegions []int32 `json:"ChildRegions,omitempty"`
}

type CheckpointServer

type CheckpointServer struct {
	// The Id of the checkpoint server
	CheckpointServerId int32 `json:"CheckpointServerId"`
	// The IPv4 address of the checkpoint server
	Ipv4Address string `json:"Ipv4Address,omitempty"`
	// The IPv6 address of this checkpoint server
	Ipv6Address string `json:"Ipv6Address,omitempty"`
	// The list of capabilities of this checkpoint server
	Capabilities []CapabilityFilter `json:"Capabilities,omitempty"`
}

Checkpoint server

type Configuration

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	HTTPClient    *http.Client
}

func NewConfiguration

func NewConfiguration() *Configuration

func (*Configuration) AddDefaultHeader

func (c *Configuration) AddDefaultHeader(key string, value string)

type CursorsData

type CursorsData struct {
	// Cursor for next data set
	Next string `json:"Next,omitempty"`
	// Cursor for this data set (data might get updated, depending on your parameters)
	Self string `json:"Self,omitempty"`
}

Cursors can be used to navigate the dataset in a fixed manner

type CustomField

type CustomField struct {
	Name  string `json:"Name,omitempty"`
	Value string `json:"Value,omitempty"`
}

type CustomMetric

type CustomMetric struct {
	Name         string `json:"Name,omitempty"`
	VariableName string `json:"VariableName,omitempty"`
}

type CustomizationInfo

type CustomizationInfo struct {
	MainColor           string         `json:"MainColor,omitempty"`
	BackgroundColor     string         `json:"BackgroundColor,omitempty"`
	TextColor           string         `json:"TextColor,omitempty"`
	TitleText           string         `json:"TitleText,omitempty"`
	FooterText          string         `json:"FooterText,omitempty"`
	SortColumnsNewToOld bool           `json:"SortColumnsNewToOld"`
	SortRowsProperty    *SortOrderEnum `json:"SortRowsProperty"`
	CommentTitle        string         `json:"CommentTitle,omitempty"`
	CommentText         string         `json:"CommentText,omitempty"`
}

type Dashboard

type Dashboard struct {
	DashboardGuid   string           `json:"DashboardGuid,omitempty"`
	Name            string           `json:"Name,omitempty"`
	DashboardFilter *DashboardFilter `json:"DashboardFilter,omitempty"`
	AutoRefresh     bool             `json:"AutoRefresh,omitempty"`
}

type DashboardApiService

type DashboardApiService service

func (*DashboardApiService) DashboardCloneDashboard

func (a *DashboardApiService) DashboardCloneDashboard(ctx context.Context, dashboardGuid string) (Dashboard, *http.Response, error)

DashboardApiService Clone the specified dashboard.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param dashboardGuid The guid of the specified dashboard.

@return Dashboard

func (*DashboardApiService) DashboardDeleteDashboard

func (a *DashboardApiService) DashboardDeleteDashboard(ctx context.Context, dashboardGuid string) (*http.Response, error)

DashboardApiService Delete the specified dashboard.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param dashboardGuid The guid of the specified dashboard.

func (*DashboardApiService) DashboardGetAllDashboards

func (a *DashboardApiService) DashboardGetAllDashboards(ctx context.Context) ([]Dashboard, *http.Response, error)

DashboardApiService Returns data for all dashboards.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []Dashboard

func (*DashboardApiService) DashboardGetOneDashboard

func (a *DashboardApiService) DashboardGetOneDashboard(ctx context.Context, dashboardGuid string) (Dashboard, *http.Response, error)

DashboardApiService Returns data for the specified dashboard.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param dashboardGuid The guid of the specified dashboard.

@return Dashboard

func (*DashboardApiService) DashboardPartiallyUpdateDashboard

func (a *DashboardApiService) DashboardPartiallyUpdateDashboard(ctx context.Context, dashboardGuid string, dashboard Dashboard) (*http.Response, error)

DashboardApiService Partially update the specified dashboard.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param dashboardGuid The guid of the specified dashboard.
  • @param dashboard The details for the dashboard.

func (*DashboardApiService) DashboardUpdateDashboard

func (a *DashboardApiService) DashboardUpdateDashboard(ctx context.Context, dashboardGuid string, dashboard Dashboard) (*http.Response, error)

DashboardApiService Update the specified dashboard.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param dashboardGuid The guid of the specified dashboard.
  • @param dashboard The details for the dashboard.

type DashboardFilter

type DashboardFilter struct {
	SelectedPeriod *SelectedPeriod `json:"SelectedPeriod,omitempty"`
	Monitors       []string        `json:"Monitors,omitempty"`
	MonitorGroups  []string        `json:"MonitorGroups,omitempty"`
	Checkpoints    []int32         `json:"Checkpoints,omitempty"`
}

type DateTimePatternMatch

type DateTimePatternMatch struct {
	OffsetUTC     int32 `json:"OffsetUTC"`
	MaxDifference int32 `json:"MaxDifference"`
}

type DayOfWeek

type DayOfWeek string

DayOfWeek :

const (
	SUNDAY_DayOfWeek    DayOfWeek = "Sunday"
	MONDAY_DayOfWeek    DayOfWeek = "Monday"
	TUESDAY_DayOfWeek   DayOfWeek = "Tuesday"
	WEDNESDAY_DayOfWeek DayOfWeek = "Wednesday"
	THURSDAY_DayOfWeek  DayOfWeek = "Thursday"
	FRIDAY_DayOfWeek    DayOfWeek = "Friday"
	SATURDAY_DayOfWeek  DayOfWeek = "Saturday"
)

List of DayOfWeek

type DnsQuery

type DnsQuery string

DnsQuery :

const (
	A_RECORD_DnsQuery     DnsQuery = "ARecord"
	CNAME_RECORD_DnsQuery DnsQuery = "CnameRecord"
	MX_RECORD_DnsQuery    DnsQuery = "MxRecord"
	NS_RECORD_DnsQuery    DnsQuery = "NsRecord"
	TXT_RECORD_DnsQuery   DnsQuery = "TxtRecord"
	SOA_RECORD_DnsQuery   DnsQuery = "SoaRecord"
	ROOT_SERVER_DnsQuery  DnsQuery = "RootServer"
	AAAA_RECORD_DnsQuery  DnsQuery = "AaaaRecord"
	SRV_RECORD_DnsQuery   DnsQuery = "SrvRecord"
)

List of DnsQuery

type ErrorLevel

type ErrorLevel string

ErrorLevel :

const (
	NO_ERROR_ErrorLevel    ErrorLevel = "NoError"
	UNCONFIRMED_ErrorLevel ErrorLevel = "Unconfirmed"
	CONFIRMED_ErrorLevel   ErrorLevel = "Confirmed"
)

List of ErrorLevel

type ErrorLevelFilter

type ErrorLevelFilter string

ErrorLevelFilter :

const (
	NO_ERROR_ErrorLevelFilter    ErrorLevelFilter = "NoError"
	UNCONFIRMED_ErrorLevelFilter ErrorLevelFilter = "Unconfirmed"
	CONFIRMED_ErrorLevelFilter   ErrorLevelFilter = "Confirmed"
)

List of ErrorLevelFilter

type EscalationLevel

type EscalationLevel struct {
	EscalationMode      *EscalationMode `json:"EscalationMode"`
	ThresholdErrorCount int32           `json:"ThresholdErrorCount"`
	ThresholdMinutes    int32           `json:"ThresholdMinutes"`
	IsActive            bool            `json:"IsActive"`
	Message             string          `json:"Message,omitempty"`
	NumberOfReminders   int32           `json:"NumberOfReminders"`
	ReminderDelay       int32           `json:"ReminderDelay"`
	IncludeTraceRoute   bool            `json:"IncludeTraceRoute,omitempty"`
}

type EscalationLevelIntegration

type EscalationLevelIntegration struct {
	// The unique key of this Integration.
	IntegrationGuid string `json:"IntegrationGuid,omitempty"`
	// Extra email addresses
	ExtraEmailAddresses []string `json:"ExtraEmailAddresses,omitempty"`
	// Specified Extra EmailAddresses For Patch request
	ExtraEmailAddressesSpecified bool `json:"ExtraEmailAddressesSpecified,omitempty"`
	// StatusHub Service Mapping
	StatusHubServiceList []IntegrationServiceMap `json:"StatusHubServiceList,omitempty"`
	// Specified StatusHubServiceList For Patch request
	StatusHubServiceListSpecified bool `json:"StatusHubServiceListSpecified,omitempty"`
	// Indicates whether this Integration is active.
	IsActive bool `json:"IsActive,omitempty"`
}

type EscalationMode

type EscalationMode string

EscalationMode :

const (
	ALERT_ON_ERROR_COUNT_EscalationMode    EscalationMode = "AlertOnErrorCount"
	ALERT_ON_ERROR_DURATION_EscalationMode EscalationMode = "AlertOnErrorDuration"
)

List of EscalationMode

type ExclusionPeriod

type ExclusionPeriod struct {
	ExclusionPeriodId int32     `json:"ExclusionPeriodId,omitempty"`
	Description       string    `json:"Description,omitempty"`
	From              time.Time `json:"From,omitempty"`
	Until             time.Time `json:"Until,omitempty"`
	Hash              string    `json:"Hash,omitempty"`
}

type FileInfo

type FileInfo struct {
	Data string `json:"Data,omitempty"`
	// Name of the uploaded file.
	Name string `json:"Name,omitempty"`
	// Size of the uploaded file.
	Size int32 `json:"Size"`
}

type GenericSwaggerError

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

GenericSwaggerError Provides access to the body, error and model on returned errors.

func (GenericSwaggerError) Body

func (e GenericSwaggerError) Body() []byte

Body returns the raw bytes of the response

func (GenericSwaggerError) Error

func (e GenericSwaggerError) Error() string

Error returns non-empty string if there was an error.

func (GenericSwaggerError) Model

func (e GenericSwaggerError) Model() interface{}

Model returns the unpacked model of the error

type HttpAttributes

type HttpAttributes struct {
	// The HTML code retrieved from the target
	ResponseBody string `json:"ResponseBody,omitempty"`
	// The HTTP response headers retrieved from the target
	ResponseHeaders string `json:"ResponseHeaders,omitempty"`
}

Http details attributes

type HttpCheckDetails

type HttpCheckDetails struct {
	Attributes    *HttpAttributes   `json:"Attributes,omitempty"`
	Id            int64             `json:"Id"`
	Type_         string            `json:"Type,omitempty"`
	Relationships []RelationObject  `json:"Relationships,omitempty"`
	Links         map[string]string `json:"Links,omitempty"`
}

type HttpDetailsResponse

type HttpDetailsResponse struct {
	Data          *HttpCheckDetails `json:"Data,omitempty"`
	Links         *LinksData        `json:"Links,omitempty"`
	Relationships []RelationObject  `json:"Relationships,omitempty"`
	Meta          *MetaData         `json:"Meta,omitempty"`
}

type HttpEngineAttributes

type HttpEngineAttributes struct {
	// The results of the steps
	StepResults []HttpEngineStep `json:"StepResults,omitempty"`
	// Timing info
	TimingInfo *interface{} `json:"TimingInfo,omitempty"`
	// Number of total steps
	TotalSteps int32 `json:"TotalSteps"`
	// Number of passed/succeed tests
	PassedSteps int32 `json:"PassedSteps"`
}

HttpEngineAttributes describes the attributes of a Multi-step Api monitor check

type HttpEngineCheckDetails

type HttpEngineCheckDetails struct {
	Attributes    *HttpEngineAttributes `json:"Attributes,omitempty"`
	Id            int64                 `json:"Id"`
	Type_         string                `json:"Type,omitempty"`
	Relationships []RelationObject      `json:"Relationships,omitempty"`
	Links         map[string]string     `json:"Links,omitempty"`
}

type HttpEngineStep

type HttpEngineStep struct {
	// The name of the step
	StepName string `json:"StepName,omitempty"`
	// Url the step was executed on
	Url string `json:"Url,omitempty"`
	// The HTTP status code returned
	HttpStatusCode string `json:"HttpStatusCode,omitempty"`
	// Http method used in this step
	HttpMethod string `json:"HttpMethod,omitempty"`
	// Step description
	HttpStatusDescription string `json:"HttpStatusDescription,omitempty"`
	// Did the response complete?
	ResponseCompleted bool `json:"ResponseCompleted"`
	// Was this step executed?
	StepExecuted bool `json:"StepExecuted"`
	// Results of the assertions in this step
	AssertionResultsInfo *interface{} `json:"AssertionResultsInfo,omitempty"`
	// Number of milliseconds it took for this step to succeed
	TotalTime int64 `json:"TotalTime"`
	// Response headers
	ResponseHeaders string `json:"ResponseHeaders,omitempty"`
	// Response body
	ResponseBody string `json:"ResponseBody,omitempty"`
	// Request headers send
	RequestHeaders string `json:"RequestHeaders,omitempty"`
	// Request body send
	RequestBody string `json:"RequestBody,omitempty"`
}

HttpEngineStep descriobes the results of a step in a Multi-step Api monitor

type HttpMethod

type HttpMethod string

HttpMethod :

const (
	GET_HttpMethod  HttpMethod = "Get"
	POST_HttpMethod HttpMethod = "Post"
)

List of HttpMethod

type Integration

type Integration struct {
	// Guid of Integration in Alert Definition Escalation Level
	IntegrationGuid string `json:"IntegrationGuid"`
	// Name of Integration in Alert Definition Escalation Level
	Name string `json:"Name,omitempty"`
	// Type of Integration in Alert Definition Escalation Level
	Type_ *interface{} `json:"Type"`
	// Extra emailadresses for this integration (if type == email)
	ExtraEmailAddresses string `json:"ExtraEmailAddresses,omitempty"`
	// All statushubs for this integration (if type == statushub)
	StatusHubServiceList []IntegrationServiceMap `json:"StatusHubServiceList,omitempty"`
	// All integrations services.
	IntegrationServices []string `json:"IntegrationServices,omitempty"`
}

type IntegrationApiService

type IntegrationApiService service

func (*IntegrationApiService) IntegrationGetAllIntegrations

func (a *IntegrationApiService) IntegrationGetAllIntegrations(ctx context.Context) ([]Integration, *http.Response, error)

IntegrationApiService Gets a list of all integrations.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []Integration

type IntegrationServiceMap

type IntegrationServiceMap struct {
	MonitorGuid            string `json:"MonitorGuid"`
	IntegrationServiceGuid string `json:"IntegrationServiceGuid"`
}

type IntegrationTypeEnum

type IntegrationTypeEnum string

IntegrationTypeEnum :

const (
	SLACK_IntegrationTypeEnum           IntegrationTypeEnum = "Slack"
	PAGER_DUTY_IntegrationTypeEnum      IntegrationTypeEnum = "PagerDuty"
	SMS_IntegrationTypeEnum             IntegrationTypeEnum = "Sms"
	EMAIL_IntegrationTypeEnum           IntegrationTypeEnum = "Email"
	PHONE_IntegrationTypeEnum           IntegrationTypeEnum = "Phone"
	STATUSHUB_IntegrationTypeEnum       IntegrationTypeEnum = "Statushub"
	GENERIC_WEBHOOK_IntegrationTypeEnum IntegrationTypeEnum = "GenericWebhook"
)

List of IntegrationTypeEnum

type IpVersion

type IpVersion string

IpVersion :

const (
	IP_V4_IpVersion IpVersion = "IpV4"
	IP_V6_IpVersion IpVersion = "IpV6"
)

List of IpVersion

type Ipv6Address

type Ipv6Address struct {
	// The IPv6 address
	IpAddress string `json:"IpAddress,omitempty"`
	// This indicates whether this is a native IPv6 address
	IsNative bool `json:"IsNative"`
}

Ipv6 address

type LastErrorLevel

type LastErrorLevel string

LastErrorLevel :

const (
	NO_ERROR_LastErrorLevel    LastErrorLevel = "NoError"
	UNCONFIRMED_LastErrorLevel LastErrorLevel = "Unconfirmed"
	CONFIRMED_LastErrorLevel   LastErrorLevel = "Confirmed"
	INACTIVE_LastErrorLevel    LastErrorLevel = "Inactive"
	MAINTENANCE_LastErrorLevel LastErrorLevel = "Maintenance"
)

List of LastErrorLevel

type LinksData

type LinksData struct {
	// Url for next data set
	Next string `json:"Next,omitempty"`
	// Url for this data set (data might get updated, depending on your parameters)
	Self string `json:"Self,omitempty"`
}

Links with reference to self and next data set

type MaintenancePeriod

type MaintenancePeriod struct {
	// The unique ID of this maintenance period
	Id int32 `json:"Id"`
	// The schedule mode (one time, daily, weekly, monthly)
	ScheduleMode *interface{} `json:"ScheduleMode"`
	// The start date/time for this schedule (for one-time schedules only)
	StartDateTime time.Time `json:"StartDateTime,omitempty"`
	// The end date/time for this maintenance period (for one-time maintenance periods only)
	EndDateTime time.Time `json:"EndDateTime,omitempty"`
	// The weekday for this maintenance period (for weekly maintenance periods only)
	WeekDay *interface{} `json:"WeekDay,omitempty"`
	// the month day for this maintenance period (for montly maintenance periods only)
	MonthDay int32 `json:"MonthDay,omitempty"`
	// The start time of this maintenance period
	StartTime string `json:"StartTime,omitempty"`
	// The end time of this maintenance period
	EndTime string `json:"EndTime,omitempty"`
	// Indicates whether, during the maintenance periods, only alerting will be disabled, or if the entire monitor will be stopped
	MaintenanceType *interface{} `json:"MaintenanceType"`
}

type MaintenanceTypes

type MaintenanceTypes string

MaintenanceTypes :

const (
	DISABLE_MONITORING_MaintenanceTypes    MaintenanceTypes = "DisableMonitoring"
	DISABLE_NOTIFICATIONS_MaintenanceTypes MaintenanceTypes = "DisableNotifications"
)

List of MaintenanceTypes

type MessageInfo

type MessageInfo struct {
	Message string `json:"Message,omitempty"`
}

type MessageList

type MessageList struct {
	Messages []MessageInfo `json:"Messages,omitempty"`
}

type MetaData

type MetaData struct {
	Timestamp time.Time       `json:"Timestamp,omitempty"`
	Period    *PeriodMetaData `json:"Period,omitempty"`
}

type MiscellaneousApiService

type MiscellaneousApiService service

func (*MiscellaneousApiService) MiscellaneousGetAllOutgoingPhoneNumbers

func (a *MiscellaneousApiService) MiscellaneousGetAllOutgoingPhoneNumbers(ctx context.Context) ([]OutgoingPhoneNumberDetails, *http.Response, error)

MiscellaneousApiService Gets a list of all outgoing phone numbers available.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []OutgoingPhoneNumberDetails

func (*MiscellaneousApiService) MiscellaneousGetAllTimezones

func (a *MiscellaneousApiService) MiscellaneousGetAllTimezones(ctx context.Context) ([]Timezone, *http.Response, error)

MiscellaneousApiService Gets all timezones available.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []Timezone

func (*MiscellaneousApiService) MiscellaneousGetTimezoneById

func (a *MiscellaneousApiService) MiscellaneousGetTimezoneById(ctx context.Context, timezoneId int32) (Timezone, *http.Response, error)

MiscellaneousApiService Gets the timezone with the specified Id.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param timezoneId

@return Timezone

type Monitor

type Monitor struct {
	// The unique key of this monitor.
	MonitorGuid string `json:"MonitorGuid,omitempty"`
	// The name of this monitor.
	Name        string       `json:"Name,omitempty"`
	MonitorType *MonitorType `json:"MonitorType,omitempty"`
	// Indicates whether this monitor should generate alerts.
	GenerateAlert bool `json:"GenerateAlert,omitempty"`
	// Indicates whether this monitor is actively running according to the monitoring interval.
	IsActive bool `json:"IsActive,omitempty"`
	// Indicates whether this monitor is locked.
	IsLocked                  bool                 `json:"IsLocked,omitempty"`
	CustomFields              []CustomField        `json:"CustomFields,omitempty"`
	SelectedCheckpoints       *SelectedCheckpoints `json:"SelectedCheckpoints,omitempty"`
	UsePrimaryCheckpointsOnly bool                 `json:"UsePrimaryCheckpointsOnly,omitempty"`
	// Indicates the interval in seconds
	CheckInterval int32        `json:"CheckInterval,omitempty"`
	MonitorMode   *MonitorMode `json:"MonitorMode,omitempty"`
	Notes         string       `json:"Notes,omitempty"`
	// Hash corresponding with this monitor.
	Hash                         string                     `json:"Hash,omitempty"`
	RequestHeaders               []RequestHeader            `json:"RequestHeaders,omitempty"`
	UserAgent                    string                     `json:"UserAgent,omitempty"`
	LoadTimeLimit1               int32                      `json:"LoadTimeLimit1,omitempty"`
	AlertOnLoadTimeLimit1        bool                       `json:"AlertOnLoadTimeLimit1,omitempty"`
	LoadTimeLimit2               int32                      `json:"LoadTimeLimit2,omitempty"`
	AlertOnLoadTimeLimit2        bool                       `json:"AlertOnLoadTimeLimit2,omitempty"`
	Username                     string                     `json:"Username,omitempty"`
	AuthenticationType           *ApiHttpAuthenticationType `json:"AuthenticationType,omitempty"`
	CheckCertificateErrors       bool                       `json:"CheckCertificateErrors,omitempty"`
	IpVersion                    *IpVersion                 `json:"IpVersion,omitempty"`
	NativeIPv6Only               bool                       `json:"NativeIPv6Only,omitempty"`
	AlertOnMinimumBytes          bool                       `json:"AlertOnMinimumBytes,omitempty"`
	MinimumBytes                 int32                      `json:"MinimumBytes,omitempty"`
	HttpMethod                   *HttpMethod                `json:"HttpMethod,omitempty"`
	TlsVersion                   *TlsVersion                `json:"TlsVersion,omitempty"`
	RequestBody                  string                     `json:"RequestBody,omitempty"`
	MatchPatterns                []PatternMatch             `json:"MatchPatterns,omitempty"`
	Url                          string                     `json:"Url,omitempty"`
	BlockUptrendsRum             bool                       `json:"BlockUptrendsRum,omitempty"`
	BlockGoogleAnalytics         bool                       `json:"BlockGoogleAnalytics,omitempty"`
	BlockUrls                    []string                   `json:"BlockUrls,omitempty"`
	AlertOnMaximumBytes          bool                       `json:"AlertOnMaximumBytes,omitempty"`
	MaximumBytes                 int32                      `json:"MaximumBytes,omitempty"`
	AlertOnMaximumSize           bool                       `json:"AlertOnMaximumSize,omitempty"`
	ElementMaximumSize           int32                      `json:"ElementMaximumSize,omitempty"`
	IgnoreExternalElements       bool                       `json:"IgnoreExternalElements,omitempty"`
	AlertOnPercentageFail        bool                       `json:"AlertOnPercentageFail,omitempty"`
	FailedObjectPercentage       int32                      `json:"FailedObjectPercentage,omitempty"`
	BrowserType                  *BrowserType               `json:"BrowserType,omitempty"`
	BrowserWindowDimensions      *BrowserWindowDimensions   `json:"BrowserWindowDimensions,omitempty"`
	Credits                      int32                      `json:"Credits,omitempty"`
	PredefinedVariables          []PredefinedVariable       `json:"PredefinedVariables,omitempty"`
	MsaSteps                     []MsaStep                  `json:"MsaSteps,omitempty"`
	CustomMetrics                []CustomMetric             `json:"CustomMetrics,omitempty"`
	SelfServiceTransactionScript string                     `json:"SelfServiceTransactionScript,omitempty"`
	Password                     string                     `json:"Password,omitempty"`
	ThrottlingOptions            *ThrottlingOptions         `json:"ThrottlingOptions,omitempty"`
	// Only valid for Transaction monitors: the data structure that specifies the transaction steps (and sub steps) to execute.
	TransactionStepDefinition           *interface{} `json:"TransactionStepDefinition,omitempty"`
	CertificateName                     string       `json:"CertificateName,omitempty"`
	CertificateOrganization             string       `json:"CertificateOrganization,omitempty"`
	CertificateOrganizationalUnit       string       `json:"CertificateOrganizationalUnit,omitempty"`
	CertificateSerialNumber             string       `json:"CertificateSerialNumber,omitempty"`
	CertificateFingerprint              string       `json:"CertificateFingerprint,omitempty"`
	CertificateIssuerName               string       `json:"CertificateIssuerName,omitempty"`
	CertificateIssuerCompanyName        string       `json:"CertificateIssuerCompanyName,omitempty"`
	CertificateIssuerOrganizationalUnit string       `json:"CertificateIssuerOrganizationalUnit,omitempty"`
	CertificateExpirationWarningDays    int32        `json:"CertificateExpirationWarningDays,omitempty"`
	DomainGroupGuid                     string       `json:"DomainGroupGuid,omitempty"`
	DomainGroupGuidSpecified            bool         `json:"DomainGroupGuidSpecified,omitempty"`
	DnsServer                           string       `json:"DnsServer,omitempty"`
	DnsQuery                            *DnsQuery    `json:"DnsQuery,omitempty"`
	DnsExpectedResult                   string       `json:"DnsExpectedResult,omitempty"`
	DnsTestValue                        string       `json:"DnsTestValue,omitempty"`
	Port                                int32        `json:"Port,omitempty"`
	DatabaseName                        string       `json:"DatabaseName,omitempty"`
	NetworkAddress                      string       `json:"NetworkAddress,omitempty"`
	ImapSecureConnection                bool         `json:"ImapSecureConnection,omitempty"`
	SftpAction                          *SftpAction  `json:"SftpAction,omitempty"`
	SftpActionPath                      string       `json:"SftpActionPath,omitempty"`
	ExpectedHttpStatusCode              int32        `json:"ExpectedHttpStatusCode,omitempty"`
	ExpectedHttpStatusCodeSpecified     bool         `json:"ExpectedHttpStatusCodeSpecified,omitempty"`
}

type MonitorApiService

type MonitorApiService service

func (*MonitorApiService) MonitorCleanupMaintenancePeriods

func (a *MonitorApiService) MonitorCleanupMaintenancePeriods(ctx context.Context, monitorGuid string, beforeDate time.Time) (*http.Response, error)

MonitorApiService Clears out all one-time maintenance periods for the specified monitor older than the specified date

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param monitorGuid
  • @param beforeDate A string representing the date, formatted as \"yyyy-MM-dd\"

func (*MonitorApiService) MonitorCloneMonitor

func (a *MonitorApiService) MonitorCloneMonitor(ctx context.Context, monitorGuid string, localVarOptionals *MonitorCloneMonitorOpts) (Monitor, *http.Response, error)

func (*MonitorApiService) MonitorCreateMaintenancePeriodForMonitor

func (a *MonitorApiService) MonitorCreateMaintenancePeriodForMonitor(ctx context.Context, maintenancePeriod MaintenancePeriod, monitorGuid string) (MaintenancePeriod, *http.Response, error)

MonitorApiService Saves the new maintenance period provided for the specified monitor

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param maintenancePeriod
  • @param monitorGuid

@return MaintenancePeriod

func (*MonitorApiService) MonitorDeleteMaintenancePeriodFromMonitor

func (a *MonitorApiService) MonitorDeleteMaintenancePeriodFromMonitor(ctx context.Context, monitorGuid string, maintenancePeriodId int32) (*http.Response, error)

MonitorApiService Deletes the specified maintenance period from the specified monitor

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param monitorGuid
  • @param maintenancePeriodId

func (*MonitorApiService) MonitorDeleteMonitor

func (a *MonitorApiService) MonitorDeleteMonitor(ctx context.Context, monitorGuid string) (*http.Response, error)

MonitorApiService Deletes the specified monitor.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param monitorGuid The guid of the monitor you want to delete.

func (*MonitorApiService) MonitorGetAllMaintenancePeriodsForMonitor

func (a *MonitorApiService) MonitorGetAllMaintenancePeriodsForMonitor(ctx context.Context, monitorGuid string) ([]MaintenancePeriod, *http.Response, error)

MonitorApiService Finds all maintenance periods for a monitor.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param monitorGuid The guid of the monitor you want to find the maintenance periods of.

@return []MaintenancePeriod

func (*MonitorApiService) MonitorGetMonitor

func (a *MonitorApiService) MonitorGetMonitor(ctx context.Context, monitorGuid string, localVarOptionals *MonitorGetMonitorOpts) (Monitor, *http.Response, error)

func (*MonitorApiService) MonitorGetMonitors

func (a *MonitorApiService) MonitorGetMonitors(ctx context.Context, localVarOptionals *MonitorGetMonitorsOpts) ([]Monitor, *http.Response, error)

func (*MonitorApiService) MonitorPatchMonitor

func (a *MonitorApiService) MonitorPatchMonitor(ctx context.Context, monitor Monitor, monitorGuid string) (*http.Response, error)

MonitorApiService Partially updates the definition of the specified monitor. This methods accepts parts of a monitor definition. We recommend retrieving the existing definition first (using the GET method). You can then process the changes you want to make and send back these changes only using this PATCH method.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param monitor The partial definition for the monitor that should be updated.
  • @param monitorGuid The Guid of the monitor that should be updated.

func (*MonitorApiService) MonitorPostMonitor

func (a *MonitorApiService) MonitorPostMonitor(ctx context.Context, monitor Monitor) (Monitor, *http.Response, error)

MonitorApiService Creates a new monitor.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param monitor The complete definition of the monitor that should be created.

@return Monitor

func (*MonitorApiService) MonitorPutMonitor

func (a *MonitorApiService) MonitorPutMonitor(ctx context.Context, monitor Monitor, monitorGuid string) (*http.Response, error)

MonitorApiService Updates the definition of the specified monitor. This methods only accepts a complete monitor definition. We recommend retrieving the existing definition first (using the GET method). You can then process the changes you want to make and send back the updated definition using this PUT method.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param monitor The complete definition for the monitor that should be updated.
  • @param monitorGuid The Guid of the monitor that should be updated.

func (*MonitorApiService) MonitorUpdateMaintenancePeriodForMonitor

func (a *MonitorApiService) MonitorUpdateMaintenancePeriodForMonitor(ctx context.Context, monitorGuid string, maintenancePeriodId int32, maintenancePeriod MaintenancePeriod) (*http.Response, error)

MonitorApiService Updates the specified maintenance schedule for the specified monitor

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param monitorGuid
  • @param maintenancePeriodId
  • @param maintenancePeriod

type MonitorCheck

type MonitorCheck struct {
	Attributes    *MonitorCheckAttributes `json:"Attributes,omitempty"`
	Id            int64                   `json:"Id"`
	Type_         string                  `json:"Type,omitempty"`
	Relationships []RelationObject        `json:"Relationships,omitempty"`
	Links         map[string]string       `json:"Links,omitempty"`
}

Represents the values/results of a single check done by a monitor

type MonitorCheckApiService

type MonitorCheckApiService service

func (*MonitorCheckApiService) MonitorCheckGetAccountMonitorChecks

func (a *MonitorCheckApiService) MonitorCheckGetAccountMonitorChecks(ctx context.Context, localVarOptionals *MonitorCheckGetAccountMonitorChecksOpts) (MonitorCheckResponse, *http.Response, error)

func (*MonitorCheckApiService) MonitorCheckGetHttpDetails

func (a *MonitorCheckApiService) MonitorCheckGetHttpDetails(ctx context.Context, monitorCheckId int64) (HttpDetailsResponse, *http.Response, error)

MonitorCheckApiService Returns HTTP details for a monitor check.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param monitorCheckId The monitor check Id to get the detailed data for.

@return HttpDetailsResponse

func (*MonitorCheckApiService) MonitorCheckGetMonitorCheck

func (a *MonitorCheckApiService) MonitorCheckGetMonitorCheck(ctx context.Context, monitorGuid string, localVarOptionals *MonitorCheckGetMonitorCheckOpts) (MonitorCheckResponse, *http.Response, error)

func (*MonitorCheckApiService) MonitorCheckGetMonitorGroupData

func (a *MonitorCheckApiService) MonitorCheckGetMonitorGroupData(ctx context.Context, monitorGroupGuid string, localVarOptionals *MonitorCheckGetMonitorGroupDataOpts) (MonitorCheckResponse, *http.Response, error)

func (*MonitorCheckApiService) MonitorCheckGetMultistepDetails

func (a *MonitorCheckApiService) MonitorCheckGetMultistepDetails(ctx context.Context, monitorCheckId int64) (MsaDetailsResponse, *http.Response, error)

MonitorCheckApiService Returns Multi-Step API details for a monitor check.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param monitorCheckId The monitor check Id to get the detailed data for.

@return MsaDetailsResponse

func (*MonitorCheckApiService) MonitorCheckGetScreenshots

func (a *MonitorCheckApiService) MonitorCheckGetScreenshots(ctx context.Context, monitorCheckId int64, screenshotId string) (ScreenshotResponse, *http.Response, error)

MonitorCheckApiService Gets a specific screenshot for a specified monitor check

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param monitorCheckId The monitor check Id to get the screenshot data for.
  • @param screenshotId The screenshot Id of the screenshot to get.

@return ScreenshotResponse

func (*MonitorCheckApiService) MonitorCheckGetSingleMonitorCheck

func (a *MonitorCheckApiService) MonitorCheckGetSingleMonitorCheck(ctx context.Context, monitorCheckId int64) (SingleMonitorCheckResponse, *http.Response, error)

MonitorCheckApiService Returns a single monitor check.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param monitorCheckId The Id of the monitor check to get the data for.

@return SingleMonitorCheckResponse

func (*MonitorCheckApiService) MonitorCheckGetTransactionDetails

func (a *MonitorCheckApiService) MonitorCheckGetTransactionDetails(ctx context.Context, monitorCheckId int64) (TransactionDetailsResponse, *http.Response, error)

MonitorCheckApiService Returns transaction step details for a monitor check.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param monitorCheckId The monitor check Id to get the detailed data for.

@return TransactionDetailsResponse

func (*MonitorCheckApiService) MonitorCheckGetWaterfallInfo

func (a *MonitorCheckApiService) MonitorCheckGetWaterfallInfo(ctx context.Context, monitorCheckId int64, localVarOptionals *MonitorCheckGetWaterfallInfoOpts) (WaterfallResponse, *http.Response, error)

type MonitorCheckAttributes

type MonitorCheckAttributes struct {
	// Monitor identifier
	MonitorGuid string `json:"MonitorGuid"`
	// Date/time stamp of the check
	Timestamp time.Time `json:"Timestamp"`
	// The numeric Uptrends error code in case of an error result, or 0 in case of an OK result.
	ErrorCode int32 `json:"ErrorCode"`
	// The number of milliseconds needed to complete the monitor check.
	TotalTime float64 `json:"TotalTime"`
	// The number of milliseconds needed to perform the DNS query for this check, when appropriate.
	ResolveTime float64 `json:"ResolveTime"`
	// The number of milliseconds needed to establish a connection.
	ConnectionTime float64 `json:"ConnectionTime"`
	// The number of milliseconds needed to download the response data.
	DownloadTime float64 `json:"DownloadTime"`
	// The number of downloaded bytes for this check.
	TotalBytes int32 `json:"TotalBytes,omitempty"`
	// The IP address that was found for the specified domain name as part of this monitor check.
	ResolvedIpAddress string `json:"ResolvedIpAddress,omitempty"`
	// A value that represents the OK/Error state for this check: NoError if the result was OK, Unconfirmed if an error was found, Confirmed if an error was found as a double check, right after an Unconfirmed error.
	ErrorLevel *interface{} `json:"ErrorLevel"`
	// A text value that describes the error that was found, or OK if no error was found.
	ErrorDescription string `json:"ErrorDescription,omitempty"`
	// Any additional error information, if available.
	ErrorMessage string `json:"ErrorMessage,omitempty"`
	// Did the check come from a staging monitor?
	StagingMode bool `json:"StagingMode"`
	// The Id of the Uptrends checkpoint server that performed this check.
	ServerId int32 `json:"ServerId"`
	// The HTTP status code returned (if applicable)
	HttpStatusCode int32 `json:"HttpStatusCode,omitempty"`
}

Monitor check attributes

type MonitorCheckGetAccountMonitorChecksOpts

type MonitorCheckGetAccountMonitorChecksOpts struct {
	ErrorLevel   optional.String
	Cursor       optional.String
	Sorting      optional.String
	Take         optional.Int32
	Start        optional.Time
	End          optional.Time
	PresetPeriod optional.String
}

type MonitorCheckGetMonitorCheckOpts

type MonitorCheckGetMonitorCheckOpts struct {
	ErrorLevel   optional.String
	Cursor       optional.String
	Sorting      optional.String
	Take         optional.Int32
	Start        optional.Time
	End          optional.Time
	PresetPeriod optional.String
}

type MonitorCheckGetMonitorGroupDataOpts

type MonitorCheckGetMonitorGroupDataOpts struct {
	ErrorLevel   optional.String
	Cursor       optional.String
	Sorting      optional.String
	Take         optional.Int32
	Start        optional.Time
	End          optional.Time
	PresetPeriod optional.String
}

type MonitorCheckGetWaterfallInfoOpts

type MonitorCheckGetWaterfallInfoOpts struct {
	Step optional.Int32
}

type MonitorCheckResponse

type MonitorCheckResponse struct {
	Data          []MonitorCheck   `json:"Data,omitempty"`
	Links         *LinksData       `json:"Links,omitempty"`
	Relationships []RelationObject `json:"Relationships,omitempty"`
	Meta          *MetaData        `json:"Meta,omitempty"`
	// Cursors can be used to navigate the dataset in a fixed manner
	Cursors *interface{} `json:"Cursors,omitempty"`
}

Response of the MonitorCheck endpoint

type MonitorCloneMonitorOpts

type MonitorCloneMonitorOpts struct {
	IncludeMaintenancePeriods optional.Bool
	IncludeMonitorGroups      optional.Bool
}

type MonitorGetMonitorOpts

type MonitorGetMonitorOpts struct {
	Filter optional.String
}

type MonitorGetMonitorsOpts

type MonitorGetMonitorsOpts struct {
	Filter optional.String
}

type MonitorGroup

type MonitorGroup struct {
	// The unique identifier of this monitor group
	MonitorGroupGuid string `json:"MonitorGroupGuid"`
	// The descriptive name of this probe group
	Description string `json:"Description,omitempty"`
	// Indicates whether this is the default group for all probes
	IsAll bool `json:"IsAll"`
}

type MonitorGroupApiService

type MonitorGroupApiService service

func (*MonitorGroupApiService) MonitorGroupAddMaintenancePeriodToAllMembers

func (a *MonitorGroupApiService) MonitorGroupAddMaintenancePeriodToAllMembers(ctx context.Context, monitorGroupGuid string, maintenancePeriod MaintenancePeriod) (*http.Response, error)

MonitorGroupApiService Adds the provided maintenance period to all monitors in the group specified

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param monitorGroupGuid
  • @param maintenancePeriod

func (*MonitorGroupApiService) MonitorGroupAddMonitorToMonitorGroup

func (a *MonitorGroupApiService) MonitorGroupAddMonitorToMonitorGroup(ctx context.Context, monitorGroupGuid string, monitorGuid string) (*http.Response, error)

MonitorGroupApiService Adds the specified monitor to the monitor group

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param monitorGroupGuid The Guid of the monitor group to add the monitor to
  • @param monitorGuid The monitor Guid

func (*MonitorGroupApiService) MonitorGroupCreateMonitorGroup

func (a *MonitorGroupApiService) MonitorGroupCreateMonitorGroup(ctx context.Context, monitorGroup MonitorGroup) (MonitorGroup, *http.Response, error)

MonitorGroupApiService Creates a new monitor group

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param monitorGroup The MonitorGroup object to be created

@return MonitorGroup

func (*MonitorGroupApiService) MonitorGroupDeleteMonitorGroup

func (a *MonitorGroupApiService) MonitorGroupDeleteMonitorGroup(ctx context.Context, monitorGroupGuid string) (*http.Response, error)

MonitorGroupApiService Deletes the specified monitor group

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param monitorGroupGuid The Guid of the monitor group to be deleted

func (*MonitorGroupApiService) MonitorGroupGetAllMonitorGroups

func (a *MonitorGroupApiService) MonitorGroupGetAllMonitorGroups(ctx context.Context) ([]MonitorGroup, *http.Response, error)

MonitorGroupApiService Gets all monitor groups

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []MonitorGroup

func (*MonitorGroupApiService) MonitorGroupGetMonitorGroup

func (a *MonitorGroupApiService) MonitorGroupGetMonitorGroup(ctx context.Context, monitorGroupGuid string) (MonitorGroup, *http.Response, error)

MonitorGroupApiService Gets the details of a monitor group

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param monitorGroupGuid The Guid of the monitor group to be retrieved

@return MonitorGroup

func (*MonitorGroupApiService) MonitorGroupGetMonitorGroupMembers

func (a *MonitorGroupApiService) MonitorGroupGetMonitorGroupMembers(ctx context.Context, monitorGroupGuid string) (MonitorGroupMember, *http.Response, error)

MonitorGroupApiService Gets a list of all members of a monitor group

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param monitorGroupGuid The Guid of the monitor group to retrieve the members for

@return MonitorGroupMember

func (*MonitorGroupApiService) MonitorGroupRemoveMonitorFromMonitorGroup

func (a *MonitorGroupApiService) MonitorGroupRemoveMonitorFromMonitorGroup(ctx context.Context, monitorGroupGuid string, monitorGuid string) (*http.Response, error)

MonitorGroupApiService Removes the specified monitor from the monitor group

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param monitorGroupGuid The Guid of the monitor group to remove the monitor from
  • @param monitorGuid The monitor Guid to be removed

func (*MonitorGroupApiService) MonitorGroupStartAllMonitorAlertsInGroup

func (a *MonitorGroupApiService) MonitorGroupStartAllMonitorAlertsInGroup(ctx context.Context, monitorGroupGuid string) (*http.Response, error)

MonitorGroupApiService Starts alerting for all monitors that are a member of the monitor group specified by the monitor group GUID

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param monitorGroupGuid The monitor group GUID

func (*MonitorGroupApiService) MonitorGroupStartAllMonitorsInGroup

func (a *MonitorGroupApiService) MonitorGroupStartAllMonitorsInGroup(ctx context.Context, monitorGroupGuid string) (*http.Response, error)

MonitorGroupApiService Starts all monitors that are a member of the monitor group specified by the monitor group GUID

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param monitorGroupGuid The monitor group GUID

func (*MonitorGroupApiService) MonitorGroupStopAllMonitorAlertsInGroup

func (a *MonitorGroupApiService) MonitorGroupStopAllMonitorAlertsInGroup(ctx context.Context, monitorGroupGuid string) (*http.Response, error)

MonitorGroupApiService Stops alerting for all monitors that are a member of the monitor group specified by the monitor group GUID

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param monitorGroupGuid The monitor group GUID

func (*MonitorGroupApiService) MonitorGroupStopAllMonitorsInGroup

func (a *MonitorGroupApiService) MonitorGroupStopAllMonitorsInGroup(ctx context.Context, monitorGroupGuid string) (*http.Response, error)

MonitorGroupApiService Stops all monitors that are a member of the monitor group specified by the monitor group GUID

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param monitorGroupGuid The monitor group GUID

func (*MonitorGroupApiService) MonitorGroupUpdateMonitorGroup

func (a *MonitorGroupApiService) MonitorGroupUpdateMonitorGroup(ctx context.Context, item MonitorGroup, monitorGroupGuid string) (*http.Response, error)

MonitorGroupApiService Updates the monitor group with the Guid specified

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param item The monitor group to be updated
  • @param monitorGroupGuid The Guid of the monitor group to be updated

type MonitorGroupMember

type MonitorGroupMember struct {
	// The unique identifier of this monitor
	MonitorGuid string `json:"MonitorGuid"`
}

type MonitorMode

type MonitorMode string

MonitorMode :

const (
	DEVELOPMENT_MonitorMode MonitorMode = "Development"
	STAGING_MonitorMode     MonitorMode = "Staging"
	PRODUCTION_MonitorMode  MonitorMode = "Production"
)

List of MonitorMode

type MonitorQuota

type MonitorQuota struct {
	BasicMonitors             int32 `json:"BasicMonitors,omitempty"`
	BasicMonitorsInUse        int32 `json:"BasicMonitorsInUse,omitempty"`
	BrowserMonitors           int32 `json:"BrowserMonitors,omitempty"`
	BrowserMonitorsInUse      int32 `json:"BrowserMonitorsInUse,omitempty"`
	ApiMonitoringCredits      int32 `json:"ApiMonitoringCredits,omitempty"`
	ApiMonitoringCreditsInUse int32 `json:"ApiMonitoringCreditsInUse,omitempty"`
	TransactionCredits        int32 `json:"TransactionCredits,omitempty"`
	TransactionCreditsInUse   int32 `json:"TransactionCreditsInUse,omitempty"`
	Monitors                  int32 `json:"Monitors,omitempty"`
	MonitorsInUse             int32 `json:"MonitorsInUse,omitempty"`
}

type MonitorStatus

type MonitorStatus struct {
	Attributes    *MonitorStatusAttributes `json:"Attributes,omitempty"`
	Id            string                   `json:"Id"`
	Type_         string                   `json:"Type,omitempty"`
	Relationships []RelationObject         `json:"Relationships,omitempty"`
	Links         map[string]string        `json:"Links,omitempty"`
}

type MonitorStatusAttributes

type MonitorStatusAttributes struct {
	// The error level for the monitor status
	ErrorLevel *interface{} `json:"ErrorLevel"`
	// Last checked timeStamp for this monitor
	LastCheck time.Time `json:"LastCheck,omitempty"`
	// Checkpoint id for the monitor status
	CheckpointId int32 `json:"CheckpointId"`
	// Error description for the monitor status
	ErrorDescription string `json:"ErrorDescription,omitempty"`
	// Uptime percentage for the monitor status
	UptimePercentage float64 `json:"UptimePercentage"`
	// Error code for the monitor status
	ErrorCode int32 `json:"ErrorCode"`
	// Last monitor check id
	LastMonitorCheckId int64 `json:"LastMonitorCheckId,omitempty"`
}

Monitor Status attributes

type MonitorStatusListResponse

type MonitorStatusListResponse struct {
	Data          []MonitorStatus  `json:"Data,omitempty"`
	Links         *LinksData       `json:"Links,omitempty"`
	Relationships []RelationObject `json:"Relationships,omitempty"`
	Meta          *MetaData        `json:"Meta,omitempty"`
}

type MonitorStatusResponse

type MonitorStatusResponse struct {
	Data          *MonitorStatus   `json:"Data,omitempty"`
	Links         *LinksData       `json:"Links,omitempty"`
	Relationships []RelationObject `json:"Relationships,omitempty"`
	Meta          *MetaData        `json:"Meta,omitempty"`
}

type MonitorType

type MonitorType string

MonitorType :

const (
	HTTP_MonitorType               MonitorType = "Http"
	HTTPS_MonitorType              MonitorType = "Https"
	CONNECT_MonitorType            MonitorType = "Connect"
	PING_MonitorType               MonitorType = "Ping"
	POP3_MonitorType               MonitorType = "POP3"
	SMTP_MonitorType               MonitorType = "SMTP"
	FTP_MonitorType                MonitorType = "FTP"
	MY_SQL_MonitorType             MonitorType = "MySQL"
	MSSQL_MonitorType              MonitorType = "MSSQL"
	WEBSERVICE_HTTP_MonitorType    MonitorType = "WebserviceHttp"
	WEBSERVICE_HTTPS_MonitorType   MonitorType = "WebserviceHttps"
	TRANSACTION_MonitorType        MonitorType = "Transaction"
	DNS_MonitorType                MonitorType = "DNS"
	FULL_PAGE_CHECK_MonitorType    MonitorType = "FullPageCheck"
	REAL_BROWSER_CHECK_MonitorType MonitorType = "RealBrowserCheck"
	CERTIFICATE_MonitorType        MonitorType = "Certificate"
	SFTP_MonitorType               MonitorType = "SFTP"
	MULTI_STEP_API_MonitorType     MonitorType = "MultiStepApi"
	IMAP_MonitorType               MonitorType = "IMAP"
)

List of MonitorType

type MsaDetailsResponse

type MsaDetailsResponse struct {
	Data          *HttpEngineCheckDetails `json:"Data,omitempty"`
	Links         *LinksData              `json:"Links,omitempty"`
	Relationships []RelationObject        `json:"Relationships,omitempty"`
	Meta          *MetaData               `json:"Meta,omitempty"`
}

type MsaStep

type MsaStep struct {
	Url                        string                  `json:"Url,omitempty"`
	Method                     string                  `json:"Method,omitempty"`
	Body                       string                  `json:"Body,omitempty"`
	RequestHeaders             []ApiHttpHeaderValue    `json:"RequestHeaders,omitempty"`
	Variables                  []ApiVariableDefinition `json:"Variables,omitempty"`
	Assertions                 []ApiAssertion          `json:"Assertions,omitempty"`
	Name                       string                  `json:"Name,omitempty"`
	Disabled                   bool                    `json:"Disabled"`
	UseFixedClientCertificate  bool                    `json:"UseFixedClientCertificate"`
	Authentication             *ApiAuthenticationInfo  `json:"Authentication,omitempty"`
	IgnoreCertificateErrors    bool                    `json:"IgnoreCertificateErrors"`
	ClientCertificateVaultItem string                  `json:"ClientCertificateVaultItem,omitempty"`
	Delay                      int32                   `json:"Delay"`
	StepType                   *MsaStepType            `json:"StepType"`
}

type MsaStepType

type MsaStepType string

MsaStepType :

const (
	HTTP_REQUEST_MsaStepType MsaStepType = "HttpRequest"
	DELAY_MsaStepType        MsaStepType = "Delay"
)

List of MsaStepType

type Operator

type Operator struct {
	// The unique identifier of this operator
	OperatorGuid string `json:"OperatorGuid,omitempty"`
	// The hash of this operator.
	Hash string `json:"Hash,omitempty"`
	// The password is a required field if AllowNativeLogin is set to True
	Password string `json:"Password,omitempty"`
	// The full name of this operator
	FullName string `json:"FullName,omitempty"`
	// The email address of this operator. This also serves as the username
	Email string `json:"Email,omitempty"`
	// The phone number of this operator to which SMS and phone alerts can be sent. Start with a plus (+) sign and your country code
	MobilePhone string `json:"MobilePhone,omitempty"`
	// The id of the phone number that will be used to send phone alerts (See /OutgoingPhoneNumber API under Miscellaneous for available ids)
	OutgoingPhoneNumberId          int32 `json:"OutgoingPhoneNumberId,omitempty"`
	OutgoingPhoneNumberIdSpecified bool  `json:"OutgoingPhoneNumberIdSpecified,omitempty"`
	// This indicates if the operator is the account administrator.
	IsAccountAdministrator bool `json:"IsAccountAdministrator,omitempty"`
	// The backup email address of this operator
	BackupEmail string `json:"BackupEmail,omitempty"`
	// Indicates whether the operator is currently active
	IsOnDuty bool `json:"IsOnDuty,omitempty"`
	// If ommitted the operator will use the account culture. If set it will override the account default
	CultureName          string `json:"CultureName,omitempty"`
	CultureNameSpecified bool   `json:"CultureNameSpecified,omitempty"`
	// The id of the timezone of this operator (See /Timezone API under Miscellaneous for available timezones)
	TimeZoneId          int32 `json:"TimeZoneId,omitempty"`
	TimeZoneIdSpecified bool  `json:"TimeZoneIdSpecified,omitempty"`
	// The SMS provider used to send out SMS alerts
	SmsProvider *interface{} `json:"SmsProvider,omitempty"`
	// Set to True to override the default behavior of sending SMS alerts with textual sender ID
	UseNumericSender          bool `json:"UseNumericSender,omitempty"`
	UseNumericSenderSpecified bool `json:"UseNumericSenderSpecified,omitempty"`
	// This can only be set to false if the account has SSO enabled. Ommitting or providing null will use the account default
	AllowNativeLogin          bool `json:"AllowNativeLogin,omitempty"`
	AllowNativeLoginSpecified bool `json:"AllowNativeLoginSpecified,omitempty"`
	// This can only be set to true if the account has SSO enabled. Ommitting or providing null will use the account default
	AllowSingleSignon          bool `json:"AllowSingleSignon,omitempty"`
	AllowSingleSignonSpecified bool `json:"AllowSingleSignonSpecified,omitempty"`
}

Operator

type OperatorApiService

type OperatorApiService service

func (*OperatorApiService) OperatorAddDutyPeriodForOperator

func (a *OperatorApiService) OperatorAddDutyPeriodForOperator(ctx context.Context, schedule OperatorDutySchedule, operatorGuid string) (*http.Response, error)

OperatorApiService Adds a duty schedule to the specified operator.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param schedule The duty schedule to add
  • @param operatorGuid The Guid of the operator to add the duty schedule to

func (*OperatorApiService) OperatorCreateOperator

func (a *OperatorApiService) OperatorCreateOperator(ctx context.Context, uptrendsOperator Operator) (Operator, *http.Response, error)

OperatorApiService Creates a new operator.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param uptrendsOperator The details of the operator to create

@return Operator

func (*OperatorApiService) OperatorDeleteAuthorizationForOperator

func (a *OperatorApiService) OperatorDeleteAuthorizationForOperator(ctx context.Context, operatorGuid string, authorizationType string) (*http.Response, error)

OperatorApiService Removes the specified authorization of this operator.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param operatorGuid The Guid of the operator
  • @param authorizationType The type of authorization

func (*OperatorApiService) OperatorDeleteDutyScheduleFromOperator

func (a *OperatorApiService) OperatorDeleteDutyScheduleFromOperator(ctx context.Context, operatorGuid string, dutyScheduleId int32) (*http.Response, error)

OperatorApiService Deletes the specified duty schedule of the specified operator.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param operatorGuid
  • @param dutyScheduleId

func (*OperatorApiService) OperatorDeleteOperator

func (a *OperatorApiService) OperatorDeleteOperator(ctx context.Context, operatorGuid string) (*http.Response, error)

OperatorApiService Deletes an existing operator.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param operatorGuid The Guid of the operator to delete

func (*OperatorApiService) OperatorGetAllOperators

func (a *OperatorApiService) OperatorGetAllOperators(ctx context.Context) ([]Operator, *http.Response, error)

OperatorApiService Gets a list of all operators.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []Operator

func (*OperatorApiService) OperatorGetAuthorizationsForOperator

func (a *OperatorApiService) OperatorGetAuthorizationsForOperator(ctx context.Context, operatorGuid string) ([]AuthorizationTypeWithoutContext, *http.Response, error)

OperatorApiService Gets all authorizations for the specified operator.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param operatorGuid The Guid of the operator

@return []AuthorizationTypeWithoutContext

func (*OperatorApiService) OperatorGetDutyScheduleForOperator

func (a *OperatorApiService) OperatorGetDutyScheduleForOperator(ctx context.Context, operatorGuid string) ([]OperatorDutySchedule, *http.Response, error)

OperatorApiService Gets the duty schedules for an specified operator.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param operatorGuid The Guid of the operator to get the duty schedule for

@return []OperatorDutySchedule

func (*OperatorApiService) OperatorGetOperator

func (a *OperatorApiService) OperatorGetOperator(ctx context.Context, operatorGuid string) (Operator, *http.Response, error)

OperatorApiService Gets the details of the operator with the provided OperatorGuid.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param operatorGuid The Guid of the operator for which to retrieve the details

@return Operator

func (*OperatorApiService) OperatorGetOperatorGroupsForOperator

func (a *OperatorApiService) OperatorGetOperatorGroupsForOperator(ctx context.Context, operatorGuid string) ([]OperatorMember, *http.Response, error)

OperatorApiService Gets a list of all operator groups for the specified operator.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param operatorGuid The Guid of the operator for which to retrieve the operator group guids

@return []OperatorMember

func (*OperatorApiService) OperatorPostAuthorizationForOperator

func (a *OperatorApiService) OperatorPostAuthorizationForOperator(ctx context.Context, operatorGuid string, authorizationType string) (*http.Response, error)

OperatorApiService Assigns the specified authorization to this operator.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param operatorGuid The Guid of the operator
  • @param authorizationType The type of authorization

func (*OperatorApiService) OperatorUpdateDutyPeriodForOperator

func (a *OperatorApiService) OperatorUpdateDutyPeriodForOperator(ctx context.Context, operatorGuid string, dutyScheduleId int32, schedule OperatorDutySchedule) (*http.Response, error)

OperatorApiService Updates the specified duty schedule of the specified operator.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param operatorGuid
  • @param dutyScheduleId
  • @param schedule

func (*OperatorApiService) OperatorUpdateOperator

func (a *OperatorApiService) OperatorUpdateOperator(ctx context.Context, uptrendsOperator Operator, operatorGuid string) (*http.Response, error)

OperatorApiService Updates an existing operator.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param uptrendsOperator The updated details of the operator
  • @param operatorGuid The Guid of the operator to update

func (*OperatorApiService) OperatorUpdateOperatorWithPatch

func (a *OperatorApiService) OperatorUpdateOperatorWithPatch(ctx context.Context, uptrendsOperator Operator, operatorGuid string) (*http.Response, error)

OperatorApiService Updates an existing operator.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param uptrendsOperator The updated details of the operator
  • @param operatorGuid The Guid of the operator to update

type OperatorDutySchedule

type OperatorDutySchedule struct {
	// The unique ID of this maintenance period
	Id int32 `json:"Id"`
	// The schedule mode (one time, daily, weekly, monthly)
	ScheduleMode *interface{} `json:"ScheduleMode"`
	// The start date/time for this schedule (for one-time schedules only)
	StartDateTime time.Time `json:"StartDateTime,omitempty"`
	// The end date/time for this maintenance period (for one-time maintenance periods only)
	EndDateTime time.Time `json:"EndDateTime,omitempty"`
	// The weekday for this maintenance period (for weekly maintenance periods only)
	WeekDay *interface{} `json:"WeekDay,omitempty"`
	// the month day for this maintenance period (for montly maintenance periods only)
	MonthDay int32 `json:"MonthDay,omitempty"`
	// The start time of this maintenance period
	StartTime string `json:"StartTime,omitempty"`
	// The end time of this maintenance period
	EndTime string `json:"EndTime,omitempty"`
}

type OperatorGroup

type OperatorGroup struct {
	// The unique identifier of this Operator group
	OperatorGroupGuid string `json:"OperatorGroupGuid"`
	// The descriptive name of this operator group
	Description string `json:"Description,omitempty"`
	// Indicates whether this is the default group for all operators
	IsEveryone            bool `json:"IsEveryone,omitempty"`
	IsAdministratorsGroup bool `json:"IsAdministratorsGroup,omitempty"`
}

type OperatorGroupApiService

type OperatorGroupApiService service

func (*OperatorGroupApiService) OperatorGroupAddDutyScheduleToAllMembers

func (a *OperatorGroupApiService) OperatorGroupAddDutyScheduleToAllMembers(ctx context.Context, operatorGroupGuid string, dutySchedule OperatorDutySchedule) (*http.Response, error)

OperatorGroupApiService Adds the provided duty schedule to all operators in the group specified

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param operatorGroupGuid
  • @param dutySchedule

func (*OperatorGroupApiService) OperatorGroupAddOperatorToOperatorGroup

func (a *OperatorGroupApiService) OperatorGroupAddOperatorToOperatorGroup(ctx context.Context, operatorGroupGuid string, operatorGuid string) (*http.Response, error)

OperatorGroupApiService Adds the specified operator to the operator group

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param operatorGroupGuid The Guid of the operator group to add the operator to
  • @param operatorGuid The operator Guid

func (*OperatorGroupApiService) OperatorGroupAllOperatorsInGroupOffDuty

func (a *OperatorGroupApiService) OperatorGroupAllOperatorsInGroupOffDuty(ctx context.Context, operatorGroupGuid string) (*http.Response, error)

OperatorGroupApiService Set the OnDuty flag to off for all operators that are a member of the operator group specified by the operator group GUID

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param operatorGroupGuid The operator group GUID

func (*OperatorGroupApiService) OperatorGroupAllOperatorsInGroupOnDuty

func (a *OperatorGroupApiService) OperatorGroupAllOperatorsInGroupOnDuty(ctx context.Context, operatorGroupGuid string) (*http.Response, error)

OperatorGroupApiService Set the OnDuty flag to on for all operators that are a member of the operator group specified by the operator group GUID

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param operatorGroupGuid The operator group GUID

func (*OperatorGroupApiService) OperatorGroupCreateOperatorGroup

func (a *OperatorGroupApiService) OperatorGroupCreateOperatorGroup(ctx context.Context, operatorGroup OperatorGroup) (OperatorGroup, *http.Response, error)

OperatorGroupApiService Creates a new operator group

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param operatorGroup The operatorGroup object to be created

@return OperatorGroup

func (*OperatorGroupApiService) OperatorGroupDeleteOperatorGroup

func (a *OperatorGroupApiService) OperatorGroupDeleteOperatorGroup(ctx context.Context, operatorGroupGuid string) (*http.Response, error)

OperatorGroupApiService Deletes the specified operator group

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param operatorGroupGuid The Guid of the operator group to be deleted

func (*OperatorGroupApiService) OperatorGroupGetAllOperatorGroups

func (a *OperatorGroupApiService) OperatorGroupGetAllOperatorGroups(ctx context.Context) ([]OperatorGroup, *http.Response, error)

OperatorGroupApiService Gets all operator groups

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []OperatorGroup

func (*OperatorGroupApiService) OperatorGroupGetOperatorGroup

func (a *OperatorGroupApiService) OperatorGroupGetOperatorGroup(ctx context.Context, operatorGroupGuid string) (OperatorGroup, *http.Response, error)

OperatorGroupApiService Gets the details of a operator group

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param operatorGroupGuid The Guid of the operator group to be retrieved

@return OperatorGroup

func (*OperatorGroupApiService) OperatorGroupGetOperatorGroupMembers

func (a *OperatorGroupApiService) OperatorGroupGetOperatorGroupMembers(ctx context.Context, operatorGroupGuid string) (OperatorGroupMember, *http.Response, error)

OperatorGroupApiService Gets a list of all members of an operator group

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param operatorGroupGuid The Guid of the operator group to retrieve the members for

@return OperatorGroupMember

func (*OperatorGroupApiService) OperatorGroupRemoveOperatorFromOperatorGroup

func (a *OperatorGroupApiService) OperatorGroupRemoveOperatorFromOperatorGroup(ctx context.Context, operatorGroupGuid string, operatorGuid string) (*http.Response, error)

OperatorGroupApiService Removes the specified operator from the operator group

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param operatorGroupGuid The Guid of the operator group to remove the operator from
  • @param operatorGuid The operator Guid to be removed

func (*OperatorGroupApiService) OperatorGroupUpdateOperatorGroup

func (a *OperatorGroupApiService) OperatorGroupUpdateOperatorGroup(ctx context.Context, item OperatorGroup, operatorGroupGuid string) (*http.Response, error)

OperatorGroupApiService Updates the operator group with the Guid specified

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param item The operator group to be updated
  • @param operatorGroupGuid The Guid of the operator group to be updated

type OperatorGroupMember

type OperatorGroupMember struct {
	// The unique identifier of this Operator
	OperatorGuid string `json:"OperatorGuid"`
}

type OperatorMember

type OperatorMember struct {
	// The unique identifier of this Operator
	OperatorGroupGuid string `json:"OperatorGroupGuid"`
}

type OperatorQuota

type OperatorQuota struct {
	Operators      int32 `json:"Operators,omitempty"`
	OperatorsInUse int32 `json:"OperatorsInUse,omitempty"`
}

type OperatorScheduleMode

type OperatorScheduleMode string

OperatorScheduleMode :

const (
	ONE_TIME_OperatorScheduleMode OperatorScheduleMode = "OneTime"
	DAILY_OperatorScheduleMode    OperatorScheduleMode = "Daily"
	WEEKLY_OperatorScheduleMode   OperatorScheduleMode = "Weekly"
	MONTHLY_OperatorScheduleMode  OperatorScheduleMode = "Monthly"
)

List of OperatorScheduleMode

type OutgoingPhoneNumberDetails

type OutgoingPhoneNumberDetails struct {
	Id          int32  `json:"Id"`
	PhoneNumber string `json:"PhoneNumber,omitempty"`
	Description string `json:"Description,omitempty"`
}

type PageElement

type PageElement struct {
	// Index of the element in the waterfall context
	Index int32 `json:"Index"`
	// Starting time in milliseconds
	StartTime int32 `json:"StartTime"`
	// Number of milliseconds needed to perform the DNS query for this element, when appropriate.
	ResolveTime int32 `json:"ResolveTime"`
	// Number of milliseconds needed to establish a connection.
	ConnectTime int32 `json:"ConnectTime"`
	// Number of milliseconds the connection was stale
	StaleTime int32 `json:"StaleTime"`
	// Number of milliseconds needed for the HTTPS handshake
	HttpsHandshakeTime int32 `json:"HttpsHandshakeTime"`
	// Number of milliseconds it took to send data
	SendTime int32 `json:"SendTime"`
	// Number of milliseconds the connection was in waiting state
	WaitTime int32 `json:"WaitTime"`
	// Number of milliseconds it took to retrieve the data
	ReceiveTime int32 `json:"ReceiveTime"`
	// Number of milliseconds the connection was timed-out
	TimeoutTime int32 `json:"TimeoutTime"`
	// Total number of milliseconds it took for the connection to complete
	TotalTime int32 `json:"TotalTime"`
	// The Http status code
	HttpStatusCode int32 `json:"HttpStatusCode"`
	// The requested resource url
	Url string `json:"Url,omitempty"`
	// Total number of downloaded bytes
	TotalBytes int32 `json:"TotalBytes"`
	// Requested resource element type, can be HTML, scripts, CSS, images, frames, objects, data and other
	ElementType string `json:"ElementType,omitempty"`
	// The HTTP request headers used
	RequestHeaders string `json:"RequestHeaders,omitempty"`
	// The HTTP response headers retrieved
	ResponseHeaders string `json:"ResponseHeaders,omitempty"`
	// The IP address that was found for the specified domain name as part of this monitor check.
	ResolvedIpAddress *interface{} `json:"ResolvedIpAddress,omitempty"`
	GroupIds          []int32      `json:"GroupIds,omitempty"`
	// Was the Url excluded from waterfall (timing) data by the user?
	UrlIsBlocked bool `json:"UrlIsBlocked"`
}

Page element describes a page load/request (in a waterfall)

type PatternMatch

type PatternMatch struct {
	Pattern    string                `json:"Pattern,omitempty"`
	IsPositive bool                  `json:"IsPositive"`
	DateTime   *DateTimePatternMatch `json:"DateTime,omitempty"`
}

type PeriodMetaData

type PeriodMetaData struct {
	Warning              string `json:"Warning,omitempty"`
	MaximumRetentionDays int32  `json:"MaximumRetentionDays"`
}

type PredefinedVariable

type PredefinedVariable struct {
	Key       string `json:"Key,omitempty"`
	Value     string `json:"Value,omitempty"`
	Sensitive bool   `json:"Sensitive"`
}

type PresetPeriodType

type PresetPeriodType string

PresetPeriodType :

const (
	CURRENT_DAY_PresetPeriodType    PresetPeriodType = "CurrentDay"
	CURRENT_WEEK_PresetPeriodType   PresetPeriodType = "CurrentWeek"
	CURRENT_MONTH_PresetPeriodType  PresetPeriodType = "CurrentMonth"
	CURRENT_YEAR_PresetPeriodType   PresetPeriodType = "CurrentYear"
	PREVIOUS_DAY_PresetPeriodType   PresetPeriodType = "PreviousDay"
	PREVIOUS_WEEK_PresetPeriodType  PresetPeriodType = "PreviousWeek"
	PREVIOUS_MONTH_PresetPeriodType PresetPeriodType = "PreviousMonth"
	PREVIOUS_YEAR_PresetPeriodType  PresetPeriodType = "PreviousYear"
	LAST24_HOURS_PresetPeriodType   PresetPeriodType = "Last24Hours"
	LAST48_HOURS_PresetPeriodType   PresetPeriodType = "Last48Hours"
	LAST7_DAYS_PresetPeriodType     PresetPeriodType = "Last7Days"
	LAST30_DAYS_PresetPeriodType    PresetPeriodType = "Last30Days"
	LAST60_DAYS_PresetPeriodType    PresetPeriodType = "Last60Days"
	LAST90_DAYS_PresetPeriodType    PresetPeriodType = "Last90Days"
	LAST365_DAYS_PresetPeriodType   PresetPeriodType = "Last365Days"
	LAST3_MONTHS_PresetPeriodType   PresetPeriodType = "Last3Months"
	LAST6_MONTHS_PresetPeriodType   PresetPeriodType = "Last6Months"
	LAST12_MONTHS_PresetPeriodType  PresetPeriodType = "Last12Months"
	LAST24_MONTHS_PresetPeriodType  PresetPeriodType = "Last24Months"
	ALL_PresetPeriodType            PresetPeriodType = "All"
)

List of PresetPeriodType

type PresetPeriodTypeWithExclusive

type PresetPeriodTypeWithExclusive string

PresetPeriodTypeWithExclusive :

const (
	CURRENT_DAY_PresetPeriodTypeWithExclusive        PresetPeriodTypeWithExclusive = "CurrentDay"
	CURRENT_WEEK_PresetPeriodTypeWithExclusive       PresetPeriodTypeWithExclusive = "CurrentWeek"
	CURRENT_MONTH_PresetPeriodTypeWithExclusive      PresetPeriodTypeWithExclusive = "CurrentMonth"
	CURRENT_YEAR_PresetPeriodTypeWithExclusive       PresetPeriodTypeWithExclusive = "CurrentYear"
	PREVIOUS_DAY_PresetPeriodTypeWithExclusive       PresetPeriodTypeWithExclusive = "PreviousDay"
	PREVIOUS_WEEK_PresetPeriodTypeWithExclusive      PresetPeriodTypeWithExclusive = "PreviousWeek"
	PREVIOUS_MONTH_PresetPeriodTypeWithExclusive     PresetPeriodTypeWithExclusive = "PreviousMonth"
	PREVIOUS_YEAR_PresetPeriodTypeWithExclusive      PresetPeriodTypeWithExclusive = "PreviousYear"
	LAST24_HOURS_PresetPeriodTypeWithExclusive       PresetPeriodTypeWithExclusive = "Last24Hours"
	LAST48_HOURS_PresetPeriodTypeWithExclusive       PresetPeriodTypeWithExclusive = "Last48Hours"
	LAST7_DAYS_PresetPeriodTypeWithExclusive         PresetPeriodTypeWithExclusive = "Last7Days"
	LAST30_DAYS_PresetPeriodTypeWithExclusive        PresetPeriodTypeWithExclusive = "Last30Days"
	LAST60_DAYS_PresetPeriodTypeWithExclusive        PresetPeriodTypeWithExclusive = "Last60Days"
	LAST90_DAYS_PresetPeriodTypeWithExclusive        PresetPeriodTypeWithExclusive = "Last90Days"
	LAST365_DAYS_PresetPeriodTypeWithExclusive       PresetPeriodTypeWithExclusive = "Last365Days"
	LAST3_MONTHS_PresetPeriodTypeWithExclusive       PresetPeriodTypeWithExclusive = "Last3Months"
	LAST6_MONTHS_PresetPeriodTypeWithExclusive       PresetPeriodTypeWithExclusive = "Last6Months"
	LAST12_MONTHS_PresetPeriodTypeWithExclusive      PresetPeriodTypeWithExclusive = "Last12Months"
	LAST24_MONTHS_PresetPeriodTypeWithExclusive      PresetPeriodTypeWithExclusive = "Last24Months"
	LAST24_HOURS_EXCL_PresetPeriodTypeWithExclusive  PresetPeriodTypeWithExclusive = "Last24HoursExcl"
	LAST48_HOURS_EXCL_PresetPeriodTypeWithExclusive  PresetPeriodTypeWithExclusive = "Last48HoursExcl"
	LAST7_DAYS_EXCL_PresetPeriodTypeWithExclusive    PresetPeriodTypeWithExclusive = "Last7DaysExcl"
	LAST30_DAYS_EXCL_PresetPeriodTypeWithExclusive   PresetPeriodTypeWithExclusive = "Last30DaysExcl"
	LAST60_DAYS_EXCL_PresetPeriodTypeWithExclusive   PresetPeriodTypeWithExclusive = "Last60DaysExcl"
	LAST90_DAYS_EXCL_PresetPeriodTypeWithExclusive   PresetPeriodTypeWithExclusive = "Last90DaysExcl"
	LAST365_DAYS_EXCL_PresetPeriodTypeWithExclusive  PresetPeriodTypeWithExclusive = "Last365DaysExcl"
	LAST3_MONTHS_EXCL_PresetPeriodTypeWithExclusive  PresetPeriodTypeWithExclusive = "Last3MonthsExcl"
	LAST6_MONTHS_EXCL_PresetPeriodTypeWithExclusive  PresetPeriodTypeWithExclusive = "Last6MonthsExcl"
	LAST12_MONTHS_EXCL_PresetPeriodTypeWithExclusive PresetPeriodTypeWithExclusive = "Last12MonthsExcl"
	LAST24_MONTHS_EXCL_PresetPeriodTypeWithExclusive PresetPeriodTypeWithExclusive = "Last24MonthsExcl"
	ALL_PresetPeriodTypeWithExclusive                PresetPeriodTypeWithExclusive = "All"
)

List of PresetPeriodTypeWithExclusive

type PspAuthorization

type PspAuthorization struct {
	AuthorizationId   string                `json:"AuthorizationId,omitempty"`
	AuthorizationType *PspAuthorizationType `json:"AuthorizationType"`
	OperatorGuid      string                `json:"OperatorGuid,omitempty"`
	OperatorGroupGuid string                `json:"OperatorGroupGuid,omitempty"`
}

type PspAuthorizationType

type PspAuthorizationType string

PspAuthorizationType :

const (
	VIEW_PUBLIC_DASHBOARD_PspAuthorizationType PspAuthorizationType = "ViewPublicDashboard"
)

List of PSPAuthorizationType

type PublicStatusPage

type PublicStatusPage struct {
	PublicDashboardGuid string             `json:"PublicDashboardGuid,omitempty"`
	Name                string             `json:"Name,omitempty"`
	IsPublished         bool               `json:"IsPublished,omitempty"`
	PresetPeriodType    *PresetPeriodType  `json:"PresetPeriodType,omitempty"`
	CustomizationInfo   *CustomizationInfo `json:"CustomizationInfo,omitempty"`
	SlaGuid             string             `json:"SlaGuid,omitempty"`
	MonitorGuids        []string           `json:"MonitorGuids,omitempty"`
	MonitorGroupGuids   []string           `json:"MonitorGroupGuids,omitempty"`
}

type PublicStatusPageApiService

type PublicStatusPageApiService service

func (*PublicStatusPageApiService) PublicStatusPageAddAuthorizationToPublicStatusPage

func (a *PublicStatusPageApiService) PublicStatusPageAddAuthorizationToPublicStatusPage(ctx context.Context, publicStatusPageGuid string, authorization PspAuthorization) (PspAuthorization, *http.Response, error)

PublicStatusPageApiService Creates a new authorization for the specified public status page. The AuthorizationId attribute should be omitted in the request body. The newly created authorization will be returned in the response. An authorization should be granted to either an individual operator, or an operator group. Therefore, either specify the OperatorGuid attribute or the OperatorGroupGuid attribute.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param publicStatusPageGuid The Guid of the public status page.
  • @param authorization The complete definition of the authorization that should be created.

@return PspAuthorization

func (*PublicStatusPageApiService) PublicStatusPageDeletePublicStatusPage

func (a *PublicStatusPageApiService) PublicStatusPageDeletePublicStatusPage(ctx context.Context, publicStatusPageGuid string) (*http.Response, error)

PublicStatusPageApiService Deletes the definition of the specified public status page.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param publicStatusPageGuid The Guid of the public status page that should be updated.

func (*PublicStatusPageApiService) PublicStatusPageGetAuthorizationsForPublicStatusPage

func (a *PublicStatusPageApiService) PublicStatusPageGetAuthorizationsForPublicStatusPage(ctx context.Context, publicStatusPageGuid string) ([]PspAuthorization, *http.Response, error)

PublicStatusPageApiService Returns all authorizations for the specified public status page.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param publicStatusPageGuid The Guid of the public status page.

@return []PspAuthorization

func (*PublicStatusPageApiService) PublicStatusPageGetPublicStatusPage

func (a *PublicStatusPageApiService) PublicStatusPageGetPublicStatusPage(ctx context.Context, publicStatusPageGuid string) (PublicStatusPage, *http.Response, error)

PublicStatusPageApiService Returns the definition of the specified public status page.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param publicStatusPageGuid The Guid of the requested public status page.

@return PublicStatusPage

func (*PublicStatusPageApiService) PublicStatusPageGetPublicStatusPages

func (a *PublicStatusPageApiService) PublicStatusPageGetPublicStatusPages(ctx context.Context) ([]PublicStatusPage, *http.Response, error)

PublicStatusPageApiService Returns the definition of all public status pages available in the account.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []PublicStatusPage

func (*PublicStatusPageApiService) PublicStatusPagePatchPublicStatusPage

func (a *PublicStatusPageApiService) PublicStatusPagePatchPublicStatusPage(ctx context.Context, publicStatusPage PublicStatusPage, publicStatusPageGuid string) (*http.Response, error)

PublicStatusPageApiService Partially updates the definition of the specified public status page. This methods accepts parts of a public status page definition. We recommend retrieving the existing definition first (using the GET method). You can then process the changes you want to make and send back these changes only using this PATCH method.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param publicStatusPage The partial definition for the public status page that should be updated.
  • @param publicStatusPageGuid The Guid of the public status page that should be updated.

func (*PublicStatusPageApiService) PublicStatusPagePostPublicStatusPage

func (a *PublicStatusPageApiService) PublicStatusPagePostPublicStatusPage(ctx context.Context, publicStatusPage PublicStatusPage) (PublicStatusPage, *http.Response, error)

PublicStatusPageApiService Creates a new public status page.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param publicStatusPage The complete definition for the public status page that should be updated.

@return PublicStatusPage

func (*PublicStatusPageApiService) PublicStatusPagePutPublicStatusPage

func (a *PublicStatusPageApiService) PublicStatusPagePutPublicStatusPage(ctx context.Context, publicStatusPage PublicStatusPage, publicStatusPageGuid string) (*http.Response, error)

PublicStatusPageApiService Updates the definition of the specified public status page. This methods only accepts a complete public status page definition. We recommend retrieving the existing definition first (using the GET method). You can then process the changes you want to make and send back the updated definition using this PUT method.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param publicStatusPage The complete definition for the public status page that should be updated.
  • @param publicStatusPageGuid The Guid of the public status page that should be updated.

func (*PublicStatusPageApiService) PublicStatusPageRemoveAuthorizationFromPublicStatusPage

func (a *PublicStatusPageApiService) PublicStatusPageRemoveAuthorizationFromPublicStatusPage(ctx context.Context, publicStatusPageGuid string, authorizationGuid string) (*http.Response, error)

PublicStatusPageApiService Removes an authorization from a public status page.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param publicStatusPageGuid The Guid of the public status page.
  • @param authorizationGuid The Guid of the authorization.

type Recipients

type Recipients struct {
	Operators           []string `json:"Operators,omitempty"`
	OperatorGroups      []string `json:"OperatorGroups,omitempty"`
	ExtraEmailAddresses []string `json:"ExtraEmailAddresses,omitempty"`
}

type RegisterApiService

type RegisterApiService service

func (*RegisterApiService) RegisterPost

RegisterApiService Creates a new API account. This method requires that you specify the username and password of an Uptrends operator login as authentication. When registration is successful, please save the UserName and Password fields from the response; these are your new API credentials.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return RegistrationResponse

type RegisterStatus

type RegisterStatus string

RegisterStatus :

const (
	OK_RegisterStatus               RegisterStatus = "OK"
	UNEXPECTED_ERROR_RegisterStatus RegisterStatus = "UnexpectedError"
)

List of RegisterStatus

type RegistrationResponse

type RegistrationResponse struct {
	// The user name of the new API account
	UserName string `json:"UserName,omitempty"`
	// The password of the new API account
	Password string `json:"Password,omitempty"`
	// The Uptrends Account Id for which the new API account was created
	AccountId string `json:"AccountId,omitempty"`
	// The Uptrends Operator on behalf of whom the new API account was created
	OperatorName string          `json:"OperatorName,omitempty"`
	Status       *RegisterStatus `json:"status"`
	Message      string          `json:"message,omitempty"`
}

type RelationObject

type RelationObject struct {
	Attributes    *interface{}      `json:"Attributes,omitempty"`
	Id            *interface{}      `json:"Id,omitempty"`
	Type_         string            `json:"Type,omitempty"`
	Relationships []RelationObject  `json:"Relationships,omitempty"`
	Links         map[string]string `json:"Links,omitempty"`
}

type RequestHeader

type RequestHeader struct {
	Name  string `json:"Name,omitempty"`
	Value string `json:"Value,omitempty"`
}

type SLAApiService

type SLAApiService service

func (*SLAApiService) SlaCreateSla

func (a *SLAApiService) SlaCreateSla(ctx context.Context, sla Sla) (Sla, *http.Response, error)

SLAApiService Creates a new SLA.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param sla The complete SLA definition that should be created.

@return Sla

func (*SLAApiService) SlaDeleteExclusionPeriod

func (a *SLAApiService) SlaDeleteExclusionPeriod(ctx context.Context, slaGuid string, exclusionPeriodId int32) (*http.Response, error)

SLAApiService Deletes the specified exclusion period for the specified SLA.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param slaGuid The Guid of the sla definition.
  • @param exclusionPeriodId The id of the exclusion period.

func (*SLAApiService) SlaDeleteSla

func (a *SLAApiService) SlaDeleteSla(ctx context.Context, slaGuid string) (*http.Response, error)

SLAApiService Deletes the specified SLA.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param slaGuid The Guid of the SLA definition that should be deleted.

func (*SLAApiService) SlaGetExclusionPeriod

func (a *SLAApiService) SlaGetExclusionPeriod(ctx context.Context, slaGuid string, exclusionPeriodId int32) (ExclusionPeriod, *http.Response, error)

SLAApiService Gets the specified exclusion period for the specified SLA.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param slaGuid The Guid of the SLA definition.
  • @param exclusionPeriodId The id of the exclusion period.

@return ExclusionPeriod

func (*SLAApiService) SlaGetExclusionPeriods

func (a *SLAApiService) SlaGetExclusionPeriods(ctx context.Context, slaGuid string) ([]ExclusionPeriod, *http.Response, error)

SLAApiService Gets a list of all exclusion periods for the specified SLA.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param slaGuid The Guid of the SLA definition.

@return []ExclusionPeriod

func (*SLAApiService) SlaGetSla

func (a *SLAApiService) SlaGetSla(ctx context.Context, slaGuid string) (Sla, *http.Response, error)

SLAApiService Gets the specified SLA definition.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param slaGuid The Guid of the SLA definition.

@return Sla

func (*SLAApiService) SlaGetSlas

func (a *SLAApiService) SlaGetSlas(ctx context.Context) ([]Sla, *http.Response, error)

SLAApiService Gets a list of all SLA definitions.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []Sla

func (*SLAApiService) SlaPatchExclusionPeriod

func (a *SLAApiService) SlaPatchExclusionPeriod(ctx context.Context, slaGuid string, exclusionPeriodId int32, exclusionPeriod ExclusionPeriod) (*http.Response, error)

SLAApiService Partially updates the specified exclusion period for the specified SLA.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param slaGuid The Guid of the SLA definition.
  • @param exclusionPeriodId The id of the exclusion period.
  • @param exclusionPeriod The complete definition of the exclusion period.

func (*SLAApiService) SlaPatchSla

func (a *SLAApiService) SlaPatchSla(ctx context.Context, sla Sla, slaGuid string) (*http.Response, error)

SLAApiService Partially updates the definition of the specified SLA. This methods accepts parts of a SLA definition. We recommend retrieving the existing definition first (using the GET method). You can then process the changes you want to make and send back these changes only using this PATCH method.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param sla The partial definition for the SLA that should be updated.
  • @param slaGuid The Guid of the SLA that should be updated.

func (*SLAApiService) SlaPostExclusionPeriod

func (a *SLAApiService) SlaPostExclusionPeriod(ctx context.Context, exclusionPeriod ExclusionPeriod, slaGuid string) (ExclusionPeriod, *http.Response, error)

SLAApiService Creates a new exclusion period for the specified SLA.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param exclusionPeriod The complete definition of the exclusion period.
  • @param slaGuid The Guid of the SLA definition.

@return ExclusionPeriod

func (*SLAApiService) SlaPutExclusionPeriod

func (a *SLAApiService) SlaPutExclusionPeriod(ctx context.Context, slaGuid string, exclusionPeriodId int32, exclusionPeriod ExclusionPeriod) (*http.Response, error)

SLAApiService Updates the specified exclusion period for the specified SLA.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param slaGuid The Guid of the SLA definition.
  • @param exclusionPeriodId The id of the exclusion period.
  • @param exclusionPeriod The complete definition of the exclusion period.

func (*SLAApiService) SlaPutSla

func (a *SLAApiService) SlaPutSla(ctx context.Context, sla Sla, slaGuid string) (*http.Response, error)

SLAApiService Updates the definition of the specified SLA. This methods only accepts a complete SLA definition. We recommend retrieving the existing definition first (using the GET method). You can then process the changes you want to make and send back the updated definition using this PUT method.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param sla The complete definition for the SLA that should be updated.
  • @param slaGuid The Guid of the SLA that should be updated.

type Schedule

type Schedule struct {
	ScheduleType *ScheduleType `json:"ScheduleType,omitempty"`
	Time         string        `json:"Time,omitempty"`
	WeekDay      *DayOfWeek    `json:"WeekDay,omitempty"`
	MonthDay     int32         `json:"MonthDay,omitempty"`
}

type ScheduleMode

type ScheduleMode string

ScheduleMode :

const (
	ONE_TIME_ScheduleMode ScheduleMode = "OneTime"
	DAILY_ScheduleMode    ScheduleMode = "Daily"
	WEEKLY_ScheduleMode   ScheduleMode = "Weekly"
	MONTHLY_ScheduleMode  ScheduleMode = "Monthly"
)

List of ScheduleMode

type ScheduleType

type ScheduleType string

ScheduleType :

const (
	DAILY_ScheduleType   ScheduleType = "Daily"
	WEEKLY_ScheduleType  ScheduleType = "Weekly"
	MONTHLY_ScheduleType ScheduleType = "Monthly"
)

List of ScheduleType

type ScheduledReport

type ScheduledReport struct {
	ScheduledReportGuid string                         `json:"ScheduledReportGuid,omitempty"`
	Hash                string                         `json:"Hash,omitempty"`
	DashboardGuid       string                         `json:"DashboardGuid,omitempty"`
	FileType            *ScheduledReportFileType       `json:"FileType,omitempty"`
	IsActive            bool                           `json:"IsActive,omitempty"`
	Schedule            *Schedule                      `json:"Schedule,omitempty"`
	SelectedPeriod      *PresetPeriodTypeWithExclusive `json:"SelectedPeriod,omitempty"`
	InternalNotes       string                         `json:"InternalNotes,omitempty"`
	Notes               string                         `json:"Notes,omitempty"`
	Recipients          *Recipients                    `json:"Recipients,omitempty"`
}

type ScheduledReportApiService

type ScheduledReportApiService service

func (*ScheduledReportApiService) ScheduledReportCreateScheduledReport

func (a *ScheduledReportApiService) ScheduledReportCreateScheduledReport(ctx context.Context, scheduledReport ScheduledReport) (ScheduledReport, *http.Response, error)

ScheduledReportApiService Creates a new scheduled report.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param scheduledReport The details for the scheduled report.

@return ScheduledReport

func (*ScheduledReportApiService) ScheduledReportDeleteSpecifiedScheduledReport

func (a *ScheduledReportApiService) ScheduledReportDeleteSpecifiedScheduledReport(ctx context.Context, scheduledReportGuid string) (*http.Response, error)

ScheduledReportApiService Delete the specified scheduled report.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param scheduledReportGuid The guid of the specified scheduled report.

func (*ScheduledReportApiService) ScheduledReportGetAllScheduledReports

func (a *ScheduledReportApiService) ScheduledReportGetAllScheduledReports(ctx context.Context) ([]ScheduledReport, *http.Response, error)

ScheduledReportApiService Returns data for all scheduled reports.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []ScheduledReport

func (*ScheduledReportApiService) ScheduledReportGetSpecifiedScheduledReport

func (a *ScheduledReportApiService) ScheduledReportGetSpecifiedScheduledReport(ctx context.Context, scheduledReportGuid string) (ScheduledReport, *http.Response, error)

ScheduledReportApiService Returns data for the specified scheduled report.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param scheduledReportGuid The guid of the specified scheduled report.

@return ScheduledReport

func (*ScheduledReportApiService) ScheduledReportPartiallyUpdateScheduledReport

func (a *ScheduledReportApiService) ScheduledReportPartiallyUpdateScheduledReport(ctx context.Context, scheduledReportGuid string, scheduledReport ScheduledReport) (ScheduledReport, *http.Response, error)

ScheduledReportApiService Partially update the specified scheduled report.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param scheduledReportGuid The guid of the specified scheduled report.
  • @param scheduledReport The details for the scheduled report.

@return ScheduledReport

func (*ScheduledReportApiService) ScheduledReportUpdateScheduledReport

func (a *ScheduledReportApiService) ScheduledReportUpdateScheduledReport(ctx context.Context, scheduledReportGuid string, scheduledReport ScheduledReport) (ScheduledReport, *http.Response, error)

ScheduledReportApiService Update the specified scheduled report.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param scheduledReportGuid The guid of the specified scheduled report.
  • @param scheduledReport The details for the scheduled report.

@return ScheduledReport

type ScheduledReportFileType

type ScheduledReportFileType string

ScheduledReportFileType :

const (
	PDF_ScheduledReportFileType   ScheduledReportFileType = "PDF"
	EXCEL_ScheduledReportFileType ScheduledReportFileType = "Excel"
	HTML_ScheduledReportFileType  ScheduledReportFileType = "Html"
)

List of ScheduledReportFileType

type ScreenshotResponse

type ScreenshotResponse struct {
	Data          string           `json:"Data,omitempty"`
	Links         *LinksData       `json:"Links,omitempty"`
	Relationships []RelationObject `json:"Relationships,omitempty"`
	Meta          *MetaData        `json:"Meta,omitempty"`
}

type SelectedCheckpoints

type SelectedCheckpoints struct {
	Checkpoints      []int32 `json:"Checkpoints,omitempty"`
	Regions          []int32 `json:"Regions,omitempty"`
	ExcludeLocations []int32 `json:"ExcludeLocations,omitempty"`
}

type SelectedPeriod

type SelectedPeriod struct {
	// The type of period
	SelectedPeriodType *interface{} `json:"SelectedPeriodType,omitempty"`
	// The start of a custom period (can't be used together with the SelectedPeriodType parameter)
	Start time.Time `json:"Start,omitempty"`
	// The end of a custom period
	End time.Time `json:"End,omitempty"`
	// The requested time period.
	PresetPeriod *interface{} `json:"PresetPeriod,omitempty"`
}

type SelectedPeriodType

type SelectedPeriodType string

SelectedPeriodType :

const (
	PRESET_PERIOD_SelectedPeriodType  SelectedPeriodType = "PresetPeriod"
	SPECIFIC_DATES_SelectedPeriodType SelectedPeriodType = "SpecificDates"
)

List of SelectedPeriodType

type SftpAction

type SftpAction string

SftpAction :

const (
	CONNECT_ONLY_SftpAction             SftpAction = "ConnectOnly"
	TEST_FILE_EXISTS_SftpAction         SftpAction = "TestFileExists"
	TEST_FILE_DOES_NOT_EXIST_SftpAction SftpAction = "TestFileDoesNotExist"
	DOWN_LOAD_FILE_SftpAction           SftpAction = "DownLoadFile"
)

List of SftpAction

type SingleMonitorCheckResponse

type SingleMonitorCheckResponse struct {
	Data          *MonitorCheck    `json:"Data,omitempty"`
	Links         *LinksData       `json:"Links,omitempty"`
	Relationships []RelationObject `json:"Relationships,omitempty"`
	Meta          *MetaData        `json:"Meta,omitempty"`
}

type Sla

type Sla struct {
	// The unique key of this sla.
	SlaGuid string `json:"SlaGuid,omitempty"`
	// Hash corresponding with this sla.
	Hash string `json:"Hash,omitempty"`
	// The description name of this sla.
	Description                  string  `json:"Description,omitempty"`
	UptimeErrorThreshold         float64 `json:"UptimeErrorThreshold,omitempty"`
	UptimeWarningThreshold       float64 `json:"UptimeWarningThreshold,omitempty"`
	LoadTimeErrorThreshold       float64 `json:"LoadTimeErrorThreshold,omitempty"`
	OperatorReponseTimeThreshold int32   `json:"OperatorReponseTimeThreshold,omitempty"`
}

type SmsProvider

type SmsProvider string

SmsProvider :

const (
	USE_ACCOUNT_SETTING_SmsProvider        SmsProvider = "UseAccountSetting"
	SMS_PROVIDER_EUROPE_SmsProvider        SmsProvider = "SmsProviderEurope"
	SMS_PROVIDER_INTERNATIONAL_SmsProvider SmsProvider = "SmsProviderInternational"
	SMS_PROVIDER_EUROPE2_SmsProvider       SmsProvider = "SmsProviderEurope2"
	SMS_PROVIDER_USA_SmsProvider           SmsProvider = "SmsProviderUSA"
)

List of SmsProvider

type SortDirection

type SortDirection string

SortDirection :

const (
	ASCENDING_SortDirection  SortDirection = "Ascending"
	DESCENDING_SortDirection SortDirection = "Descending"
)

List of SortDirection

type SortOrderEnum

type SortOrderEnum string

SortOrderEnum :

const (
	ALPHABETICAL_SortOrderEnum SortOrderEnum = "Alphabetical"
	BY_STATUS_SortOrderEnum    SortOrderEnum = "ByStatus"
)

List of SortOrderEnum

type Statistics

type Statistics struct {
	Attributes    *StatisticsAttributes `json:"Attributes,omitempty"`
	Id            string                `json:"Id,omitempty"`
	Type_         string                `json:"Type,omitempty"`
	Relationships []RelationObject      `json:"Relationships,omitempty"`
	Links         map[string]string     `json:"Links,omitempty"`
}

type StatisticsApiService

type StatisticsApiService service

func (*StatisticsApiService) StatisticsGetMonitorGroupStatistics

func (a *StatisticsApiService) StatisticsGetMonitorGroupStatistics(ctx context.Context, monitorGroupGuid string, localVarOptionals *StatisticsGetMonitorGroupStatisticsOpts) (StatisticsResponse, *http.Response, error)

func (*StatisticsApiService) StatisticsGetMonitorStatistics

func (a *StatisticsApiService) StatisticsGetMonitorStatistics(ctx context.Context, monitorGuid string, localVarOptionals *StatisticsGetMonitorStatisticsOpts) (StatisticsResponse, *http.Response, error)

type StatisticsAttributes

type StatisticsAttributes struct {
	StartDateTime          time.Time `json:"StartDateTime"`
	EndDateTime            time.Time `json:"EndDateTime"`
	Alerts                 int32     `json:"Alerts,omitempty"`
	SlaTarget              float64   `json:"SlaTarget,omitempty"`
	SlaTargetTotalTime     float64   `json:"SlaTargetTotalTime,omitempty"`
	OperatorResponseTarget float64   `json:"OperatorResponseTarget,omitempty"`
	OperatorResponseTime   float64   `json:"OperatorResponseTime,omitempty"`
	DowntimePercentage     float64   `json:"DowntimePercentage,omitempty"`
	UptimePercentage       float64   `json:"UptimePercentage,omitempty"`
	Checks                 int64     `json:"Checks,omitempty"`
	ConfirmedErrors        int32     `json:"ConfirmedErrors,omitempty"`
	UnconfirmedErrors      int32     `json:"UnconfirmedErrors,omitempty"`
	Uptime                 int64     `json:"Uptime,omitempty"`
	Downtime               int64     `json:"Downtime,omitempty"`
	TotalTime              float32   `json:"TotalTime,omitempty"`
	ResolveTime            float32   `json:"ResolveTime,omitempty"`
	ConnectionTime         float32   `json:"ConnectionTime,omitempty"`
	DownloadTime           float32   `json:"DownloadTime,omitempty"`
	TotalBytes             int64     `json:"TotalBytes,omitempty"`
}

type StatisticsGetMonitorGroupStatisticsOpts

type StatisticsGetMonitorGroupStatisticsOpts struct {
	Filter       optional.String
	Start        optional.Time
	End          optional.Time
	PresetPeriod optional.String
}

type StatisticsGetMonitorStatisticsOpts

type StatisticsGetMonitorStatisticsOpts struct {
	Filter       optional.String
	Start        optional.Time
	End          optional.Time
	PresetPeriod optional.String
}

type StatisticsResponse

type StatisticsResponse struct {
	Data          []Statistics     `json:"Data,omitempty"`
	Links         *LinksData       `json:"Links,omitempty"`
	Relationships []RelationObject `json:"Relationships,omitempty"`
	Meta          *MetaData        `json:"Meta,omitempty"`
}

type StatusApiService

type StatusApiService service

func (*StatusApiService) StatusGetMonitorGroupStatus

func (a *StatusApiService) StatusGetMonitorGroupStatus(ctx context.Context, monitorGroupGuid string) (MonitorStatusListResponse, *http.Response, error)

StatusApiService Gets a list of all monitor group status data.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param monitorGroupGuid The Guid of the monitor group.

@return MonitorStatusListResponse

func (*StatusApiService) StatusGetMonitorStatus

func (a *StatusApiService) StatusGetMonitorStatus(ctx context.Context, monitorGuid string) (MonitorStatusResponse, *http.Response, error)

StatusApiService Gets all monitor status data.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param monitorGuid The Guid of the monitor.

@return MonitorStatusResponse

type StepTimingInfo

type StepTimingInfo struct {
	Description         string           `json:"Description,omitempty"`
	StartUtc            time.Time        `json:"StartUtc"`
	EndUtc              time.Time        `json:"EndUtc"`
	ElapsedMilliseconds int64            `json:"ElapsedMilliseconds"`
	DelayMilliseconds   int64            `json:"DelayMilliseconds"`
	SubTimingInfos      []StepTimingInfo `json:"SubTimingInfos,omitempty"`
	// If true, this TimingInfo should be counted as part of the sum of its siblings. If false, the TimingInfo should be discarded (e.g. for PreDelays we don't want to count).
	IsValid bool `json:"IsValid"`
}

type SubStepType

type SubStepType string

SubStepType :

const (
	NAVIGATE_SubStepType         SubStepType = "Navigate"
	CLICK_SubStepType            SubStepType = "Click"
	SET_SubStepType              SubStepType = "Set"
	TEST_SubStepType             SubStepType = "Test"
	SCRIPT_SubStepType           SubStepType = "Script"
	HOVER_SubStepType            SubStepType = "Hover"
	SCREENSHOT_SubStepType       SubStepType = "Screenshot"
	SCROLL_TO_SubStepType        SubStepType = "ScrollTo"
	WAIT_FOR_ELEMENT_SubStepType SubStepType = "WaitForElement"
	SWITCH_TO_FRAME_SubStepType  SubStepType = "SwitchToFrame"
	SWITCH_TO_TAB_SubStepType    SubStepType = "SwitchToTab"
)

List of SubStepType

type ThrottlingOptions

type ThrottlingOptions struct {
	ThrottlingType      *ThrottlingType  `json:"ThrottlingType,omitempty"`
	ThrottlingValue     *ThrottlingValue `json:"ThrottlingValue,omitempty"`
	ThrottlingSpeedUp   int32            `json:"ThrottlingSpeedUp,omitempty"`
	ThrottlingSpeedDown int32            `json:"ThrottlingSpeedDown,omitempty"`
	ThrottlingLatency   int32            `json:"ThrottlingLatency,omitempty"`
}

type ThrottlingType

type ThrottlingType string

ThrottlingType :

const (
	INACTIVE_ThrottlingType  ThrottlingType = "Inactive"
	BROWSER_ThrottlingType   ThrottlingType = "Browser"
	SIMULATED_ThrottlingType ThrottlingType = "Simulated"
)

List of ThrottlingType

type ThrottlingValue

type ThrottlingValue string

ThrottlingValue :

const (
	ThrottlingValueADSL  ThrottlingValue = "Adsl"
	ThrottlingValueFIBER ThrottlingValue = "Fiber"
	ThrottlingValueCABLE ThrottlingValue = "Cable"
	ThrottlingValue2G    ThrottlingValue = "2G"
	ThrottlingValue3G    ThrottlingValue = "3G"
	ThrottlingValue4G    ThrottlingValue = "4G"
)

List of ThrottlingValue

type Timezone

type Timezone struct {
	// The time zone unique identifier
	TimezoneId int32 `json:"TimezoneId"`
	// The description of the time zone
	Description string `json:"Description,omitempty"`
	// The offset from UTC in minutes (if this time zone runs behind UTC, the number is negative)
	OffsetFromUtc int32 `json:"OffsetFromUtc"`
	// Indicates whether or not this time zone uses Daylight Saving Time
	HasDaylightSaving bool `json:"HasDaylightSaving"`
	// The time offset for Daylight Saving Time in minutes
	DaylightSavingOffset int32 `json:"DaylightSavingOffset,omitempty"`
}

Time zone available in Uptrends

type TlsVersion

type TlsVersion string

TlsVersion :

const (
	TLS12_TlsVersion                           TlsVersion = "Tls12"
	TLS11_TlsVersion                           TlsVersion = "Tls11"
	TLS10_TlsVersion                           TlsVersion = "Tls10"
	TLS12_TLS11_TlsVersion                     TlsVersion = "Tls12_Tls11"
	TLS11_TLS10_TlsVersion                     TlsVersion = "Tls11_Tls10"
	TLS12_TLS11_TLS10_TlsVersion               TlsVersion = "Tls12_Tls11_Tls10"
	TLS12_TLS11_TLS10_WITH_FALLBACK_TlsVersion TlsVersion = "Tls12_Tls11_Tls10_WithFallback"
)

List of TlsVersion

type TransactionAttributes

type TransactionAttributes struct {
	// Results of the transaction steps
	StepResults []TransactionStepOResourceObject `json:"StepResults,omitempty"`
	// The HTML code returned in case of errors
	ResponseBody string `json:"ResponseBody,omitempty"`
}

type TransactionCheckDetails

type TransactionCheckDetails struct {
	Attributes    *TransactionAttributes `json:"Attributes,omitempty"`
	Id            int64                  `json:"Id"`
	Type_         string                 `json:"Type,omitempty"`
	Relationships []RelationObject       `json:"Relationships,omitempty"`
	Links         map[string]string      `json:"Links,omitempty"`
}

type TransactionDetailsResponse

type TransactionDetailsResponse struct {
	Data          *TransactionCheckDetails `json:"Data,omitempty"`
	Links         *LinksData               `json:"Links,omitempty"`
	Relationships []RelationObject         `json:"Relationships,omitempty"`
	Meta          *MetaData                `json:"Meta,omitempty"`
}

type TransactionStep

type TransactionStep struct {
	// Step (index) number
	StepNumber int32 `json:"StepNumber"`
	// The name of the step
	StepName string `json:"StepName,omitempty"`
	// Number of milliseconds it took for this step to succeed
	TotalTime float64 `json:"TotalTime"`
	// Text representation of the step element results
	Elements []string `json:"Elements,omitempty"`
	// Did this step result in an error?
	HasError bool `json:"HasError"`
}

Describes one step in a transaction

type TransactionStep2

type TransactionStep2 struct {
	Name          string               `json:"Name,omitempty"`
	HasScreenshot bool                 `json:"HasScreenshot"`
	HasWaterfall  bool                 `json:"HasWaterfall"`
	SubSteps      []TransactionSubStep `json:"SubSteps,omitempty"`
}

type TransactionStepDefinition

type TransactionStepDefinition struct {
	Steps []TransactionStep2 `json:"Steps,omitempty"`
}

type TransactionStepOResourceObject

type TransactionStepOResourceObject struct {
	Attributes    *TransactionStep  `json:"Attributes,omitempty"`
	Id            int32             `json:"Id"`
	Type_         string            `json:"Type,omitempty"`
	Relationships []RelationObject  `json:"Relationships,omitempty"`
	Links         map[string]string `json:"Links,omitempty"`
}

type TransactionSubStep

type TransactionSubStep struct {
	Name     string       `json:"Name,omitempty"`
	Type_    *SubStepType `json:"Type"`
	Url      string       `json:"Url,omitempty"`
	SetValue string       `json:"SetValue,omitempty"`
}

type VaultApiService

type VaultApiService service

func (*VaultApiService) VaultCreateAuthorizationForVaultSection

func (a *VaultApiService) VaultCreateAuthorizationForVaultSection(ctx context.Context, authorization VaultSectionAuthorization, vaultSectionGuid string) (VaultSectionAuthorization, *http.Response, error)

VaultApiService Creates a new authorization for the specified vault section. The AuthorizationId attribute should be omitted in the request body. The newly created authorization will be returned in the response. An authorization should be granted to either an individual operator, or an operator group. Therefore, either specify the OperatorGuid attribute or the OperatorGroupGuid attribute.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param authorization
  • @param vaultSectionGuid The Guid of the vault section for which to create the new authorization.

@return VaultSectionAuthorization

func (*VaultApiService) VaultCreateNewVaultItem

func (a *VaultApiService) VaultCreateNewVaultItem(ctx context.Context, item VaultItem) (VaultItem, *http.Response, error)

VaultApiService Creates a new vault item. The VaultItemGuid field should be omitted

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param item The item to create

@return VaultItem

func (*VaultApiService) VaultCreateNewVaultSection

func (a *VaultApiService) VaultCreateNewVaultSection(ctx context.Context, section VaultSection) (VaultSection, *http.Response, error)

VaultApiService Creates a new vault section. When a new vault section is created, the user that created the section is granted View and Edit authorizations to that section. The VaultSectionGuid attribute should be omitted in the request body. The Guid of the newly created section will be returned in the response.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param section The attributes of the vault section that should be created.

@return VaultSection

func (*VaultApiService) VaultDeleteAuthorizationForVaultSection

func (a *VaultApiService) VaultDeleteAuthorizationForVaultSection(ctx context.Context, vaultSectionGuid string, authorizationGuid string) (*http.Response, error)

VaultApiService Deletes the specified authorization for the specified vault section.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param vaultSectionGuid The Guid of the vault section for which the authorization should be deleted.
  • @param authorizationGuid The Guid of the authorization that should be deleted.

func (*VaultApiService) VaultDeleteVaultItem

func (a *VaultApiService) VaultDeleteVaultItem(ctx context.Context, vaultItemGuid string) (*http.Response, error)

VaultApiService Deletes the specified vault item.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param vaultItemGuid The Guid of the vault item that should be deleted.

func (*VaultApiService) VaultDeleteVaultSection

func (a *VaultApiService) VaultDeleteVaultSection(ctx context.Context, vaultSectionGuid string) (*http.Response, error)

VaultApiService Deletes the specified vault section.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param vaultSectionGuid The Guid of the vault section that should be deleted.

func (*VaultApiService) VaultGetAllVaultItems

func (a *VaultApiService) VaultGetAllVaultItems(ctx context.Context) ([]VaultItem, *http.Response, error)

VaultApiService Returns all vault items.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []VaultItem

func (*VaultApiService) VaultGetAllVaultSections

func (a *VaultApiService) VaultGetAllVaultSections(ctx context.Context) ([]VaultSection, *http.Response, error)

VaultApiService Returns all vault sections.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []VaultSection

func (*VaultApiService) VaultGetAuthorizationsForVaultSection

func (a *VaultApiService) VaultGetAuthorizationsForVaultSection(ctx context.Context, vaultSectionGuid string) (VaultSectionAuthorization, *http.Response, error)

VaultApiService Returns all authorizations for the specified vault section.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param vaultSectionGuid The Guid of the vault section for which to return authorizations.

@return VaultSectionAuthorization

func (*VaultApiService) VaultGetVaultItem

func (a *VaultApiService) VaultGetVaultItem(ctx context.Context, vaultItemGuid string) (VaultItem, *http.Response, error)

VaultApiService Returns the specified vault item.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param vaultItemGuid The Guid of the requested vault item.

@return VaultItem

func (*VaultApiService) VaultGetVaultSection

func (a *VaultApiService) VaultGetVaultSection(ctx context.Context, vaultSectionGuid string) (VaultSection, *http.Response, error)

VaultApiService Returns the specified vault section.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param vaultSectionGuid The Guid of the requested vault section.

@return VaultSection

func (*VaultApiService) VaultUpdateVaultItem

func (a *VaultApiService) VaultUpdateVaultItem(ctx context.Context, item VaultItem, vaultItemGuid string) (*http.Response, error)

VaultApiService Updates the specified vault item. Only complete definitions are accepted. Fields not specified will be NULLed.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param item The complete definition of the vault item that should be updated.
  • @param vaultItemGuid The Guid of the vault item that should be updated.

func (*VaultApiService) VaultUpdateVaultSection

func (a *VaultApiService) VaultUpdateVaultSection(ctx context.Context, item VaultSection, vaultSectionGuid string) (*http.Response, error)

VaultApiService Updates the specified vault section.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param item
  • @param vaultSectionGuid The Guid of the vault section that should be updated.

type VaultItem

type VaultItem struct {
	// The unique key of this vault item
	VaultItemGuid string `json:"VaultItemGuid"`
	// The hash of this vault item
	Hash string `json:"Hash,omitempty"`
	// The name of this vault item
	Name string `json:"Name,omitempty"`
	// The value that is stored in this vault item. Not used for Certificate Archives
	Value string `json:"Value,omitempty"`
	// The unique identifier of the vault section that this vault item belongs to
	VaultSectionGuid string `json:"VaultSectionGuid"`
	// The vault item type
	VaultItemType *interface{} `json:"VaultItemType"`
	// Whether or not the vault item is considered sensitive.
	IsSensitive bool `json:"IsSensitive"`
	// Notes about this vault item
	Notes string `json:"Notes,omitempty"`
	// The UserName of a credentialset
	UserName string `json:"UserName,omitempty"`
	// The password associated with a credentialset
	Password string `json:"Password,omitempty"`
	// The certificate archive that is stored in this vault item, if applicable
	CertificateArchive *interface{} `json:"CertificateArchive,omitempty"`
	// The file info that is stored in this vault item, if applicable
	FileInfo *interface{} `json:"FileInfo,omitempty"`
}

type VaultItemTypes

type VaultItemTypes string

VaultItemTypes :

const (
	CREDENTIAL_SET_VaultItemTypes      VaultItemTypes = "CredentialSet"
	CERTIFICATE_VaultItemTypes         VaultItemTypes = "Certificate"
	TEXT_VaultItemTypes                VaultItemTypes = "Text"
	CERTIFICATE_ARCHIVE_VaultItemTypes VaultItemTypes = "CertificateArchive"
	FILE_VaultItemTypes                VaultItemTypes = "File"
)

List of VaultItemTypes

type VaultSection

type VaultSection struct {
	// The Guid of this vault section
	VaultSectionGuid string `json:"VaultSectionGuid"`
	// The name for this vault section
	Name string `json:"Name,omitempty"`
}

type VaultSectionAuthorization

type VaultSectionAuthorization struct {
	AuthorizationId   string                         `json:"AuthorizationId,omitempty"`
	AuthorizationType *VaultSectionAuthorizationType `json:"AuthorizationType"`
	OperatorGuid      string                         `json:"OperatorGuid,omitempty"`
	OperatorGroupGuid string                         `json:"OperatorGroupGuid,omitempty"`
}

type VaultSectionAuthorizationType

type VaultSectionAuthorizationType string

VaultSectionAuthorizationType :

const (
	VIEW_VAULT_SECTION_VaultSectionAuthorizationType   VaultSectionAuthorizationType = "ViewVaultSection"
	CHANGE_VAULT_SECTION_VaultSectionAuthorizationType VaultSectionAuthorizationType = "ChangeVaultSection"
)

List of VaultSectionAuthorizationType

type WaterfallInfo

type WaterfallInfo struct {
	// Elements in the waterfall
	Elements []PageElement `json:"Elements,omitempty"`
	// List of domain groups used in the waterfall elements
	DomainGroupNames []string `json:"DomainGroupNames,omitempty"`
}

type WaterfallResponse

type WaterfallResponse struct {
	Attributes    *WaterfallInfo    `json:"Attributes,omitempty"`
	Id            int64             `json:"Id"`
	Type_         string            `json:"Type,omitempty"`
	Relationships []RelationObject  `json:"Relationships,omitempty"`
	Links         map[string]string `json:"Links,omitempty"`
}

Source Files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL