Alerting API

• Alert policy endpoint

  • List Methods
  • Expand Methods

  • POSTCreate a new Alert policy/alert/1.0/policy
    Creates a new Alert policy
    
    

    Input Variables:

    
    

    Parameter	Value	Type	Description
    name		string	The name of the alert policy
    emailAddresses		list	An array of comma-separated email addresses associated with the alert policy (e.g. ["alert@mycompany.com","myemail@gmail.com"].
    sms		list	An array of comma-separated phone numbers associated with the alert policy (e.g. ["15132789346","15132789643"].
    strikesType	N-strikes (same location)N-strikes (different locations)	enumerated	The strike type for the alert policy
    strikes	1234	enumerated	The number of strikes before triggering an alert. Maximum number of strikes for 'N-strikes(same location)' is 3.
    threshold	101520	enumerated	Limit of continuous error samples to be considered for alerting since the first alert. On reaching the limit email and sms alerts will be suppressed until recovery.
    description		string	A description for the alert policy

    
    

    Output Variables:

    Variable	Possible Values	Description
    name	string	The name of the alert policy
    emailAddresses	A list of strings	The email addresses associated with the alert policy
    sms	A list of strings	The phone numbers associated with the alert policy
    description	string	The description of the alert policy
    strikesType	string	The strike type of the alert policy
    strikes	integer	The number of strikes for the alert policy
    threshold	integer	The threshold associated with the alert policy

    
    
  • GETGet List of Alert Policies/alert/1.0/policy
    Retrieves a list of policies ordered by date in descending order.
    
    
    

    Output Variables:

    Variable	Possible Values	Description
    id	long	The ID of the alert policy
    name	string	The name of the alert policy
    emailAddresses	A list of strings	The email addresses associated with the alert policy
    sms	A list of strings	The phone numbers associated with the alert policy
    description	string	The description of the alert policy
    strikesType	string	The Strike type of the alert policy
    strikes	integer	The number of strikes before triggering an alert.
    advancedEdit	boolean	This flag will return true if the policy is an Advanced Alert Policy
    threshold	integer	The threshold associated with the alert policy

    
    
  • POSTUpload a Data File/alert/1.0/file
    Uploads a Data file and returns a unique FileId of the newly uploaded file along with date_time created, content type and name of the Data file
    
    

    Input Variables:

    
    

    Parameter	Value	Type	Description
    fileUpload		file	The data file being upload.

    
    

    Output Variables:

    Variable	Possible Values	Description
    id	string	The ID of the Data file
    name	string	The name of the Data file uploaded
    contentType	String	The content type of the data file uploaded
    created	String	The date on which the dataFile is created
    fileUrl	String	link to view file in a new page. Use the link [https://alert.ultrawpm.com/:fileUrl]

    
    
  • GETGet a Data File/alert/1.0/file/:fileId
    Get the data file for given FileId where, FileId is the unique identifier for each file that is auto generated while uploading a data-file. Please use the 'Get a list of Data Files' API to get the FileId that you need. The content of the Data file is shown only for files with .txt, .js, .json, .csv extensions, other files will have content represented as null.
    
    

    Input Variables:

    URL Variable	Value
    fileId

    
    
    

    Output Variables:

    Variable	Possible Values	Description
    id	string	The ID of the Data file
    name	string	The name of the Data file uploaded
    contentType	String	The content type of the data file uploaded
    FileContent	String	The content is only shown for files with .txt, .js, .json, .csv extensions

    
    
  • GETGet a list of Data Files/alert/1.0/file
    Retrieves a list of data files
    
    
    

    Output Variables:

    Variable	Possible Values	Description
    id	string	The ID of the Data file
    name	string	The name of the Data file uploaded
    contentType	String	The content type of the data file uploaded
    created	String	The date on which the dataFile is created
    modified	String	The date on which the dataFile is last updated
    fileEdit	String	True for files with .txt, .js, .json, .csv extensions and their content can be seen in the 'Get a Data File' API
    fileUrl	String	link to view file in a new page. Use the link [https://alert.ultrawpm.com/:fileUrl]

    
    
  • DELETEDelete a Data File/alert/1.0/file/:fileId
    Delete the data file for given FileId where, FileId is the unique identifier for each file that is auto generated while uploading a data-file. Please use the 'Get a list of Data Files' API to get the FileId that you need.
    
    

    Input Variables:

    URL Variable	Value
    fileId

    
    
    
  • PUTUpdate a Data File/alert/1.0/editFile/:fileId
    Update the data file for given FileId where, FileId is the unique identifier for each file that is auto generated while uploading a data-file. Please use the 'Get a list of Data Files' API to get the FileId that you need. The uploaded file name and content type should match that of the existing Data file associated with the given FileId.
    
    

    Input Variables:

    URL Variable	Value
    fileId

    
    

    Parameter	Value	Type	Description
    fileUpload		file	The data file being upload.