Skip to content

Files

Latest commit

 

History

History
473 lines (299 loc) · 19.6 KB

MonitorGroupApi.md

File metadata and controls

473 lines (299 loc) · 19.6 KB

\MonitorGroupApi

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

Method HTTP request Description
MonitorGroupAddMaintenancePeriodToAllMembers Post /MonitorGroup/{monitorGroupGuid}/AddMaintenancePeriodToAllMembers Adds the provided maintenance period to all monitors in the group specified
MonitorGroupAddMonitorToMonitorGroup Post /MonitorGroup/{monitorGroupGuid}/Member/{monitorGuid} Adds the specified monitor to the monitor group
MonitorGroupCreateAuthorizationForMonitorGroup Post /MonitorGroup/{monitorGroupGuid}/Authorizations Create monitor authorizations for monitor group If the wanted authorizations requires other authorizations, these will be added as well
MonitorGroupCreateMonitorGroup Post /MonitorGroup Creates a new monitor group
MonitorGroupDeleteAuthorizationForMonitorGroup Delete /MonitorGroup/{monitorGroupGuid}/Authorizations/{authorizationGuid} Delete monitor authorization for monitor group
MonitorGroupDeleteMonitorGroup Delete /MonitorGroup/{monitorGroupGuid} Deletes the specified monitor group
MonitorGroupGetAllMonitorGroups Get /MonitorGroup Gets all monitor groups
MonitorGroupGetAuthorizationsOfMonitorGroup Get /MonitorGroup/{monitorGroupGuid}/Authorizations Get monitor authorizations of monitor group
MonitorGroupGetMonitorGroup Get /MonitorGroup/{monitorGroupGuid} Gets the details of a monitor group
MonitorGroupGetMonitorGroupMembers Get /MonitorGroup/{monitorGroupGuid}/Member Gets a list of all members of a monitor group
MonitorGroupRemoveMonitorFromMonitorGroup Delete /MonitorGroup/{monitorGroupGuid}/Member/{monitorGuid} Removes the specified monitor from the monitor group
MonitorGroupStartAllMonitorAlertsInGroup Post /MonitorGroup/{monitorGroupGuid}/StartAllMonitorAlerts Starts alerting for all monitors that are a member of the monitor group specified by the monitor group GUID
MonitorGroupStartAllMonitorsInGroup Post /MonitorGroup/{monitorGroupGuid}/StartAllMonitors Starts all monitors that are a member of the monitor group specified by the monitor group GUID
MonitorGroupStopAllMonitorAlertsInGroup Post /MonitorGroup/{monitorGroupGuid}/StopAllMonitorAlerts Stops alerting for all monitors that are a member of the monitor group specified by the monitor group GUID
MonitorGroupStopAllMonitorsInGroup Post /MonitorGroup/{monitorGroupGuid}/StopAllMonitors Stops all monitors that are a member of the monitor group specified by the monitor group GUID
MonitorGroupUpdateMonitorGroup Put /MonitorGroup/{monitorGroupGuid} Updates the monitor group with the Guid specified

MonitorGroupAddMaintenancePeriodToAllMembers

MonitorGroupAddMaintenancePeriodToAllMembers(ctx, monitorGroupGuid, optional) Adds the provided maintenance period to all monitors in the group specified

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
monitorGroupGuid string
optional *MonitorGroupApiMonitorGroupAddMaintenancePeriodToAllMembersOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a MonitorGroupApiMonitorGroupAddMaintenancePeriodToAllMembersOpts struct

Name Type Description Notes

maintenancePeriod | optional.Interface of MaintenancePeriod| |

Return type

(empty response body)

Authorization

basicauth

HTTP request headers

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

MonitorGroupAddMonitorToMonitorGroup

MonitorGroupAddMonitorToMonitorGroup(ctx, monitorGroupGuid, monitorGuid) Adds the specified monitor to the monitor group

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
monitorGroupGuid string The Guid of the monitor group to add the monitor to
monitorGuid string The monitor Guid

Return type

(empty response body)

Authorization

basicauth

HTTP request headers

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

MonitorGroupCreateAuthorizationForMonitorGroup

[]MonitorGroupAuthorization MonitorGroupCreateAuthorizationForMonitorGroup(ctx, monitorGroupGuid, optional) Create monitor authorizations for monitor group If the wanted authorizations requires other authorizations, these will be added as well

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
monitorGroupGuid string The monitor group GUID
optional *MonitorGroupApiMonitorGroupCreateAuthorizationForMonitorGroupOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a MonitorGroupApiMonitorGroupCreateAuthorizationForMonitorGroupOpts struct

Name Type Description Notes

monitorGroupAuthorization | optional.Interface of MonitorGroupAuthorization| Authorization to add |

Return type

[]MonitorGroupAuthorization

Authorization

basicauth

HTTP request headers

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

MonitorGroupCreateMonitorGroup

