Categorygithub.com/ionos-cloud/uptrends-go
modulepackage
0.0.0-20230411170259-4e57fa16acff
Repository: https://github.com/ionos-cloud/uptrends-go.git
Documentation: pkg.go.dev

# 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

ClassMethodHTTP requestDescription
AccountApiAccountGetAccountStatisticsGet /AccountReturns the account statistics.
AccountApiAccountGetSettingsGet /Account/SettingsReturns account general settings.
AlertApiAlertGetMonitorAlertsGet /Alert/Monitor/{monitorGuid}Returns alerts for a specific monitor.
AlertApiAlertGetMonitorGroupAlertsGet /Alert/MonitorGroup/{monitorGroupGuid}Returns alerts for a specific monitor group.
AlertDefinitionApiAlertDefinitionAddIntegrationToEscalationLevelPost /AlertDefinition/{alertDefinitionGuid}/EscalationLevel/{escalationLevelId}/IntegrationAdds an integration to a specified escalation level.
AlertDefinitionApiAlertDefinitionAddMonitorGroupToAlertDefinitionPost /AlertDefinition/{alertDefinitionGuid}/Member/MonitorGroup/{monitorGroupGuid}Adds a monitor group to the specified alert definition.
AlertDefinitionApiAlertDefinitionAddMonitorToAlertDefinitionPost /AlertDefinition/{alertDefinitionGuid}/Member/Monitor/{monitorGuid}Adds a monitor to the specified alert definition.
AlertDefinitionApiAlertDefinitionAddOperatorGroupToEscalationLevelPost /AlertDefinition/{alertDefinitionGuid}/EscalationLevel/{escalationLevelId}/Member/OperatorGroup/{operatorGroupGuid}Adds an operator group to the specified escalation level.
AlertDefinitionApiAlertDefinitionAddOperatorToEscalationLevelPost /AlertDefinition/{alertDefinitionGuid}/EscalationLevel/{escalationLevelId}/Member/Operator/{operatorGuid}Adds an operator to the specified escalation level.
AlertDefinitionApiAlertDefinitionCreateAlertDefinitionPost /AlertDefinitionCreates a new alert definition.
AlertDefinitionApiAlertDefinitionCreateAuthorizationForAlertDefinitionPost /AlertDefinition/{alertDefinitionGuid}/AuthorizationsCreate authorizations for alert definition If the wanted authorizations requires other authorizations, these will be added as well
AlertDefinitionApiAlertDefinitionDeleteAlertDefinitionDelete /AlertDefinition/{alertDefinitionGuid}Deletes an existing alert definition.
AlertDefinitionApiAlertDefinitionDeleteAuthorizationForAlertDefinitionDelete /AlertDefinition/{alertDefinitionGuid}/Authorizations/{authorizationGuid}Delete alert definition authorization for alert definition
AlertDefinitionApiAlertDefinitionGetAllAlertDefinitionsGet /AlertDefinitionGets a list of all alert definitions.
AlertDefinitionApiAlertDefinitionGetAllEscalationLevelIntegrationsGet /AlertDefinition/{alertDefinitionGuid}/EscalationLevel/{escalationLevelId}/IntegrationGets all integrations for a specified escalation level.
AlertDefinitionApiAlertDefinitionGetAllEscalationLevelsGet /AlertDefinition/{alertDefinitionGuid}/EscalationLevelGets all escalation level information for the specified alert definition.
AlertDefinitionApiAlertDefinitionGetAllMembersGet /AlertDefinition/{alertDefinitionGuid}/MemberGets a list of all monitor and monitor group guids for the specified alert definition.
AlertDefinitionApiAlertDefinitionGetAuthorizationsOfAlertDefinitionGet /AlertDefinition/{alertDefinitionGuid}/AuthorizationsGet authorizations of alert definition
AlertDefinitionApiAlertDefinitionGetEscalationLevelGet /AlertDefinition/{alertDefinitionGuid}/EscalationLevel/{escalationLevelId}Gets the escalation level information of the specified alert definition.
AlertDefinitionApiAlertDefinitionGetEscalationLevelIntegrationGet /AlertDefinition/{alertDefinitionGuid}/EscalationLevel/{escalationLevelId}/Integration/{integrationGuid}Gets a single integration for a specified escalation level.
AlertDefinitionApiAlertDefinitionGetEscalationLevelOperatorGet /AlertDefinition/{alertDefinitionGuid}/EscalationLevel/{escalationLevelId}/MemberGets the operator and operator group guids for the specified escalation level.
AlertDefinitionApiAlertDefinitionGetSpecifiedAlertDefinitionsGet /AlertDefinition/{alertDefinitionGuid}Gets the specified alert definition.
AlertDefinitionApiAlertDefinitionPatchAlertDefinitionPatch /AlertDefinition/{alertDefinitionGuid}Partially updates the definition for the specified alert definition.
AlertDefinitionApiAlertDefinitionPatchAlertDefinitionEscalationPatch /AlertDefinition/{alertDefinitionGuid}/EscalationLevel/{escalationLevelId}Partially updates the escalation level for the specified alert definition.
AlertDefinitionApiAlertDefinitionPutAlertDefinitionPut /AlertDefinition/{alertDefinitionGuid}Updates the definition for the specified alert definition.
AlertDefinitionApiAlertDefinitionPutAlertDefinitionEscalationPut /AlertDefinition/{alertDefinitionGuid}/EscalationLevel/{escalationLevelId}Updates the escalation level for the specified alert definition.
AlertDefinitionApiAlertDefinitionRemoveIntegrationFromEscalationLevelDelete /AlertDefinition/{alertDefinitionGuid}/EscalationLevel/{escalationLevelId}/Integration/{integrationGuid}Removes an integration from a specified escalation level.
AlertDefinitionApiAlertDefinitionRemoveMonitorFromAlertDefinitionDelete /AlertDefinition/{alertDefinitionGuid}/Member/Monitor/{monitorGuid}Removes a monitor for the specified alert definition.
AlertDefinitionApiAlertDefinitionRemoveMonitorGroupFromAlertDefinitionDelete /AlertDefinition/{alertDefinitionGuid}/Member/MonitorGroup/{monitorGroupGuid}Removes a monitor group for the specified alert definition.
AlertDefinitionApiAlertDefinitionRemoveOperatorFromEscalationLevelDelete /AlertDefinition/{alertDefinitionGuid}/EscalationLevel/{escalationLevelId}/Member/Operator/{operatorGuid}Removes an operator for the specified escalation level.
AlertDefinitionApiAlertDefinitionRemoveOperatorGroupFromEscalationLevelDelete /AlertDefinition/{alertDefinitionGuid}/EscalationLevel/{escalationLevelId}/Member/OperatorGroup/{operatorGroupGuid}Removes an operator group for the specified escalation level.
AlertDefinitionApiAlertDefinitionUpdateIntegrationForEscalationWithPatchPatch /AlertDefinition/{alertDefinitionGuid}/EscalationLevel/{escalationLevelId}/Integration/{integrationGuid}Partially updates an integration for a specified escalation level.
AlertDefinitionApiAlertDefinitionUpdateIntegrationForEscalationWithPutPut /AlertDefinition/{alertDefinitionGuid}/EscalationLevel/{escalationLevelId}/Integration/{integrationGuid}Updates an integration for a specified escalation level.
CheckpointApiCheckpointGetAllCheckpointsGet /CheckpointReturns all the checkpoints that are not deleted
CheckpointApiCheckpointGetCheckpointGet /Checkpoint/{checkpointId}Returns the specified checkpoint, deleted or not
CheckpointApiCheckpointRegionGetAllCheckpointRegionsGet /CheckpointRegionReturns all the checkpoint regions.
CheckpointApiCheckpointRegionGetCheckpointRegionCheckpointsGet /CheckpointRegion/{checkpointRegionId}/CheckpointReturns the checkpoints for the specified checkpoint region.
CheckpointApiCheckpointRegionGetSpecifiedCheckpointRegionGet /CheckpointRegion/{checkpointRegionId}Returns the specified checkpoint region.
CheckpointApiCheckpointServerGetAllServerIpv4AddressesGet /Checkpoint/Server/Ipv4Anonymous call that returns all the IPv4 addresses of all the checkpoint servers.
CheckpointApiCheckpointServerGetAllServerIpv6AddressesGet /Checkpoint/Server/Ipv6Anonymous call that returns all the IPv6 addresses of all the checkpoint servers.
CheckpointApiCheckpointServerGetServerGet /Checkpoint/Server/{serverId}Returns the requested checkpoint server.
CheckpointApiPrivateCheckpointHealthGetPrivateCheckpointHealthForRegionGet /PrivateCheckpointHealthForRegionReturns the status of the private checkpoints in the given region.
CheckpointApiPrivateCheckpointHealthGetSpecifiedPrivateCheckpointHealthGet /PrivateCheckpointHealthReturns the status of the specified private checkpoints.
DashboardApiDashboardCloneDashboardPost /Dashboard/{dashboardGuid}/CloneClone the specified dashboard.
DashboardApiDashboardDeleteDashboardDelete /Dashboard/{dashboardGuid}Delete the specified dashboard.
DashboardApiDashboardGetAllDashboardsGet /DashboardReturns data for all dashboards.
DashboardApiDashboardGetOneDashboardGet /Dashboard/{dashboardGuid}Returns data for the specified dashboard.
DashboardApiDashboardPartiallyUpdateDashboardPatch /Dashboard/{dashboardGuid}Partially update the specified dashboard.
DashboardApiDashboardUpdateDashboardPut /Dashboard/{dashboardGuid}Update the specified dashboard.
IntegrationApiIntegrationCreateAuthorizationForIntegrationPost /Integration/{integrationGuid}/AuthorizationsCreate authorizations for integration If the wanted authorizations requires other authorizations, these will be added as well
IntegrationApiIntegrationDeleteAuthorizationForIntegrationDelete /Integration/{integrationGuid}/Authorizations/{authorizationGuid}Delete integration authorization for integration
IntegrationApiIntegrationGetAllIntegrationsGet /IntegrationGets a list of all integrations.
IntegrationApiIntegrationGetAuthorizationsOfIntegrationGet /Integration/{integrationGuid}/AuthorizationsGet authorizations of integration
MonitorApiMonitorCleanupMaintenancePeriodsPost /Monitor/{monitorGuid}/MaintenancePeriod/Cleanup/{beforeDate}Clears out all one-time maintenance periods for the specified monitor older than the specified date
MonitorApiMonitorCloneMonitorPost /Monitor/{monitorGuid}/CloneCreates a clone (duplicate) of the specified monitor.
MonitorApiMonitorCreateAuthorizationForMonitorPost /Monitor/{monitorGuid}/AuthorizationsCreate monitor authorizations for monitor If the wanted authorizations requires other authorizations, these will be added as well
MonitorApiMonitorCreateMaintenancePeriodForMonitorPost /Monitor/{monitorGuid}/MaintenancePeriodSaves the new maintenance period provided for the specified monitor
MonitorApiMonitorDeleteAuthorizationForMonitorGroupDelete /Monitor/{monitorGuid}/Authorizations/{authorizationGuid}Delete monitor authorization for monitor
MonitorApiMonitorDeleteMaintenancePeriodFromMonitorDelete /Monitor/{monitorGuid}/MaintenancePeriod/{maintenancePeriodId}Deletes the specified maintenance period from the specified monitor
MonitorApiMonitorDeleteMonitorDelete /Monitor/{monitorGuid}Deletes the specified monitor.
MonitorApiMonitorGetAllMaintenancePeriodsForMonitorGet /Monitor/{monitorGuid}/MaintenancePeriodFinds all maintenance periods for a monitor.
MonitorApiMonitorGetAuthorizationsOfMonitorGet /Monitor/{monitorGuid}/AuthorizationsGet monitor authorizations of monitor
MonitorApiMonitorGetMonitorGet /Monitor/{monitorGuid}Returns the definition of the specified monitor.
MonitorApiMonitorGetMonitorGroupsGet /Monitor/{monitorGuid}/MonitorGroupReturns the Guid of each monitor group where the specified monitor is a member of.
MonitorApiMonitorGetMonitorsGet /MonitorReturns the definition of all monitors available in the account.
MonitorApiMonitorGetMonitorsByMonitorGroupGet /Monitor/MonitorGroup/{monitorGroupGuid}Returns the definition of all monitors available in the account that are a member of the specified monitor group.
MonitorApiMonitorPatchMonitorPatch /Monitor/{monitorGuid}Partially updates the definition of the specified monitor.
MonitorApiMonitorPostMonitorPost /MonitorCreates a new monitor.
MonitorApiMonitorPutMonitorPut /Monitor/{monitorGuid}Updates the definition of the specified monitor.
MonitorApiMonitorUpdateMaintenancePeriodForMonitorPut /Monitor/{monitorGuid}/MaintenancePeriod/{maintenancePeriodId}Updates the specified maintenance schedule for the specified monitor
MonitorCheckApiMonitorCheckGetAccountMonitorChecksGet /MonitorCheckReturns all monitor check data.
MonitorCheckApiMonitorCheckGetConcurrentMonitorPartialChecksGet /MonitorCheck/{monitorCheckId}/ConcurrentGets all partial checks for a concurrent monitor check
MonitorCheckApiMonitorCheckGetConsoleLogInfoGet /MonitorCheck/{monitorCheckId}/ConsoleLogReturns console log information for a monitor check.
MonitorCheckApiMonitorCheckGetHttpDetailsGet /MonitorCheck/{monitorCheckId}/HttpReturns HTTP details for a monitor check.
MonitorCheckApiMonitorCheckGetMonitorCheckGet /MonitorCheck/Monitor/{monitorGuid}Returns monitor check data for a specific monitor.
MonitorCheckApiMonitorCheckGetMonitorGroupDataGet /MonitorCheck/MonitorGroup/{monitorGroupGuid}Returns monitor check data for a specific monitor group.
MonitorCheckApiMonitorCheckGetMultistepDetailsGet /MonitorCheck/{monitorCheckId}/MultiStepAPIReturns Multi-Step API details for a monitor check.
MonitorCheckApiMonitorCheckGetPageSourceInfoGet /MonitorCheck/{monitorCheckId}/PageSourceReturns page source information for a monitor check.
MonitorCheckApiMonitorCheckGetScreenshotsGet /MonitorCheck/{monitorCheckId}/Screenshot/{screenshotId}Gets a specific screenshot for a specified monitor check
MonitorCheckApiMonitorCheckGetSingleMonitorCheckGet /MonitorCheck/{monitorCheckId}Returns a single monitor check.
MonitorCheckApiMonitorCheckGetTransactionDetailsGet /MonitorCheck/{monitorCheckId}/TransactionReturns transaction step details for a monitor check.
MonitorCheckApiMonitorCheckGetWaterfallInfoGet /MonitorCheck/{monitorCheckId}/WaterfallReturns waterfall information for a monitor check.
MonitorGroupApiMonitorGroupAddMaintenancePeriodToAllMembersPost /MonitorGroup/{monitorGroupGuid}/AddMaintenancePeriodToAllMembersAdds the provided maintenance period to all monitors in the group specified
MonitorGroupApiMonitorGroupAddMonitorToMonitorGroupPost /MonitorGroup/{monitorGroupGuid}/Member/{monitorGuid}Adds the specified monitor to the monitor group
MonitorGroupApiMonitorGroupCreateAuthorizationForMonitorGroupPost /MonitorGroup/{monitorGroupGuid}/AuthorizationsCreate monitor authorizations for monitor group If the wanted authorizations requires other authorizations, these will be added as well
MonitorGroupApiMonitorGroupCreateMonitorGroupPost /MonitorGroupCreates a new monitor group
MonitorGroupApiMonitorGroupDeleteAuthorizationForMonitorGroupDelete /MonitorGroup/{monitorGroupGuid}/Authorizations/{authorizationGuid}Delete monitor authorization for monitor group
MonitorGroupApiMonitorGroupDeleteMonitorGroupDelete /MonitorGroup/{monitorGroupGuid}Deletes the specified monitor group
MonitorGroupApiMonitorGroupGetAllMonitorGroupsGet /MonitorGroupGets all monitor groups
MonitorGroupApiMonitorGroupGetAuthorizationsOfMonitorGroupGet /MonitorGroup/{monitorGroupGuid}/AuthorizationsGet monitor authorizations of monitor group
MonitorGroupApiMonitorGroupGetMonitorGroupGet /MonitorGroup/{monitorGroupGuid}Gets the details of a monitor group
MonitorGroupApiMonitorGroupGetMonitorGroupMembersGet /MonitorGroup/{monitorGroupGuid}/MemberGets a list of all members of a monitor group
MonitorGroupApiMonitorGroupRemoveMonitorFromMonitorGroupDelete /MonitorGroup/{monitorGroupGuid}/Member/{monitorGuid}Removes the specified monitor from the monitor group
MonitorGroupApiMonitorGroupStartAllMonitorAlertsInGroupPost /MonitorGroup/{monitorGroupGuid}/StartAllMonitorAlertsStarts alerting for all monitors that are a member of the monitor group specified by the monitor group GUID
MonitorGroupApiMonitorGroupStartAllMonitorsInGroupPost /MonitorGroup/{monitorGroupGuid}/StartAllMonitorsStarts all monitors that are a member of the monitor group specified by the monitor group GUID
MonitorGroupApiMonitorGroupStopAllMonitorAlertsInGroupPost /MonitorGroup/{monitorGroupGuid}/StopAllMonitorAlertsStops alerting for all monitors that are a member of the monitor group specified by the monitor group GUID
MonitorGroupApiMonitorGroupStopAllMonitorsInGroupPost /MonitorGroup/{monitorGroupGuid}/StopAllMonitorsStops all monitors that are a member of the monitor group specified by the monitor group GUID
MonitorGroupApiMonitorGroupUpdateMonitorGroupPut /MonitorGroup/{monitorGroupGuid}Updates the monitor group with the Guid specified
OperatorApiOperatorAddDutyPeriodForOperatorPost /Operator/{operatorGuid}/DutyScheduleAdds a duty schedule to the specified operator.
OperatorApiOperatorCreateOperatorPost /OperatorCreates a new operator.
OperatorApiOperatorDeleteAuthorizationForOperatorDelete /Operator/{operatorGuid}/Authorization/{authorizationType}Removes the specified authorization of this operator.
OperatorApiOperatorDeleteDutyScheduleFromOperatorDelete /Operator/{operatorGuid}/DutySchedule/{dutyScheduleId}Deletes the specified duty schedule of the specified operator.
OperatorApiOperatorDeleteOperatorDelete /Operator/{operatorGuid}Deletes an existing operator.
OperatorApiOperatorGetAllOperatorsGet /OperatorGets a list of all operators.
OperatorApiOperatorGetAuthorizationsForOperatorGet /Operator/{operatorGuid}/AuthorizationGets all authorizations for the specified operator.
OperatorApiOperatorGetDutyScheduleForOperatorGet /Operator/{operatorGuid}/DutyScheduleGets the duty schedules for an specified operator.
OperatorApiOperatorGetOperatorGet /Operator/{operatorGuid}Gets the details of the operator with the provided OperatorGuid.
OperatorApiOperatorGetOperatorGroupsForOperatorGet /Operator/{operatorGuid}/OperatorGroupGets a list of all operator groups for the specified operator.
OperatorApiOperatorPostAuthorizationForOperatorPost /Operator/{operatorGuid}/Authorization/{authorizationType}Assigns the specified authorization to this operator.
OperatorApiOperatorUpdateDutyPeriodForOperatorPut /Operator/{operatorGuid}/DutySchedule/{dutyScheduleId}Updates the specified duty schedule of the specified operator.
OperatorApiOperatorUpdateOperatorPut /Operator/{operatorGuid}Updates an existing operator.
OperatorApiOperatorUpdateOperatorWithPatchPatch /Operator/{operatorGuid}Updates an existing operator.
OperatorGroupApiOperatorGroupAddDutyScheduleToAllMembersPost /OperatorGroup/{operatorGroupGuid}/DutySchedule/AddDutyScheduleForAllMembersAdds the provided duty schedule to all operators in the group specified
OperatorGroupApiOperatorGroupAddOperatorToOperatorGroupPost /OperatorGroup/{operatorGroupGuid}/Member/{operatorGuid}Adds the specified operator to the operator group
OperatorGroupApiOperatorGroupAllOperatorsInGroupOffDutyPost /OperatorGroup/{operatorGroupGuid}/AllOperatorsOffDutySet the OnDuty flag to off for all operators that are a member of the operator group specified by the operator group GUID
OperatorGroupApiOperatorGroupAllOperatorsInGroupOnDutyPost /OperatorGroup/{operatorGroupGuid}/AllOperatorsOnDutySet the OnDuty flag to on for all operators that are a member of the operator group specified by the operator group GUID
OperatorGroupApiOperatorGroupCreateOperatorGroupPost /OperatorGroupCreates a new operator group
OperatorGroupApiOperatorGroupDeleteAuthorizationForOperatorGroupDelete /OperatorGroup/{operatorGroupGuid}/Authorization/{authorizationType}Removes the specified authorization of the operator group.
OperatorGroupApiOperatorGroupDeleteOperatorGroupDelete /OperatorGroup/{operatorGroupGuid}Deletes the specified operator group
OperatorGroupApiOperatorGroupGetAllOperatorGroupsGet /OperatorGroupGets all operator groups
OperatorGroupApiOperatorGroupGetAuthorizationsForOperatorGroupGet /OperatorGroup/{operatorGroupGuid}/AuthorizationGets all authorizations for the specified operator group.
OperatorGroupApiOperatorGroupGetOperatorGroupGet /OperatorGroup/{operatorGroupGuid}Gets the details of a operator group
OperatorGroupApiOperatorGroupGetOperatorGroupMembersGet /OperatorGroup/{operatorGroupGuid}/MemberGets a list of all members of an operator group
OperatorGroupApiOperatorGroupPostAuthorizationForOperatorGroupPost /OperatorGroup/{operatorGroupGuid}/Authorization/{authorizationType}Assigns the specified authorization to the operator group.
OperatorGroupApiOperatorGroupRemoveOperatorFromOperatorGroupDelete /OperatorGroup/{operatorGroupGuid}/Member/{operatorGuid}Removes the specified operator from the operator group
OperatorGroupApiOperatorGroupUpdateOperatorGroupPut /OperatorGroup/{operatorGroupGuid}Updates the operator group with the Guid specified
OutgoingPhoneNumberApiOutgoingPhoneNumberGetAllOutgoingPhoneNumbersGet /OutgoingPhoneNumberGets a list of all outgoing phone numbers available.
PublicStatusPageApiPublicStatusPageAddAuthorizationToPublicStatusPagePost /PublicStatusPage/{publicStatusPageGuid}/AuthorizationCreates a new authorization for the specified public status page.
PublicStatusPageApiPublicStatusPageDeletePublicStatusPageDelete /PublicStatusPage/{publicStatusPageGuid}Deletes the definition of the specified public status page.
PublicStatusPageApiPublicStatusPageGetAuthorizationsForPublicStatusPageGet /PublicStatusPage/{publicStatusPageGuid}/AuthorizationReturns all authorizations for the specified public status page.
PublicStatusPageApiPublicStatusPageGetPublicStatusPageGet /PublicStatusPage/{publicStatusPageGuid}Returns the definition of the specified public status page.
PublicStatusPageApiPublicStatusPageGetPublicStatusPagesGet /PublicStatusPageReturns the definition of all public status pages available in the account.
PublicStatusPageApiPublicStatusPagePatchPublicStatusPagePatch /PublicStatusPage/{publicStatusPageGuid}Partially updates the definition of the specified public status page.
PublicStatusPageApiPublicStatusPagePostPublicStatusPagePost /PublicStatusPageCreates a new public status page.
PublicStatusPageApiPublicStatusPagePutPublicStatusPagePut /PublicStatusPage/{publicStatusPageGuid}Updates the definition of the specified public status page.
PublicStatusPageApiPublicStatusPageRemoveAuthorizationFromPublicStatusPageDelete /PublicStatusPage/{publicStatusPageGuid}/Authorization/{authorizationGuid}Removes an authorization from a public status page.
RUMApiRumGetRumMetricsForAllWebsitesGet /Rum/Website/MetricsReturns all metrics of all RUM websites.
RUMApiRumGetRumWebsiteMetricsGet /Rum/Website/{rumWebsiteGuid}/MetricsReturns all metrics of the specified RUM website.
RUMApiRumGetRumWebsitesGet /Rum/WebsiteReturns the definition of all RUM websites available in the account.
RegisterApiRegisterPostPost /RegisterCreates a new API account.
SLAApiSlaCreateSlaPost /SlaCreates a new SLA.
SLAApiSlaDeleteExclusionPeriodDelete /Sla/{slaGuid}/ExclusionPeriod/{exclusionPeriodId}Deletes the specified exclusion period for the specified SLA.
SLAApiSlaDeleteSlaDelete /Sla/{slaGuid}Deletes the specified SLA.
SLAApiSlaGetExclusionPeriodGet /Sla/{slaGuid}/ExclusionPeriod/{exclusionPeriodId}Gets the specified exclusion period for the specified SLA.
SLAApiSlaGetExclusionPeriodsGet /Sla/{slaGuid}/ExclusionPeriodGets a list of all exclusion periods for the specified SLA.
SLAApiSlaGetSlaGet /Sla/{slaGuid}Gets the specified SLA definition.
SLAApiSlaGetSlasGet /SlaGets a list of all SLA definitions.
SLAApiSlaPatchExclusionPeriodPatch /Sla/{slaGuid}/ExclusionPeriod/{exclusionPeriodId}Partially updates the specified exclusion period for the specified SLA.
SLAApiSlaPatchSlaPatch /Sla/{slaGuid}Partially updates the definition of the specified SLA.
SLAApiSlaPostExclusionPeriodPost /Sla/{slaGuid}/ExclusionPeriodCreates a new exclusion period for the specified SLA.
SLAApiSlaPutExclusionPeriodPut /Sla/{slaGuid}/ExclusionPeriod/{exclusionPeriodId}Updates the specified exclusion period for the specified SLA.
SLAApiSlaPutSlaPut /Sla/{slaGuid}Updates the definition of the specified SLA.
ScheduledReportApiScheduledReportCreateScheduledReportPost /ScheduledReportCreates a new scheduled report.
ScheduledReportApiScheduledReportDeleteSpecifiedScheduledReportDelete /ScheduledReport/{scheduledReportGuid}Delete the specified scheduled report.
ScheduledReportApiScheduledReportGetAllScheduledReportsGet /ScheduledReportReturns data for all scheduled reports.
ScheduledReportApiScheduledReportGetSpecifiedScheduledReportGet /ScheduledReport/{scheduledReportGuid}Returns data for the specified scheduled report.
ScheduledReportApiScheduledReportPartiallyUpdateScheduledReportPatch /ScheduledReport/{scheduledReportGuid}Partially update the specified scheduled report.
ScheduledReportApiScheduledReportUpdateScheduledReportPut /ScheduledReport/{scheduledReportGuid}Update the specified scheduled report.
StatisticsApiStatisticsGetMonitorGroupStatisticsGet /Statistics/MonitorGroup/{monitorGroupGuid}Gets the monitor group statistics.
StatisticsApiStatisticsGetMonitorStatisticsGet /Statistics/Monitor/{monitorGuid}Gets the monitor statistics.
StatusApiStatusGetMonitorGroupStatusGet /Status/MonitorGroup/{monitorGroupGuid}Gets a list of all monitor group status data.
StatusApiStatusGetMonitorStatusGet /Status/Monitor/{monitorGuid}Gets all monitor status data.
TimezoneApiTimezoneGetAllTimezonesGet /TimezoneGets all timezones available.
TimezoneApiTimezoneGetTimezoneByIdGet /Timezone/{timezoneId}Gets the timezone with the specified Id.
VaultApiVaultCreateAuthorizationForVaultSectionPost /VaultSection/{vaultSectionGuid}/AuthorizationCreates a new authorization for the specified vault section.
VaultApiVaultCreateNewVaultItemPost /VaultItemCreates a new vault item.
VaultApiVaultCreateNewVaultSectionPost /VaultSectionCreates a new vault section.
VaultApiVaultDeleteAuthorizationForVaultSectionDelete /VaultSection/{vaultSectionGuid}/Authorization/{authorizationGuid}Deletes the specified authorization for the specified vault section.
VaultApiVaultDeleteVaultItemDelete /VaultItem/{vaultItemGuid}Deletes the specified vault item.
VaultApiVaultDeleteVaultSectionDelete /VaultSection/{vaultSectionGuid}Deletes the specified vault section.
VaultApiVaultGetAllVaultItemsGet /VaultItemReturns all vault items.
VaultApiVaultGetAllVaultSectionsGet /VaultSectionReturns all vault sections.
VaultApiVaultGetAuthorizationsForVaultSectionGet /VaultSection/{vaultSectionGuid}/AuthorizationReturns all authorizations for the specified vault section.
VaultApiVaultGetVaultItemGet /VaultItem/{vaultItemGuid}Returns the specified vault item.
VaultApiVaultGetVaultSectionGet /VaultSection/{vaultSectionGuid}Returns the specified vault section.
VaultApiVaultPartiallyUpdateVaultItemPatch /VaultItem/{vaultItemGuid}Partially updates the specified vault item.
VaultApiVaultUpdateVaultItemPut /VaultItem/{vaultItemGuid}Updates the specified vault item.
VaultApiVaultUpdateVaultSectionPut /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

