AlertSite Management API Reference

Last modified on August 24, 2020

AlertSite Management API provides the following operations.

Access tokens

Operation Description
POST /access-tokens Get an access token to authenticate other API requests.

Blackouts

Use the following operations to manage monitor blackouts and recipient blackouts:

Operation Description
GET /blackouts Get all existing monitor blackouts and recipient blackouts, optionally filtered by type or associated monitor or recipient.
POST /blackouts Create a new monitor blackout or recipient blackout.
GET /blackouts/{id} Get a single blackout by ID.
PATCH /blackouts/{id} Modify a recurring blackout.
DELETE /blackouts/{id} Delete a blackout.
POST /blackouts/bulk-edit Bulk edit monitor blackouts.

Monitors

Use the following operations to manage monitor configurations:

Operation Description
GET /monitors Get all existing monitors and their settings.
GET /monitors/{id} Get a single monitor by ID.
DELETE /monitors/{id} Delete a monitor.
POST /monitors/website Create a new website monitor for http:// URLs.
PATCH /monitors/website/{id}

Modify a website monitor for http:// URLs.

POST /monitors/website-ssl Create a new website monitor for https:// URLs.
PATCH /monitors/website-ssl/{id}

Modify a website monitor for https:// URLs.

POST /monitors/dejaclick Create a new DéjàClick monitor.
PATCH /monitors/dejaclick/{id} Modify a DéjàClick monitor.
POST /monitors/api Create a new SoapUI monitor.
PATCH /monitors/api/{id} Modify a SoapUI monitor.
PATCH /monitors/selenium/{id} Modify a Selenium monitor.
POST /monitors/tcp Create a new TCP monitor.
PATCH /monitors/tcp/{id} Modify a TCP monitor.
POST /monitors/ping Create a new Ping monitor.
PATCH /monitors/ping/{id} Modify a Ping monitor.
POST /monitors/ftp Create a new FTP monitor.
PATCH /monitors/ftp/{id} Modify an FTP monitor.
POST /monitors/ftp-ssl Create a new FTPS monitor.
PATCH /monitors/ftp-ssl/{id} Modify an FTPS monitor.
POST /monitors/email-imap Create a new IMAP email monitor.
PATCH /monitors/email-imap/{id} Modify an IMAP email monitor.
POST /monitors/email-pop Create a new POP email monitor.
PATCH /monitors/email-pop/{id} Modify a POP email monitor.
POST /monitors/email-smtp Create a new SMTP email monitor.
PATCH /monitors/email-smtp/{id} Modify an SMTP email monitor.
POST /monitors/email-round-trip Create a new SMTP email monitor.
PATCH /monitors/email-round-trip/{id} Modify a round-trip email monitor.
POST /monitors/name-server Create a new DNS monitor.
PATCH /monitors/name-server/{id} Modify a DNS email monitor.
POST /monitors/website-api Create an API endpoint monitor.
PATCH /monitors/website-api Edit an API endpoint monitor.
POST /monitors/website-ssl-api Create an API endpoint monitor.
PATCH /monitors/website-ssl-api Edit an API endpoint monitor.
PATCH /monitors/website-api/{id}/convert-api Convert an API endpoint monitor to a SoapUI monitor.
PATCH /monitors/website-ssl-api/{id}/convert-api Convert an API endpoint monitor to a SoapUI monitor.
POST /monitors/perfecto Create a Perfecto monitor.
PATCH /monitors/perfecto Edit a Perfecto monitor.

Custom properties

Use these operations to manage custom properties that can be used in your AlertSite monitors:

Operation Description
GET /properties Get the names and possible values of all custom properties defined in your AlertSite account.
GET /properties/{id} Get the name and possible values of a single property.
POST /property Create a new custom property.
PATCH /properties/{id} Update the name or possible values of a specific property.
DELETE /properties/{id} Delete a custom property.

Alert recipients

Use these operations to create and manage alert recipients:

Operation Description
GET /recipients Get all alert recipients optionally filtered by type or alerting method.
POST /recipients Create a new recipient.
GET /recipients/{id} Get a recipient by ID.
PATCH /recipients/{id} Modify recipient configurations.
DELETE /recipients/{id} Delete a recipient.

Recipient groups

Use these operations to create and manage recipient groups:

Operation Description
GET /notifier-groups Get all existing recipient groups or just those containing a specific monitor or recipient.
POST /notifier-groups Create a new recipient group.
GET /notifier-groups/{id} Get a recipient group by ID.
PATCH /notifier-groups/{id} Modify a recipient group.
DELETE /notifier-groups/{id} Delete a recipient group.

Performance alerts

Use these operations to configure performance alerts:

Operation Description
GET /perf-alerts Get the performance alert configuration for all monitors.
POST /perf-alerts Configure performance alerts for a monitor, specific monitor step, or ContentView.
GET /perf-alerts/{id} Get the performance alert configuration for a specific monitor or ContentView.
GET /perf-alerts/{id}/{step_number} Get the performance alert configuration for a specific monitor step.
PATCH /perf-alerts/{id}/{step_number} Modify the performance alert configuration for a monitor, specific monitor step, or ContentView.
DELETE /perf-alerts/{id}/{step_number} Delete the performance alert configuration for a monitor, specific monitor step, or ContentView.

Service-level agreements (SLAs)

Use the following operations to create and manage SLAs:

Operation Description
GET /slas Get all service-level agreements (SLAs) or get the SLA for the specified monitor ID.
POST /slas Create a new SLA.
GET /slas/{id} Get an SLA by ID.
PATCH /slas/{id} Modify an SLA.
DELETE /slas/{id} Delete an SLA.
POST /slas/bulk-edit Bulk edit SLAs.

Test alerts

Operation Description
POST /test-notifiers Send a test alert.

Test on demand

Use these operations to run tests on demand:

Operation Description
GET /tests Run a test on demand.
GET /tests/{id} Check the progress of a test on demand.

Reports

Operation Description
GET /report-sitestatus Get the Site Status report data for the specified monitors.

See Also

AlertSite Management API

Highlight search results