POST apioauth/matrixv2/services/{serviceId}/voltagealerts
Create a voltage alert for a service
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
serviceId |
The id of the service |
unsigned integer |
Required |
Body Parameters
A CreateVoltageAlertRequest
CreateVoltageAlertRequestName | Description | Type | Additional information |
---|---|---|---|
Title |
The alert title |
string |
None. |
Message |
The alert message |
string |
None. |
VoltageThreshold |
The value the alert will be triggered on |
decimal number |
None. |
PushNotificationEnabled |
If you want mobile push notifications sent on alert |
boolean |
None. |
InboxMessageEnabled |
If you want an inbox message sent on alert |
boolean |
None. |
EmailEnabled |
If you want emails sent on alert |
boolean |
None. |
Request Formats
application/json, text/json
Sample:
{ "Title": "sample string 1", "Message": "sample string 2", "VoltageThreshold": 3.1, "PushNotificationEnabled": true, "InboxMessageEnabled": true, "EmailEnabled": true }
application/xml, text/xml
Sample:
<CreateVoltageAlertRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Title>sample string 1</Title> <Message>sample string 2</Message> <VoltageThreshold>3.1</VoltageThreshold> <PushNotificationEnabled>true</PushNotificationEnabled> <InboxMessageEnabled>true</InboxMessageEnabled> <EmailEnabled>true</EmailEnabled> </CreateVoltageAlertRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
A 200 on success
HttpResponseMessageName | Description | Type | Additional information |
---|---|---|---|
Version | Version |
None. |
|
Content | HttpContent |
None. |
|
StatusCode | HttpStatusCode |
None. |
|
ReasonPhrase | string |
None. |
|
Headers | Collection of Object |
None. |
|
RequestMessage | HttpRequestMessage |
None. |
|
IsSuccessStatusCode | boolean |
None. |