Site24x7

App · 20 actions

Read monitor configuration, current status, outages, reports and alerting settings.

Actions

ActionWhat it does
Get availability summaryGet the availability summary of one monitor by its ID for a chosen report period, returning its uptime percentage, downtime and outage count.
Get current statusGet the current status of every monitor, returning whether each is up, down or in trouble, with its last check time.
Get monitorGet one monitor by its ID, returning its name, type, target, check frequency, locations and alert settings.
Get monitor groupGet one monitor group by its ID, returning its name, description and the monitors in it.
Get monitor outagesList the outages of one monitor by its ID for a chosen report period, returning each outage's start and end times, duration and reason.
Get userGet one user by their ID, returning their name, email address, role and alert settings.
Get user groupGet one user group by its ID, returning its name and members.
List business hoursList the business hours schedules, returning each one's ID, name and the days and times it covers.
List configuration rulesList the configuration rules that apply settings to new monitors automatically, returning each rule's ID and name.
List integrationsList the third party services alerts are sent to, such as Slack or PagerDuty, returning each one's ID, name and type.
List location profilesList the location profiles, returning each one's ID, name and the locations monitors are checked from.
List maintenanceList the scheduled maintenance windows, returning each one's ID, name, times and the monitors it covers.
List monitor groupsList the monitor groups, returning each group's ID, name and the monitors in it.
List monitorsList every Site24x7 monitor, returning each one's ID, name, type, target and check settings.
List notification profilesList the notification profiles, returning each one's ID, name and settings for when and how alerts are sent.
List outagesList outages across all monitors for a chosen report period, returning each outage's monitor, start and end times and reason.
List tagsList the tags used to label monitors, returning each tag's ID, name and value.
List threshold profilesList the threshold profiles, returning each one's ID, name, monitor type and the limits that trigger alerts.
List user groupsList the user groups alerts are sent to, returning each group's ID, name and members.
List usersList the users in your Site24x7 account, returning each user's ID, name, email address and role.

Get availability summary

Get the availability summary of one monitor by its ID for a chosen report period, returning its uptime percentage, downtime and outage count.

Inputs

Monitormonitor_idtextRequired
Monitor ID.
PeriodperiodtextRequired
Period.One of: 0 (Last hour), 1 (Last 24 hours), 2 (Last 7 days), 3 (Today), 4 (Yesterday), 5 (Last 30 days), 7 (Last month), 8 (This year), 9 (This quarter), 11 (This week), and 6 more.

Outputs

dataobject
Response.
Example output
{
  "data": {}
}

Get current status

Get the current status of every monitor, returning whether each is up, down or in trouble, with its last check time.

Inputs

None.

Outputs

dataobject
Response.
Example output
{
  "data": {}
}

Get monitor

Get one monitor by its ID, returning its name, type, target, check frequency, locations and alert settings.

Inputs

Monitormonitor_idtextRequired
Monitor ID.

Outputs

dataobject
Response.
Example output
{
  "data": {}
}

Get monitor group

Get one monitor group by its ID, returning its name, description and the monitors in it.

Inputs

Groupgroup_idtextRequired
Group ID.

Outputs

dataobject
Response.
Example output
{
  "data": {}
}

Get monitor outages

List the outages of one monitor by its ID for a chosen report period, returning each outage's start and end times, duration and reason.

Inputs

Monitormonitor_idtextRequired
Monitor ID.
PeriodperiodtextRequired
Period.One of: 1 (One day), 2 (One week), 5 (One month), 90 (Three months), 180 (Six months).

Outputs

dataobject
Response.
Example output
{
  "data": {}
}

Get user

Get one user by their ID, returning their name, email address, role and alert settings.

Inputs

Usertarget_user_idtextRequired
User ID.

Outputs

dataobject
Response.
Example output
{
  "data": {}
}

Get user group

Get one user group by its ID, returning its name and members.

Inputs

User groupuser_group_idtextRequired
User group ID.

Outputs

dataobject
Response.
Example output
{
  "data": {}
}

List business hours

List the business hours schedules, returning each one's ID, name and the days and times it covers.

Inputs

None.

Outputs

dataobject
Response.
Example output
{
  "data": {}
}

List configuration rules

List the configuration rules that apply settings to new monitors automatically, returning each rule's ID and name.

Inputs

None.

Outputs

dataobject
Response.
Example output
{
  "data": {}
}

List integrations

List the third party services alerts are sent to, such as Slack or PagerDuty, returning each one's ID, name and type.

Inputs

None.

Outputs

dataobject
Response.
Example output
{
  "data": {}
}

List location profiles

List the location profiles, returning each one's ID, name and the locations monitors are checked from.

Inputs

None.

Outputs

dataobject
Response.
Example output
{
  "data": {}
}

List maintenance

List the scheduled maintenance windows, returning each one's ID, name, times and the monitors it covers.

Inputs

None.

Outputs

dataobject
Response.
Example output
{
  "data": {}
}

List monitor groups

List the monitor groups, returning each group's ID, name and the monitors in it.

Inputs

None.

Outputs

dataobject
Response.
Example output
{
  "data": {}
}

List monitors

List every Site24x7 monitor, returning each one's ID, name, type, target and check settings.

Inputs

None.

Outputs

dataobject
Response.
Example output
{
  "data": {}
}

List notification profiles

List the notification profiles, returning each one's ID, name and settings for when and how alerts are sent.

Inputs

None.

Outputs

dataobject
Response.
Example output
{
  "data": {}
}

List outages

List outages across all monitors for a chosen report period, returning each outage's monitor, start and end times and reason.

Inputs

PeriodperiodtextRequired
Period.One of: 1 (One day), 2 (One week), 5 (One month), 90 (Three months), 180 (Six months).

Outputs

dataobject
Response.
Example output
{
  "data": {}
}

List tags

List the tags used to label monitors, returning each tag's ID, name and value.

Inputs

None.

Outputs

dataobject
Response.
Example output
{
  "data": {}
}

List threshold profiles

List the threshold profiles, returning each one's ID, name, monitor type and the limits that trigger alerts.

Inputs

None.

Outputs

dataobject
Response.
Example output
{
  "data": {}
}

List user groups

List the user groups alerts are sent to, returning each group's ID, name and members.

Inputs

None.

Outputs

dataobject
Response.
Example output
{
  "data": {}
}

List users

List the users in your Site24x7 account, returning each user's ID, name, email address and role.

Inputs

None.

Outputs

dataobject
Response.
Example output
{
  "data": {}
}

On this page