JSON API » alerts » alerts/import

Imports alerts from a CSV file.

Input parameters

Requires authentication and the administrator role privilege.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
csvStringThe contents of the CSV file.Yes
customerIntegerID of customer to import into.NoCustomer of authentication user.
deleteInteger1 to delete all alerts first, 0 not to.No0
overwriteInteger1 to allow overwriting of existing alerts, 0 not to.No0

Responses

CodeDescription
200Success.
400Invalid input parameters specified. Check the key and message fields for more details.
401The authentication details provided are invalid.
402Your role does not allow this.
403Your rate plan does not allow this.
500An internal error occurred. Check the key and message fields for more details.

Data returned

The number of alerts created.

Example: With required parameters (csv field omitted for brevity)

http://enswitch.example.com/api/json/alerts/import/?auth_username=user;auth_password=password;csv=...

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "count":123 } }

Change history

VersionChanges
3.13Function added.