# Packages

No description provided by the author
No description provided by the author

# Functions

CacheExpires helper function to determine remaining time before repeating a request.
NewAPIClient creates a new API client.
No description provided by the author
No description provided by the author
No description provided by the author

# Constants

List of DnsQuery.
List of DnsQuery.
List of OperatorAuthorizationType.
List of OperatorAuthorizationType.
List of OperatorGroupAuthorizationType.
List of ThrottlingValue.
List of EscalationMode.
List of EscalationMode.
List of PresetPeriodType.
List of OperatorAuthorizationType.
List of SortOrderEnum.
List of SortDirection.
List of RumMetric.
List of ApiHttpAuthenticationType.
List of OperatorGroupAuthorizationType.
List of ThrottlingType.
List of SortOrderEnum.
List of ThrottlingValue.
List of VaultItemTypes.
List of VaultItemTypes.
List of VaultSectionAuthorizationType.
List of BrowserType.
List of BrowserType.
List of SubStepType.
List of DnsQuery.
List of ApiVariableSourceType.
List of LastErrorLevel.
List of MonitorType.
List of RumMetric.
List of SftpAction.
List of ErrorConditionType.
List of ErrorConditionType.
List of ApiVariableSourceType.
List of ApiComparisonType.
List of ApiVariableSourceType.
List of ErrorConditionType.
List of ApiVariableSourceType.
List of OperatorAuthorizationType.
List of MonitorGroupAuthorizationType.
List of OperatorAuthorizationType.
List of VaultItemTypes.
List of ApiVariableSourceType.
List of ErrorConditionType.
List of PresetPeriodType.
List of PresetPeriodType.
List of PresetPeriodType.
List of PresetPeriodType.
List of PresetPeriodType.
List of ScheduleType.
List of MsaStepType.
List of HttpMethods.
List of SortDirection.
List of MonitorMode.
List of ApiHttpAuthenticationType.
List of MaintenanceTypes.
List of MaintenanceTypes.
List of MonitorType.
List of RumMetric.
List of ApiComparisonType.
List of ApiComparisonType.
List of ApiComparisonType.
List of ErrorConditionType.
List of RumMetric.
List of ErrorConditionType.
List of SftpAction.
List of RumMetric.
List of ApiVariableSourceType.
List of BrowserType.
List of AlertDefinitionAuthorizationType.
List of IntegrationAuthorizationType.
List of MonitorAuthorizationType.
List of MonitorGroupAuthorizationType.
List of IntegrationTypeEnum.
List of ApiComparisonType.
List of ErrorConditionConsoleLevel.
List of ScheduledReportFileType.
List of ScheduledReportFileType.
List of ApiVariableSourceType.
List of ApiComparisonType.
List of ApiVariableSourceType.
List of ThrottlingValue.
List of CapabilityFilterEnum.
List of VaultItemTypes.
List of OperatorAuthorizationType.
List of ErrorConditionType.
List of DayOfWeek.
List of RumMetric.
List of MonitorType.
List of MonitorType.
List of IntegrationTypeEnum.
List of HttpMethod.
List of ApiComparisonType.
List of ApiComparisonType.
List of UserDefinedFunctionType.
List of HttpMethods.
List of CapabilityFilterEnum.
List of EngineHashAlgorithm.
List of EngineHashAlgorithm.
List of EngineHashAlgorithm.
List of SubStepType.
List of JwtAlgorithm.
List of JwtAlgorithm.
List of JwtAlgorithm.
List of ScheduledReportFileType.
List of MonitorType.
List of MsaStepType.
List of ErrorConditionType.
List of MonitorType.
List of MonitorType.
List of LastErrorLevel.
List of LastErrorLevel.
List of ErrorConditionConsoleLevel.
List of OperatorSetupMode.
List of IpVersion.
List of IpVersion.
List of CapabilityFilterEnum.
List of ApiComparisonType.
List of ApiComparisonType.
List of ApiComparisonType.
List of ApiComparisonType.
List of UserDefinedFunctionType.
List of UserDefinedFunctionType.
List of ErrorConditionType.
List of PresetPeriodType.
List of PresetPeriodTypeWithExclusive.
List of PresetPeriodType.
List of PresetPeriodTypeWithExclusive.
List of PresetPeriodType.
List of PresetPeriodTypeWithExclusive.
List of PresetPeriodType.
List of PresetPeriodTypeWithExclusive.
List of PresetPeriodType.
List of PresetPeriodTypeWithExclusive.
List of PresetPeriodType.
List of PresetPeriodTypeWithExclusive.
List of PresetPeriodType.
List of PresetPeriodTypeWithExclusive.
List of PresetPeriodType.
List of PresetPeriodTypeWithExclusive.
List of PresetPeriodType.
List of PresetPeriodTypeWithExclusive.
List of PresetPeriodType.
List of PresetPeriodTypeWithExclusive.
List of PresetPeriodType.
List of PresetPeriodTypeWithExclusive.
List of PresetPeriodType.
List of PresetPeriodTypeWithExclusive.
List of PresetPeriodType.
List of PresetPeriodTypeWithExclusive.
List of PresetPeriodType.
List of PresetPeriodTypeWithExclusive.
List of ApiComparisonType.
List of ApiComparisonType.
List of RumMetric.
List of ErrorConditionType.
List of ErrorConditionType.
List of OperatorSetupMode.
List of UserDefinedFunctionType.
List of EngineHashAlgorithm.
List of DayOfWeek.
List of ScheduleType.
List of MonitorType.
List of MonitorType.
List of DnsQuery.
List of MonitorType.
List of SubStepType.
List of RumMetric.
List of LastErrorLevel.
List of ApiVariableSourceType.
List of DnsQuery.
List of ApiHttpAuthenticationType.
List of AlertType.
List of ScheduleMode.
List of VaultItemTypes.
List of ErrorConditionType.
List of ErrorConditionType.
List of RumMetric.
List of RumMetric.
List of IntegrationTypeEnum.
List of HttpMethods.
List of ScheduledReportFileType.
List of ScheduledReportFileType.
List of IntegrationTypeEnum.
List of MonitorType.
List of MonitorType.
POST
List of HttpMethod.
List of SelectedPeriodType.
List of PresetPeriodType.
List of PresetPeriodType.
List of PresetPeriodType.
List of PresetPeriodType.
List of PresetPeriodType.
List of CapabilityFilterEnum.
List of MonitorMode.
List of HttpMethods.
List of ScheduleType.
List of MsaBodyType.
List of RumMetric.
List of RumMetric.
List of UserDefinedFunctionType.
List of AlertType.
List of RumMetric.
List of ErrorConditionType.
List of ApiVariableSourceType.
List of ApiVariableSourceType.
List of ApiVariableSourceType.
List of ApiVariableSourceType.
List of ApiVariableSourceType.
List of ApiVariableSourceType.
List of ApiVariableSourceType.
List of ApiVariableSourceType.
List of DnsQuery.
List of DayOfWeek.
List of SubStepType.
List of SubStepType.
List of SubStepType.
List of RumMetric.
List of SubStepType.
List of MonitorType.
List of HashAlgorithm.
List of HashAlgorithm.
List of HashAlgorithm.
List of OperatorAuthorizationType.
List of ApiComparisonType.
List of ThrottlingType.
List of IntegrationTypeEnum.
List of IntegrationTypeEnum.
List of SmsProvider.
List of SmsProvider.
List of SmsProvider.
List of SmsProvider.
List of MonitorType.
List of DnsQuery.
List of SelectedPeriodType.
List of DnsQuery.
List of MonitorMode.
List of IntegrationTypeEnum.
List of ApiVariableSourceType.
List of DayOfWeek.
List of SubStepType.
List of SubStepType.
List of OperatorAuthorizationType.
List of SubStepType.
List of SftpAction.
List of SftpAction.
List of DayOfWeek.
List of RumMetric.
List of ErrorConditionType.
List of ErrorConditionType.
List of TlsVersion.
List of TlsVersion.
List of TlsVersion.
List of TlsVersion.
List of TlsVersion.
List of TlsVersion.
List of TlsVersion.
List of ApiVariableSourceType.
List of ApiVariableSourceType.
List of ApiVariableSourceType.
List of ErrorConditionType.
List of ErrorConditionType.
List of ErrorConditionType.
List of MonitorType.
List of DayOfWeek.
List of DnsQuery.
List of LastErrorLevel.
List of RegisterStatus.
List of SmsProvider.
List of IntegrationAuthorizationType.
List of ErrorConditionType.
List of ApiVariableSourceType.
List of ApiVariableSourceType.
List of MsaBodyType.
List of MsaBodyType.
List of MonitorAuthorizationType.
List of MonitorAuthorizationType.
List of MonitorGroupAuthorizationType.
List of MonitorGroupAuthorizationType.
List of PSPAuthorizationType.
List of VaultSectionAuthorizationType.
List of SubStepType.
List of ErrorConditionConsoleLevel.
List of MonitorType.
List of MonitorType.
List of DayOfWeek.
List of ScheduleType.
List of ScheduleType.

