All URIs are relative to https://api.uptrends.com/v4
| Method | HTTP request | Description |
|---|---|---|
| MonitorCleanupMaintenancePeriods | Post /Monitor/{monitorGuid}/MaintenancePeriod/Cleanup/{beforeDate} | Clears out all one-time maintenance periods for the specified monitor older than the specified date |
| MonitorCloneMonitor | Post /Monitor/{monitorGuid}/Clone | Creates a clone (duplicate) of the specified monitor. |
| MonitorCreateAuthorizationForMonitor | Post /Monitor/{monitorGuid}/Authorizations | Create monitor authorizations for monitor If the wanted authorizations requires other authorizations, these will be added as well |
| MonitorCreateMaintenancePeriodForMonitor | Post /Monitor/{monitorGuid}/MaintenancePeriod | Saves the new maintenance period provided for the specified monitor |
| MonitorDeleteAuthorizationForMonitorGroup | Delete /Monitor/{monitorGuid}/Authorizations/{authorizationGuid} | Delete monitor authorization for monitor |
| MonitorDeleteMaintenancePeriodFromMonitor | Delete /Monitor/{monitorGuid}/MaintenancePeriod/{maintenancePeriodId} | Deletes the specified maintenance period from the specified monitor |
| MonitorDeleteMonitor | Delete /Monitor/{monitorGuid} | Deletes the specified monitor. |
| MonitorGetAllMaintenancePeriodsForMonitor | Get /Monitor/{monitorGuid}/MaintenancePeriod | Finds all maintenance periods for a monitor. |
| MonitorGetAuthorizationsOfMonitor | Get /Monitor/{monitorGuid}/Authorizations | Get monitor authorizations of monitor |
| MonitorGetMonitor | Get /Monitor/{monitorGuid} | Returns the definition of the specified monitor. |
| MonitorGetMonitorGroups | Get /Monitor/{monitorGuid}/MonitorGroup | Returns the Guid of each monitor group where the specified monitor is a member of. |
| MonitorGetMonitors | Get /Monitor | Returns the definition of all monitors available in the account. |
| MonitorGetMonitorsByMonitorGroup | Get /Monitor/MonitorGroup/{monitorGroupGuid} | Returns the definition of all monitors available in the account that are a member of the specified monitor group. |
| MonitorPatchMonitor | Patch /Monitor/{monitorGuid} | Partially updates the definition of the specified monitor. |
| MonitorPostMonitor | Post /Monitor | Creates a new monitor. |
| MonitorPutMonitor | Put /Monitor/{monitorGuid} | Updates the definition of the specified monitor. |
| MonitorUpdateMaintenancePeriodForMonitor | Put /Monitor/{monitorGuid}/MaintenancePeriod/{maintenancePeriodId} | Updates the specified maintenance schedule for the specified monitor |
MonitorCleanupMaintenancePeriods(ctx, monitorGuid, beforeDate) Clears out all one-time maintenance periods for the specified monitor older than the specified date
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| monitorGuid | string | ||
| beforeDate | interface{} | A string representing the date, formatted as "yyyy-MM-dd" |
(empty response body)
- Content-Type: application/json, application/xml
- Accept: application/json, application/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Monitor MonitorCloneMonitor(ctx, monitorGuid, optional) Creates a clone (duplicate) of the specified monitor.
Upon creation, the new monitor will be inactive. This allows you to make the necessary changes before you activate it. All other settings will be transferred to the new monitor as-is.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| monitorGuid | string | The guid of the monitor you want to clone. | |
| optional | *MonitorApiMonitorCloneMonitorOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a MonitorApiMonitorCloneMonitorOpts struct
| Name | Type | Description | Notes |
|---|
includeMaintenancePeriods | optional.Bool| Whether or not to also copy the maintenance periods into the clone. | [default to true] includeMonitorGroups | optional.Bool| Whether or not to also copy the monitor group memberships into the clone. | [default to true]
- Content-Type: application/json, application/xml
- Accept: application/json, application/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]MonitorAuthorization MonitorCreateAuthorizationForMonitor(ctx, monitorGuid, optional) Create monitor authorizations for monitor If the wanted authorizations requires other authorizations, these will be added as well
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| monitorGuid | string | The monitor GUID | |
| optional | *MonitorApiMonitorCreateAuthorizationForMonitorOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a MonitorApiMonitorCreateAuthorizationForMonitorOpts struct
| Name | Type | Description | Notes |
|---|
monitorAuthorization | optional.Interface of MonitorAuthorization| Authorization to add |
- Content-Type: application/json, application/xml
- Accept: application/json, application/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
MaintenancePeriod MonitorCreateMaintenancePeriodForMonitor(ctx, monitorGuid, optional) Saves the new maintenance period provided for the specified monitor
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| monitorGuid | string | ||
| optional | *MonitorApiMonitorCreateMaintenancePeriodForMonitorOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a MonitorApiMonitorCreateMaintenancePeriodForMonitorOpts struct
| Name | Type | Description | Notes |
|---|
maintenancePeriod | optional.Interface of MaintenancePeriod| |
- Content-Type: application/json, application/xml
- Accept: application/json, application/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
MonitorDeleteAuthorizationForMonitorGroup(ctx, monitorGuid, authorizationGuid) Delete monitor authorization for monitor
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| monitorGuid | string | The monitor GUID | |
| authorizationGuid | string | The authorization GUID that needs to be deleted |
(empty response body)
- Content-Type: application/json, application/xml
- Accept: application/json, application/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
MonitorDeleteMaintenancePeriodFromMonitor(ctx, monitorGuid, maintenancePeriodId) Deletes the specified maintenance period from the specified monitor
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| monitorGuid | string | ||
| maintenancePeriodId | int32 |
(empty response body)
- Content-Type: application/json, application/xml
- Accept: application/json, application/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
MonitorDeleteMonitor(ctx, monitorGuid) Deletes the specified monitor.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| monitorGuid | string | The guid of the monitor you want to delete. |
(empty response body)
- Content-Type: application/json, application/xml
- Accept: application/json, application/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]MaintenancePeriod MonitorGetAllMaintenancePeriodsForMonitor(ctx, monitorGuid) Finds all maintenance periods for a monitor.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| monitorGuid | string | The guid of the monitor you want to find the maintenance periods of. |
- Content-Type: application/json, application/xml
- Accept: application/json, application/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]MonitorAuthorization MonitorGetAuthorizationsOfMonitor(ctx, monitorGuid) Get monitor authorizations of monitor
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| monitorGuid | string | The monitor GUID |
- Content-Type: application/json, application/xml
- Accept: application/json, application/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Monitor MonitorGetMonitor(ctx, monitorGuid, optional) Returns the definition of the specified monitor.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| monitorGuid | string | The Guid of the requested monitor. | |
| optional | *MonitorApiMonitorGetMonitorOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a MonitorApiMonitorGetMonitorOpts struct
| Name | Type | Description | Notes |
|---|
filter | optional.String| Provide the option to only retrieve the requested fields. E.g. "Name,IsActive". |
- Content-Type: application/json, application/xml
- Accept: application/json, application/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]string MonitorGetMonitorGroups(ctx, monitorGuid) Returns the Guid of each monitor group where the specified monitor is a member of.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| monitorGuid | string | The Guid of the requested monitor. |
[]string
- Content-Type: application/json, application/xml
- Accept: application/json, application/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]Monitor MonitorGetMonitors(ctx, optional) Returns the definition of all monitors available in the account.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *MonitorApiMonitorGetMonitorsOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a MonitorApiMonitorGetMonitorsOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| filter | optional.String | Provide the option to only retrieve the requested fields. E.g. "Name,IsActive". |
- Content-Type: application/json, application/xml
- Accept: application/json, application/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]Monitor MonitorGetMonitorsByMonitorGroup(ctx, monitorGroupGuid, optional) Returns the definition of all monitors available in the account that are a member of the specified monitor group.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| monitorGroupGuid | string | The Guid of the requested monitor group to retrieve the monitors of. | |
| optional | *MonitorApiMonitorGetMonitorsByMonitorGroupOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a MonitorApiMonitorGetMonitorsByMonitorGroupOpts struct
| Name | Type | Description | Notes |
|---|
filter | optional.String| Provide the option to only retrieve the requested fields. E.g. "Name,IsActive". |
- Content-Type: application/json, application/xml
- Accept: application/json, application/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
MonitorPatchMonitor(ctx, monitorGuid, optional) 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.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| monitorGuid | string | The Guid of the monitor that should be updated. | |
| optional | *MonitorApiMonitorPatchMonitorOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a MonitorApiMonitorPatchMonitorOpts struct
| Name | Type | Description | Notes |
|---|
monitor | optional.Interface of Monitor| The partial definition for the monitor that should be updated. |
(empty response body)
- Content-Type: application/json, application/xml
- Accept: application/json, application/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Monitor MonitorPostMonitor(ctx, optional) Creates a new monitor.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *MonitorApiMonitorPostMonitorOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a MonitorApiMonitorPostMonitorOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| monitor | optional.Interface of Monitor | The complete definition of the monitor that should be created. |
- Content-Type: application/json, application/xml
- Accept: application/json, application/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
MonitorPutMonitor(ctx, monitorGuid, optional) 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.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| monitorGuid | string | The Guid of the monitor that should be updated. | |
| optional | *MonitorApiMonitorPutMonitorOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a MonitorApiMonitorPutMonitorOpts struct
| Name | Type | Description | Notes |
|---|
monitor | optional.Interface of Monitor| The complete definition for the monitor that should be updated. |
(empty response body)
- Content-Type: application/json, application/xml
- Accept: application/json, application/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
MonitorUpdateMaintenancePeriodForMonitor(ctx, monitorGuid, maintenancePeriodId, optional) Updates the specified maintenance schedule for the specified monitor
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| monitorGuid | string | ||
| maintenancePeriodId | int32 | ||
| optional | *MonitorApiMonitorUpdateMaintenancePeriodForMonitorOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a MonitorApiMonitorUpdateMaintenancePeriodForMonitorOpts struct
| Name | Type | Description | Notes |
|---|
maintenancePeriod | optional.Interface of MaintenancePeriod| |
(empty response body)
- Content-Type: application/json, application/xml
- Accept: application/json, application/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]