MonitorGroup MonitorGroupCreateMonitorGroup(ctx, optional) Creates a new monitor group

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *MonitorGroupApiMonitorGroupCreateMonitorGroupOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a MonitorGroupApiMonitorGroupCreateMonitorGroupOpts struct

Name Type Description Notes
monitorGroup optional.Interface of MonitorGroup The MonitorGroup object to be created

Return type

MonitorGroup

Authorization

basicauth

HTTP request headers

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

MonitorGroupDeleteAuthorizationForMonitorGroup

MonitorGroupDeleteAuthorizationForMonitorGroup(ctx, monitorGroupGuid, authorizationGuid) Delete monitor authorization for monitor group

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
monitorGroupGuid string The monitor group GUID
authorizationGuid string The authorization GUID that needs to be deleted

Return type

(empty response body)

Authorization

basicauth

HTTP request headers

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

MonitorGroupDeleteMonitorGroup

MonitorGroupDeleteMonitorGroup(ctx, monitorGroupGuid) Deletes the specified monitor group

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
monitorGroupGuid string The Guid of the monitor group to be deleted

Return type

(empty response body)

Authorization

basicauth

HTTP request headers

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

MonitorGroupGetAllMonitorGroups

[]MonitorGroup MonitorGroupGetAllMonitorGroups(ctx, ) Gets all monitor groups

Required Parameters

This endpoint does not need any parameter.

Return type

[]MonitorGroup

Authorization

basicauth

HTTP request headers

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

MonitorGroupGetAuthorizationsOfMonitorGroup

[]MonitorGroupAuthorization MonitorGroupGetAuthorizationsOfMonitorGroup(ctx, monitorGroupGuid) Get monitor authorizations of monitor group

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
monitorGroupGuid string The monitor group GUID

Return type

[]MonitorGroupAuthorization

Authorization

basicauth

HTTP request headers

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

MonitorGroupGetMonitorGroup

MonitorGroup MonitorGroupGetMonitorGroup(ctx, monitorGroupGuid) Gets the details of a monitor group

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
monitorGroupGuid string The Guid of the monitor group to be retrieved

Return type

MonitorGroup

Authorization

basicauth

HTTP request headers

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

MonitorGroupGetMonitorGroupMembers

MonitorGroupMember MonitorGroupGetMonitorGroupMembers(ctx, monitorGroupGuid) Gets a list of all members of a monitor group

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
monitorGroupGuid string The Guid of the monitor group to retrieve the members for

Return type

MonitorGroupMember

Authorization

basicauth

HTTP request headers

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

MonitorGroupRemoveMonitorFromMonitorGroup

MonitorGroupRemoveMonitorFromMonitorGroup(ctx, monitorGroupGuid, monitorGuid) Removes the specified monitor from the monitor group

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
monitorGroupGuid string The Guid of the monitor group to remove the monitor from
monitorGuid string The monitor Guid to be removed

Return type

(empty response body)

Authorization

basicauth

HTTP request headers

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

MonitorGroupStartAllMonitorAlertsInGroup

MonitorGroupStartAllMonitorAlertsInGroup(ctx, monitorGroupGuid) Starts alerting for all monitors that are a member of the monitor group specified by the monitor group GUID

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
monitorGroupGuid string The monitor group GUID

Return type

(empty response body)

Authorization

basicauth

HTTP request headers

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

MonitorGroupStartAllMonitorsInGroup

MonitorGroupStartAllMonitorsInGroup(ctx, monitorGroupGuid) Starts all monitors that are a member of the monitor group specified by the monitor group GUID

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
monitorGroupGuid string The monitor group GUID

Return type

(empty response body)

Authorization

basicauth

HTTP request headers

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

MonitorGroupStopAllMonitorAlertsInGroup

MonitorGroupStopAllMonitorAlertsInGroup(ctx, monitorGroupGuid) Stops alerting for all monitors that are a member of the monitor group specified by the monitor group GUID

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
monitorGroupGuid string The monitor group GUID

Return type

(empty response body)

Authorization

basicauth

HTTP request headers

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

MonitorGroupStopAllMonitorsInGroup

MonitorGroupStopAllMonitorsInGroup(ctx, monitorGroupGuid) Stops all monitors that are a member of the monitor group specified by the monitor group GUID

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
monitorGroupGuid string The monitor group GUID

Return type

(empty response body)

Authorization

basicauth

HTTP request headers

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

MonitorGroupUpdateMonitorGroup

MonitorGroupUpdateMonitorGroup(ctx, monitorGroupGuid, optional) Updates the monitor group with the Guid specified

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
monitorGroupGuid string The Guid of the monitor group to be updated
optional *MonitorGroupApiMonitorGroupUpdateMonitorGroupOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a MonitorGroupApiMonitorGroupUpdateMonitorGroupOpts struct

Name Type Description Notes

monitorGroup | optional.Interface of MonitorGroup| The monitor group to be updated |

Return type

(empty response body)

Authorization

basicauth

HTTP request headers

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