# Variables

ContextAccessToken takes a string oauth2 access token as authentication for the request.
ContextAPIKey takes an APIKey as authentication for the request.
ContextBasicAuth takes BasicAuth as authentication for the request.
ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.

# Structs

No description provided by the author
No description provided by the author
Represents the values/results of a single check done by a monitor.
No description provided by the author
No description provided by the author
Alert attributes.
Alert type indicating if this was an Error or Ok alert.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Alert definition authorization.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Cursors can be used to navigate the dataset in a fixed manner.
No description provided by the author
No description provided by the author
APIClient manages communication with the Uptrends API v4 API v1.0.0 In most cases there should be only one, shared, APIClient.
No description provided by the author
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
No description provided by the author
No description provided by the author
Information about a single assertion.
No description provided by the author
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
No description provided by the author
No description provided by the author
No description provided by the author
Checkpoint.
No description provided by the author
No description provided by the author
Checkpoint attributes.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Checkpoint server attributes.
CheckpointsHealth.
No description provided by the author
Cursors can be used to navigate the dataset in a fixed manner.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The level of this error conditions (not used in all types).
The match type of this error conditions (not used in all types).
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GenericSwaggerError Provides access to the body, error and model on returned errors.
Http details attributes.
No description provided by the author
No description provided by the author
HttpEngineAttributes describes the attributes of a Multi-step Api monitor check.
Timing info.
No description provided by the author
HttpEngineStep describes the results of a step in a Multi-step Api monitor.
Results of the assertions in this step.
No description provided by the author
No description provided by the author
Alert definition authorization.
No description provided by the author
Type of Integration in Alert Definition Escalation Level.
Ipv6 address.
Links with reference to self and next data set.
No description provided by the author
No description provided by the author
Indicates whether, during the maintenance periods, only alerting will be disabled, or if the entire monitor will be stopped.
The schedule mode (one time, daily, weekly, monthly).
The weekday for this maintenance period (for weekly maintenance periods only).
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Monitor group authorization.
Represents the values/results of a single check done by a monitor.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Monitor check attributes.
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.
Response of the MonitorCheck endpoint.
Monitor group.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Monitor group authorization.
Monitor group member.
No description provided by the author
No description provided by the author
Monitor Status attributes.
The error level for the monitor status.
No description provided by the author
No description provided by the author
The resposne data/monitor checks.
Only valid for Transaction monitors: the data structure that specifies the transaction steps (and sub steps) to execute.
No description provided by the author
No description provided by the author
Determines what kind of body the request will have.
No description provided by the author
Operator.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The SMS provider used to send out SMS alerts.
No description provided by the author
Page element describes a page load/request (in a waterfall).
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The authorization type.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The requested time period.
The type of period.
ServerHealth.
The detailed status of the server.
ServerStatusDetails.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Object attributes.
No description provided by the author
Links with reference to self and next data set.
Meta data.
No description provided by the author
No description provided by the author
No description provided by the author
Time zone available in Uptrends.
No description provided by the author
No description provided by the author
No description provided by the author
Describes one step in a transaction.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
This property is not supported yet.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The certificate archive that is stored in this vault item, if applicable.
The file info that is stored in this vault item, if applicable.
The one-time password info that is stored in this vault item, if applicable.
The vault item type.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Metrics for describing the load cycle of the entire web page.
W3C Navigation Timing metrics.
No description provided by the author

# Type aliases

No description provided by the author
No description provided by the author
No description provided by the author
AlertDefinitionAuthorizationType :.
AlertType :.
ApiAssertionSourceType :.
ApiComparisonType :.
ApiHttpAuthenticationType :.
ApiVariableSourceType :.
BrowserType :.
CapabilityFilterEnum :.
No description provided by the author
No description provided by the author
DayOfWeek :.
DnsQuery :.
EngineHashAlgorithm :.
ErrorConditionConsoleLevel :.
The effect of this error conditions (not used in all types).
Error condition type.
ErrorConditionType :.
ErrorLevel :.
ErrorLevelFilter :.
EscalationMode :.
HashAlgorithm :.
HttpMethod :.
HttpMethods :.
No description provided by the author
IntegrationAuthorizationType :.
IntegrationTypeEnum :.
IpVersion :.
JwtAlgorithm :.
LastErrorLevel :.
MaintenanceTypes :.
No description provided by the author
MonitorAuthorizationType :.
No description provided by the author
No description provided by the author
MonitorGroupAuthorizationType :.
MonitorMode :.
No description provided by the author
MonitorType :.
MsaBodyType :.
MsaStepType :.
No description provided by the author
OperatorAuthorizationType :.
No description provided by the author
OperatorGroupAuthorizationType :.
OperatorScheduleMode :.
OperatorSetupMode :.
No description provided by the author
PresetPeriodType :.
PresetPeriodTypeWithExclusive :.
PspAuthorizationType :.
No description provided by the author
No description provided by the author
RegisterStatus :.
No description provided by the author
RumMetric : Defines a RUM metric.
No description provided by the author
ScheduledReportFileType : Scheduled report file type.
ScheduleMode :.
ScheduleType :.
SelectedPeriodType :.
SftpAction :.
No description provided by the author
SmsProvider :.
SortDirection :.
SortOrderEnum :.
No description provided by the author
No description provided by the author
SubStepType :.
ThrottlingType :.
ThrottlingValue :.
No description provided by the author
TlsVersion :.
UserDefinedFunctionType :.
No description provided by the author
VaultItemTypes :.
VaultSectionAuthorizationType :.