Opsgenie (version v2.*.*)

acknowledge_alert#

Acknowledges alert with given identifier

Parameters

identifier (required)#

Identifier of alert which could be alert id, tiny id or alert alias

Type: string

$body#

Request payload of acknowledging alert action

Type: object

{
  "note" : "Additional note that will be added while creating the alert",
  "source" : "Source field of the alert. Default value is IP address of the incoming request",
  "user" : "Display name of the request owner"
}

identifierType#

Type of the identifier that is provided as an in-line parameter. Possible values are 'id', 'alias' or 'tiny'

Type: string

Potential values: id, alias, tiny

add_details#

Add details to the alert with given identifier

Parameters

identifier (required)#

Identifier of alert which could be alert id, tiny id or alert alias

Type: string

$body#

Request payload of adding alert details action

Type: object

{
  "note" : "Additional note that will be added while creating the alert",
  "source" : "Source field of the alert. Default value is IP address of the incoming request",
  "user" : "Display name of the request owner",
  "details" : "Key-value pairs to add as custom property into alert. You can refer here for example values"
}

identifierType#

Type of the identifier that is provided as an in-line parameter. Possible values are 'id', 'alias' or 'tiny'

Type: string

Potential values: id, alias, tiny

add_note#

Adds note to alert with given identifier

Parameters

identifier (required)#

Identifier of alert which could be alert id, tiny id or alert alias

Type: string

$body#

Request payload of adding note to alert action

Type: object

{
  "note" : "Additional note that will be added while creating the alert",
  "source" : "Source field of the alert. Default value is IP address of the incoming request",
  "user" : "Display name of the request owner"
}

identifierType#

Type of the identifier that is provided as an in-line parameter. Possible values are 'id', 'alias' or 'tiny'

Type: string

Potential values: id, alias, tiny

add_responder#

Add responder to alert with given identifier

Parameters

identifier (required)#

Identifier of alert which could be alert id, tiny id or alert alias

Type: string

$body#

Request payload of adding responder to alert action

Type: object

{
  "note" : "Additional note that will be added while creating the alert",
  "responder" : {
    "id" : "string",
    "type" : "Required string. Possible values: all | none | user | escalation | schedule | team | group"
  },
  "source" : "Source field of the alert. Default value is IP address of the incoming request",
  "user" : "Display name of the request owner"
}

identifierType#

Type of the identifier that is provided as an in-line parameter. Possible values are 'id', 'alias' or 'tiny'

Type: string

Potential values: id, alias, tiny

add_responder_to_incident#

Add responder to incident with given identifier

Parameters

identifier (required)#

Identifier of incident which could be incident id or tiny id

Type: string

$body#

Type: object

{
  "note" : "Additional incident note to add.",
  "responder" : [ {
    "name" : "string",
    "id" : "string",
    "type" : "Required string. Possible values: user | team",
    "username" : "string"
  } ]
}

identifierType#

Type of the identifier that is provided as an in-line parameter. Possible values are 'id' or 'tiny. Default is id'

Type: string

Potential values: id, tiny

add_tags#

Add tags to the alert with given identifier

Parameters

identifier (required)#

Identifier of alert which could be alert id, tiny id or alert alias

Type: string

$body#

Request payload of creating alert tags action

Type: object

{
  "note" : "Additional note that will be added while creating the alert",
  "source" : "Source field of the alert. Default value is IP address of the incoming request",
  "user" : "Display name of the request owner",
  "tags" : [ "string" ]
}

identifierType#

Type of the identifier that is provided as an in-line parameter. Possible values are 'id', 'alias' or 'tiny'

Type: string

Potential values: id, alias, tiny

add_team#

Add team to alert with given identifier

Parameters

identifier (required)#

Identifier of alert which could be alert id, tiny id or alert alias

Type: string

$body#

Request payload of adding team to alert action

Type: object

{
  "note" : "Additional note that will be added while creating the alert",
  "source" : "Source field of the alert. Default value is IP address of the incoming request",
  "user" : "Display name of the request owner",
  "team" : {
    "id" : "string",
    "type" : "Required string. Possible values: all | none | user | escalation | schedule | team | group",
    "name" : "string"
  }
}

identifierType#

Type of the identifier that is provided as an in-line parameter. Possible values are 'id', 'alias' or 'tiny'

Type: string

Potential values: id, alias, tiny

add_team_member#

Adds a member to team with given identifier

Parameters

identifier (required)#

Identifier of the team

Type: string

$body#

Request payload of added team member

Type: object

{
  "role" : "Member role of the user, consisting 'user', 'admin' or a custom team role. Default value is 'user'",
  "user" : {
    "id" : "string",
    "username" : "string"
  }
}

teamIdentifierType#

Type of the identifier. Possible values are 'id' and 'name'. Default value is 'id'

Type: string

Potential values: id, name

assign_alert#

Assign alert with given identifier

Parameters

identifier (required)#

Identifier of alert which could be alert id, tiny id or alert alias

Type: string

$body#

Request payload of assigning alert action

Type: object

{
  "note" : "Additional note that will be added while creating the alert",
  "source" : "Source field of the alert. Default value is IP address of the incoming request",
  "user" : "Display name of the request owner",
  "owner" : {
    "id" : "string",
    "type" : "Required string. Possible values: all | none | user | escalation | schedule | team | group",
    "username" : "string"
  }
}

identifierType#

Type of the identifier that is provided as an in-line parameter. Possible values are 'id', 'alias' or 'tiny'

Type: string

Potential values: id, alias, tiny

authenticate_integration#

Authenticates integration with given type

Parameters

$body#

Request payload to authenticate integration

Type: object

{
  "type" : "Required string. Possible values: Airbrake | AlertLogic | AlertSite | AmazonCloudTrail | AmazonEc2AutoScaling | AmazonRds | AmazonRoute53HealthCheck | AmazonSes | AmazonSns | AmazonSnsOutgoing | AmazonSecurityHub | API | Apica | Apimetrics | AppDynamics | AppOptics | AppSignal | AppSignalV2 | Atatus | AtlassianBambooEmail | AutotaskAEMEmail | AutoTaskEmail | Azure | AzureAutoScale | AzureOMS | AzureServiceHealth | AzureResourceHealth | BigPanda | Bitbucket | BlueMatador | BMCFootPrintsV11 | BMCFootPrintsV12 | BMCRemedy | BMCRemedyForce | BMCRemedyOnDemand | Boundary | Campfire | Catchpoint | CheckMK | Cherwell | CircleCi | Circonus | CloudMonix | CloudSploit | CloudWatch | CloudWatchEvents | Codeship | Compose | ConnectWise | ConnectWiseManage | ConnectWiseManageV2 | ConnectWiseAutomate | Consul | CopperEgg | Crashlytics | Datadog | DataloopIO | Desk | Detectify | DNSCheck | DripStat | Ruxit | DynatraceV2 | DynatraceAppMon | Email | Errorception | ESWatcher | EvidentIO | Flock | Flowdock | FlowdockV2 | Freshdesk | Freshservice | GhostInspector | GitHub | GitLab | GoogleStackdriver | Grafana | GrafanaV2 | Graylog | Heartbeat | HipChat | HipChatV2 | HipChatAddOn | Honeybadger | HostedGraphite | HPServiceManager | Humio | Icinga | Icinga2 | IncomingCall | Instana | Jenkins | Jira | JiraServiceDesk | Kapacitor | Kayako | Kore | LabTechEmail | Librato | LibreNMS | Lightstep | Logentries | Loggly | LogicMonitor | Logstash | LogzIO | Looker | Loom | Magentrix | Marid | OEC | Mattermost | MongoDBCloud | Monitis | MonitisEmail | Moxtra | MSTeams | MSTeamsV2 | Nagios | NagiosV2 | NagiosXI | NagiosXIV2 | NeustarEmail | Netuitive | NewRelic | NewRelicV2 | NewRelicSyntheticsEmail | NodePing | Observium | ObserviumV2 | OEM | OEMEmail | OP5 | OpsDash | OpsGenie | Opsview | PagerDutyCompatibility | Panopta | Papertrail | Pingdom | PingdomV2 | PingdomWebhook | Pingometer | Planio | Prometheus | Prtg | Rackspace | Raygun | RedGateSqlMonitorEmail | Riemann | Rigor | RingCentralEmail | RingCentralGlip | Rollbar | Runscope | SalesForceServiceCloud | SaltStack | Scalyr | Sentry | SCOM | Scout | SematextSpm | Sensu | ServerDensity | ServerGuard24 | ServiceNow | ServiceNowV2 | ServiceNowV3 | Signalfx | SignalFXV2 | SignalSciences | Site24x7 | Slack | SlackApp | Soasta | Solarwinds | SolarwindsMSPNCentral | SolarWindsWebHelpDesk | Splunk | SplunkITSI | Stackdriver | StackStorm | StatusCake | StatusHub | StatusIO | StatusPageIO | Statusy | StruxureWare | SumoLogic | SysdigCloud | ThousandEyes | ThreatStack | Thundra | Tideways | Trace | TrackIt | TravisCI | Twilio | UpdownIO | UptimeRobot | UptimeRobotEmail | UptimeWebhook | UptrendsEmail | VCenter | VCSA | VividCortex | Wavefront | WhatsUpGold | Webhook | Workato | XLRelease | Xmpp | Zabbix | Zapier | Zendesk | Zenoss | ZyrionEmail | ManageEngine"
}

cancel_maintenance#

Cancel maintenance with given id

Parameters

id (required)#

Identifier of the maintenance to be searched

Type: string

change_notification_rule_order#

Changes order of a notification rule with given notification rule id

Parameters

identifier (required)#

Identifier of the user to be searched

Type: string

ruleId (required)#

Id of the notification rule that step will belong to.

Type: string

$body#

Request payload of change order of notification rule

Type: object

{
  "order" : "integer"
}

change_policy_order#

Change execution order of the policy with given id

Parameters

policyId (required)#

Id of the requested policy

Type: string

$body#

Change order payload

Type: object

{
  "targetIndex" : "Order of the target policy will be changed to this value. Larger values than policy count will put the target policy to last place"
}

teamId#

TeamId of policy created if it belongs to a team

Type: string

change_team_routing_rule_order#

Change the order of team routing rule with given id

Parameters

id (required)#

Id of the team routing rule

Type: string

identifier (required)#

Identifier of the team

Type: string

$body#

Request payload of change team routing rule order action

Type: object

{
  "order" : "Order of team routing rule within the rules. order value is actually the index of the team routing rule."
}

teamIdentifierType#

Type of the identifier. Possible values are 'id' and 'name'. Default value is 'id'

Type: string

Potential values: id, name

close_alert#

Closes alert with given identifier

Parameters

identifier (required)#

Identifier of alert which could be alert id, tiny id or alert alias

Type: string

$body#

Request payload of closing alert action

Type: object

{
  "note" : "Additional note that will be added while creating the alert",
  "source" : "Source field of the alert. Default value is IP address of the incoming request",
  "user" : "Display name of the request owner"
}

identifierType#

Type of the identifier that is provided as an in-line parameter. Possible values are 'id', 'alias' or 'tiny'

Type: string

Potential values: id, alias, tiny

close_incident#

Closes incident with given identifier

Parameters

identifier (required)#

Identifier of incident which could be incident id or tiny id

Type: string

$body#

Request payload of closing incident action

Type: object

{
  "note" : "Additional note that will be included with the incident"
}

identifierType#

Type of the identifier that is provided as an in-line parameter. Possible values are 'id' or 'tiny. Default is id'

Type: string

Potential values: id, tiny

count_alerts#

Count alerts in Opsgenie

Parameters

query#

Search query to apply while filtering the alerts

Type: string

searchIdentifier#

Identifier of the saved search query to apply while filtering the alerts

Type: string

searchIdentifierType#

Identifier type of the saved search query. Possible values are id and name. Default value is id. If searchIdentifier is not provided, this value is ignored.

Type: string

Potential values: id, name

create_alert#

Creates a new alert

Parameters

$body#

Request payload of created alert

Type: object

{
  "note" : "Additional note that will be added while creating the alert",
  "description" : "Description field of the alert that is generally used to provide a detailed information about the alert.",
  "source" : "Source field of the alert. Default value is IP address of the incoming request",
  "message" : "Message of the alert",
  "priority" : "Priority level of the alert",
  "responders" : [ {
    "id" : "string",
    "type" : "Required string. Possible values: all | none | user | escalation | schedule | team | group"
  } ],
  "tags" : [ "string" ],
  "alias" : "Client-defined identifier of the alert, that is also the key element of alert deduplication.",
  "visibleTo" : [ {
    "id" : "string",
    "type" : "Required string. Possible values: all | none | user | escalation | schedule | team | group"
  } ],
  "details" : "Map of key-value pairs to use as custom properties of the alert",
  "actions" : [ "string" ],
  "user" : "Display name of the request owner",
  "entity" : "Entity field of the alert that is generally used to specify which domain alert is related to"
}

create_contact#

Creates a new contact

Parameters

identifier (required)#

Identifier of the user to be searched

Type: string

$body#

Request payload of creating contact action

Type: object

{
  "method" : "Contact method of user",
  "to" : "Address of contact method"
}

create_custom_user_role#

Creates a new custom user role

Parameters

$body#

Request payload of created custom user role

Type: object

{
  "disallowedRights" : [ "string" ],
  "grantedRights" : [ "string" ],
  "name" : "Name of custom user role",
  "extendedRole" : "Custom role. Must not be one of the defined values (i.e. \"user\", \"observer\", \"stakeholder\")"
}

create_escalation#

Creates a new escalation

Parameters

$body#

Request payload of created escalation

Type: object

{
  "repeat" : {
    "closeAlertAfterAll" : "boolean",
    "count" : "integer",
    "resetRecipientStates" : "boolean",
    "waitInterval" : "integer"
  },
  "name" : "Name of the escalation",
  "description" : "Description of the escalation",
  "rules" : [ {
    "condition" : "Required string. Possible values: if-not-acked | if-not-closed",
    "notifyType" : "Required string. Possible values: default | next | previous | users | admins | all",
    "delay" : {
      "timeAmount" : "Required integer",
      "timeUnit" : "string. Possible values: days | hours | minutes | seconds | miliseconds | micros | nanos"
    },
    "recipient" : {
      "id" : "string",
      "type" : "Required string. Possible values: all | none | user | escalation | schedule | team | group"
    }
  } ],
  "ownerTeam" : {
    "name" : "string",
    "id" : "string"
  }
}

create_forwarding_rule#

Creates a new forwarding rule

Parameters

$body#

Request payload to created forwarding rule

Type: object

{
  "toUser" : {
    "id" : "string",
    "username" : "string"
  },
  "fromUser" : {
    "id" : "string",
    "username" : "string"
  },
  "endDate" : "The date and time for forwarding will end",
  "alias" : "A user defined identifier for the forwarding rule.",
  "startDate" : "The date and time for forwarding will start"
}

create_heartbeat#

Create a new heartbeat

Parameters

$body#

Request payload of created heartbeat

Type: object

{
  "alertTags" : [ "string" ],
  "alertMessage" : "Specifies the alert message for heartbeat expiration alert. If this is not provided, default alert message is 'HeartbeatName is expired'",
  "intervalUnit" : "Interval specified as 'minutes', 'hours' or 'days'",
  "name" : "Name of the heartbeat",
  "description" : "An optional description of the heartbeat",
  "interval" : "Specifies how often a heartbeat message should be expected",
  "alertPriority" : "Specifies the alert priority for heartbeat expiration alert. If this is not provided, default priority is P3",
  "ownerTeam" : {
    "name" : "string",
    "id" : "string"
  },
  "enabled" : "Enable/disable heartbeat monitoring"
}

create_incident#

Creates a new incident

Parameters

$body#

Request payload of created incident

Type: object

{
  "note" : "Additional note that will be added while creating the incident",
  "description" : "Description field of the incident that is generally used to provide a detailed information about the incident.",
  "statusPageEntry" : "Status page entry fields. If this field is leaved blank, message and description of incident will be used for title and detail respectively.",
  "details" : "Map of key-value pairs to use as custom properties of the incident",
  "message" : "Message of the incident",
  "priority" : "Priority level of the incident",
  "serviceId" : "Service on which incident will be created.",
  "responders" : [ {
    "id" : "string",
    "type" : "Required string. Possible values: all | none | user | escalation | schedule | team | group"
  } ],
  "notifyStakeholders" : "Indicate whether stakeholders are notified or not. Default value is false.",
  "tags" : [ "string" ]
}

create_integration#

Creates a new integration

Parameters

$body#

Request payload of created integration

Type: object

{
  "name" : "Name of the integration. Name must be unique for each integration",
  "isGlobal" : "boolean",
  "id" : "string",
  "type" : "Type of the integration. (For instance, \"API\" for API Integration)",
  "_readOnly" : [ "string" ],
  "ownerTeam" : {
    "name" : "string",
    "id" : "string"
  },
  "enabled" : "This parameter is for specifying whether the integration will be enabled or not"
}

create_integration_action#

Creates integration actions of given integration id

Parameters

id (required)#

Integration Id

Type: string

$body#

Request payload to create integration action

Type: object

{
  "filter" : {
    "conditions" : [ {
      "not" : "boolean",
      "field" : "string",
      "expectedValue" : "string",
      "operation" : "string. Possible values: matches | contains | starts-with | ends-with | equals | contains-key | contains-value | greater-than | less-than | is-empty | equals-ignore-whitespace"
    } ],
    "conditionMatchType" : "string. Possible values: match-all | match-any-condition | match-all-conditions"
  },
  "name" : "Required string",
  "type" : "Required string. Possible values: acknowledge | addNote | close | create | ignore",
  "order" : "integer"
}

create_maintenance#

Creates a new maintenance

Parameters

$body#

Request payload of the maintenance object

Type: object

{
  "description" : "Description for the maintenance",
  "rules" : [ {
    "state" : "Defines the state of the rule",
    "entity" : {
      "id" : "Identifier of the maintenance entity",
      "type" : "Required string. Possible values: policy | integration"
    }
  } ],
  "time" : {
    "endDate" : "End time of the time configuration of maintenance",
    "type" : "Type of the maintenance time",
    "startDate" : "Start time of the time configuration of maintenance"
  }
}

create_notification_rule#

Creates a new notification rule

Parameters

identifier (required)#

Identifier of the user to be searched

Type: string

$body#

Request payload of create notification rule

Type: object

{
  "actionType" : "Type of the action that notification rule will have",
  "notificationTime" : [ "string. Possible values: just-before | 15-minutes-ago | 1-hour-ago | 1-day-ago" ],
  "criteria" : {
    "type" : "Required string. Possible values: match-all | match-any-condition | match-all-conditions"
  },
  "schedules" : [ {
    "id" : "string",
    "type" : "Required string. Possible values: all | none | user | escalation | schedule | team | group",
    "name" : "string"
  } ],
  "repeat" : {
    "enabled" : "boolean",
    "loopAfter" : "integer"
  },
  "name" : "Name of the notification rule",
  "steps" : [ {
    "contact" : {
      "method" : "Required string. Possible values: email | sms | voice | mobile",
      "to" : "Required string"
    },
    "sendAfter" : {
      "timeAmount" : "Required integer",
      "timeUnit" : "string. Possible values: days | hours | minutes | seconds | miliseconds | micros | nanos"
    },
    "enabled" : "Specifies whether given step will be enabled or not when it is created."
  } ],
  "timeRestriction" : {
    "type" : "Required string. Possible values: weekday-and-time-of-day | time-of-day"
  },
  "enabled" : "Defines if notification rule will be enabled or not when it is created",
  "order" : "The order of the notification rule within the notification rules with the same action type"
}

create_notification_rule_step#

Creates a new notification rule step

Parameters

identifier (required)#

Identifier of the user to be searched

Type: string

ruleId (required)#

Id of the notification rule that step will belong to.

Type: string

$body#

Request payload to create notification rule step

Type: object

{
  "contact" : {
    "method" : "Required string. Possible values: email | sms | voice | mobile",
    "to" : "Required string"
  },
  "sendAfter" : {
    "timeAmount" : "Required integer",
    "timeUnit" : "string. Possible values: days | hours | minutes | seconds | miliseconds | micros | nanos"
  },
  "enabled" : "Specifies whether given step will be enabled or not when it is created."
}

create_policy#

Creates a new policy

Parameters

$body#

Payload of created policy

Type: object

{
  "policyDescription" : "Description of the policy",
  "filter" : {
    "type" : "Required string. Possible values: match-all | match-any-condition | match-all-conditions"
  },
  "timeRestrictions" : {
    "type" : "Required string. Possible values: weekday-and-time-of-day | time-of-day"
  },
  "teamId" : "TeamId of the policy",
  "name" : "Name of the policy",
  "id" : "string",
  "type" : "Type of the policy",
  "enabled" : "Activity status of the alert policy"
}

teamId#

TeamId of policy created if it belongs to a team

Type: string

create_saved_searches#

Create saved search with given fields

Parameters

$body#

Request payload of creating saved search

Type: object

{
  "owner" : {
    "id" : "string",
    "type" : "Required string. Possible values: all | none | user | escalation | schedule | team | group",
    "username" : "string"
  },
  "teams" : [ {
    "id" : "string",
    "type" : "Required string. Possible values: all | none | user | escalation | schedule | team | group",
    "name" : "string"
  } ],
  "query" : "Required string",
  "name" : "Required string",
  "description" : "string"
}

create_schedule#

Creates a new schedule

Parameters

$body#

Request payload of created schedule

Type: object

{
  "timezone" : "Timezone of schedule",
  "name" : "Name of the schedule",
  "description" : "The description of schedule",
  "ownerTeam" : {
    "name" : "string",
    "id" : "string"
  },
  "rotations" : [ {
    "endDate" : "Defines a date time as an override end. Minutes may take 0 or 30 as value. Otherwise they will be converted to nearest 0 or 30 automatically",
    "name" : "Name of rotation",
    "length" : "Length of the rotation with default value 1",
    "type" : "Type of rotation. May be one of 'daily', 'weekly' and 'hourly'",
    "startDate" : "Defines a date time as an override start. Minutes may take 0 or 30 as value. Otherwise they will be converted to nearest 0 or 30 automatically",
    "timeRestriction" : {
      "type" : "Required string. Possible values: weekday-and-time-of-day | time-of-day"
    },
    "participants" : [ {
      "id" : "string",
      "type" : "Required string. Possible values: all | none | user | escalation | schedule | team | group"
    } ]
  } ],
  "enabled" : "Enable/disable state of schedule"
}

create_schedule_override#

Creates a schedule override for the specified user and schedule

Parameters

identifier (required)#

Identifier of schedule which could be id or name

Type: string

$body#

Request payload of created schedule override

Type: object

{
  "endDate" : "Time for override ending",
  "alias" : "A user defined identifier for the override",
  "user" : {
    "id" : "string",
    "type" : "Required string. Possible values: all | none | user | escalation | schedule | team | group"
  },
  "rotations" : [ {
    "name" : "string",
    "id" : "string"
  } ],
  "startDate" : "Time for override starting"
}

scheduleIdentifierType#

Type of the identifier that is provided as an in-line parameter. Possible values are 'id' or 'name'

Type: string

Potential values: id, name

create_schedule_rotation#

Creates a new schedule rotation

Parameters

identifier (required)#

Identifier of schedule which could be id or name

Type: string

$body#

Request payload of created schedule rotation

Type: object

{
  "endDate" : "Defines a date time as an override end. Minutes may take 0 or 30 as value. Otherwise they will be converted to nearest 0 or 30 automatically",
  "name" : "Name of rotation",
  "length" : "Length of the rotation with default value 1",
  "type" : "Type of rotation. May be one of 'daily', 'weekly' and 'hourly'",
  "startDate" : "Defines a date time as an override start. Minutes may take 0 or 30 as value. Otherwise they will be converted to nearest 0 or 30 automatically",
  "timeRestriction" : {
    "type" : "Required string. Possible values: weekday-and-time-of-day | time-of-day"
  },
  "participants" : [ {
    "id" : "string",
    "type" : "Required string. Possible values: all | none | user | escalation | schedule | team | group"
  } ]
}

scheduleIdentifierType#

Type of the identifier that is provided as an in-line parameter. Possible values are 'id' or 'name'

Type: string

Potential values: id, name

create_team#

Creates a new team

Parameters

$body#

Request payload of created team

Type: object

{
  "members" : [ {
    "role" : "Member role of the user, consisting 'user', 'admin' or a custom team role. Default value is 'user'",
    "user" : {
      "id" : "string",
      "username" : "string"
    }
  } ],
  "name" : "Name of the team",
  "description" : "The description of team"
}

create_team_role#

Creates a new team role

Parameters

identifier (required)#

Identifier of the team

Type: string

$body#

Request payload of created team role

Type: object

{
  "rights" : [ {
    "right" : "Required string",
    "granted" : "boolean"
  } ],
  "name" : "Name of the team role"
}

teamIdentifierType#

Type of the identifier. Possible values are 'id' and 'name'. Default value is 'id'

Type: string

Potential values: id, name

create_team_routing_rule#

Creates a new team routing rule

Parameters

identifier (required)#

Identifier of the team

Type: string

$body#

Request payload of createTeamRoutingRule

Type: object

{
  "criteria" : {
    "type" : "Required string. Possible values: match-all | match-any-condition | match-all-conditions"
  },
  "timezone" : "Timezone of team routing rule. If timezone field is not given, account timezone is used as default.",
  "name" : "Name of the team routing rule",
  "timeRestriction" : {
    "type" : "Required string. Possible values: weekday-and-time-of-day | time-of-day"
  },
  "notify" : {
    "id" : "string",
    "type" : "Required string. Possible values: all | none | user | escalation | schedule | team | group"
  },
  "order" : "Order of team routing rule within the rules. order value is actually the index of the team routing rule."
}

teamIdentifierType#

Type of the identifier. Possible values are 'id' and 'name'. Default value is 'id'

Type: string

Potential values: id, name

create_user#

Creates a user with the given payload

Parameters

$body#

Request payload of the user object

Type: object

{
  "userAddress" : {
    "country" : "string",
    "zipCode" : "string",
    "city" : "string",
    "line" : "string",
    "state" : "string"
  },
  "role" : {
    "name" : "string",
    "id" : "string"
  },
  "skypeUsername" : "Skype username of the user",
  "fullName" : "Name of the user",
  "timeZone" : "Timezone of the user. If not set, timezone of the customer will be used instead.",
  "details" : "Set of user defined properties.",
  "invitationDisabled" : "Invitation email will not be sent if set to true. Default value is false",
  "locale" : "Location information of the user. If not set, locale of the customer will be used instead.",
  "username" : "E-mail address of the user",
  "tags" : [ "string" ]
}

delete_alert#

Deletes an alert using alert id, tiny id or alias

Parameters

identifier (required)#

Identifier of alert which could be alert id, tiny id or alert alias

Type: string

identifierType#

Type of the identifier that is provided as an in-line parameter. Possible values are 'id', 'alias' or 'tiny'

Type: string

Potential values: id, alias, tiny

source#

Display name of the request source

Type: string

user#

Display name of the request owner

Type: string

delete_contact#

Delete contact using contact id

Parameters

contactId (required)#

Id of the contact

Type: string

identifier (required)#

Identifier of the user to be searched

Type: string

delete_custom_user_role#

Deletes a custom user role using role 'id' or 'name'

Parameters

identifier (required)#

Identifier of custom user role which could be user role 'id' or 'name'

Type: string

identifierType#

Type of the identifier that is provided as an in-line parameter. Possible values are 'id' or 'name'

Type: string

Potential values: id, name

delete_escalation#

Deletes an escalation using escalation 'id' or 'name'

Parameters

identifier (required)#

Identifier of escalation which could be escalation 'id' or 'name'

Type: string

identifierType#

Type of the identifier that is provided as an in-line parameter. Possible values are 'id' or 'name'

Type: string

Potential values: id, name

delete_forwarding_rule#

Deletes forwarding rule with given identifier

Parameters

identifier (required)#

Identifier of the forwarding rule which could be forwarding rule 'id' or 'alias'

Type: string

identifierType#

Type of the identifier that is provided as an in-line parameter. Possible values are 'id' or 'alias'

Type: string

Potential values: id, alias

delete_heartbeat#

Delete heartbeat with given name

Parameters

name (required)#

Name of the heartbeat

Type: string

delete_incident#

Deletes an incident using incident id or the tiny id

Parameters

identifier (required)#

Identifier of incident which could be incident id or tiny id

Type: string

identifierType#

Type of the identifier that is provided as an in-line parameter. Possible values are 'id' or 'tiny. Default is id'

Type: string

Potential values: id, tiny

delete_integration#

Delete integration with given id

Parameters

id (required)#

Integration Id

Type: string

delete_maintenance#

Delete maintenance with given identifier

Parameters

id (required)#

Identifier of the maintenance to be searched

Type: string

delete_notification_rule#

Deletes a notification rule with given notification rule id

Parameters

identifier (required)#

Identifier of the user to be searched

Type: string

ruleId (required)#

Id of the notification rule that step will belong to.

Type: string

delete_notification_rule_step#

Deletes a notification rule step using user identifier, rule id, notification rule step id

Parameters

id (required)#

Id of the rule step will be changed.

Type: string

identifier (required)#

Identifier of the user to be searched

Type: string

ruleId (required)#

Id of the notification rule that step will belong to.

Type: string

delete_policy#

Delete policy with given id

Parameters

policyId (required)#

Id of the requested policy

Type: string

teamId#

TeamId of policy created if it belongs to a team

Type: string

delete_saved_search#

Deletes saved search using given search identifier

Parameters

identifier (required)#

Identifier of the saved search which could be 'id' or 'name'

Type: string

identifierType#

Type of the identifier that is provided as an in-line parameter. Possible values are 'id', or 'name'

Type: string

Potential values: id, name

delete_schedule#

Delete schedule with given identifier

Parameters

identifier (required)#

Identifier of schedule which could be id or name

Type: string

identifierType#

Type of the identifier that is provided as an in-line parameter. Possible values are 'id' or 'name'

Type: string

Potential values: id, name

delete_schedule_override#

Delete schedule override with given alias

Parameters

alias (required)#

Alias of the schedule override

Type: string

identifier (required)#

Identifier of schedule which could be id or name

Type: string

scheduleIdentifierType#

Type of the identifier that is provided as an in-line parameter. Possible values are 'id' or 'name'

Type: string

Potential values: id, name

delete_schedule_rotation#

Delete schedule rotation with given identifier

Parameters

id (required)#

Identifier of schedule rotation

Type: string

identifier (required)#

Identifier of schedule which could be id or name

Type: string

scheduleIdentifierType#

Type of the identifier that is provided as an in-line parameter. Possible values are 'id' or 'name'

Type: string

Potential values: id, name

delete_team#

Delete team with given id or name

Parameters

identifier (required)#

Identifier of the team

Type: string

identifierType#

Type of the identifier. Possible values are 'id' and 'name'. Default value is 'id'

Type: string

Potential values: id, name

delete_team_member#

Deletes the member of team with given identifier

Parameters

identifier (required)#

Identifier of the team

Type: string

memberIdentifier (required)#

User id or username of member for removal

Type: string

teamIdentifierType#

Type of the identifier. Possible values are 'id' and 'name'. Default value is 'id'

Type: string

Potential values: id, name

delete_team_role#

Deletes a team role using team role 'id' or 'name'

Parameters

identifier (required)#

Identifier of the team

Type: string

teamRoleIdentifier (required)#

Identifier of team role which could be team role 'id' or 'name'

Type: string

identifierType#

Type of the identifier that is provided as an in-line parameter. Possible values are 'id' or 'name'

Type: string

Potential values: id, name

teamIdentifierType#

Type of the identifier. Possible values are 'id' and 'name'. Default value is 'id'

Type: string

Potential values: id, name

delete_team_routing_rule#

Delete team routing rule with given id

Parameters

id (required)#

Id of the team routing rule

Type: string

identifier (required)#

Identifier of the team

Type: string

teamIdentifierType#

Type of the identifier. Possible values are 'id' and 'name'. Default value is 'id'

Type: string

Potential values: id, name

delete_user#

Delete user with the given identifier

Parameters

identifier (required)#

Identifier of the user to be searched

Type: string

disable_contact#

Disable the contact of the user

Parameters

contactId (required)#

Id of the contact

Type: string

identifier (required)#

Identifier of the user to be searched

Type: string

disable_heartbeat#

Disable heartbeat request with given name

Parameters

name (required)#

Name of the heartbeat

Type: string

disable_integration#

Disable integration with given ID

Parameters

id (required)#

Integration Id

Type: string

disable_notification_rule#

Disables a notification rule with given notification rule id

Parameters

identifier (required)#

Identifier of the user to be searched

Type: string

ruleId (required)#

Id of the notification rule that step will belong to.

Type: string

disable_notification_rule_step#

Disables a new notification rule step

Parameters

id (required)#

Id of the rule step will be changed.

Type: string

identifier (required)#

Identifier of the user to be searched

Type: string

ruleId (required)#

Id of the notification rule that step will belong to.

Type: string

disable_policy#

Disable the policy with given id

Parameters

policyId (required)#

Id of the requested policy

Type: string

teamId#

TeamId of policy created if it belongs to a team

Type: string

enable_contact#

Enable the contact of the user

Parameters

contactId (required)#

Id of the contact

Type: string

identifier (required)#

Identifier of the user to be searched

Type: string

enable_heartbeat#

Enable heartbeat request with given name

Parameters

name (required)#

Name of the heartbeat

Type: string

enable_integration#

Enable integration with given ID

Parameters

id (required)#

Integration Id

Type: string

enable_notification_rule#

Enables a notification rule with given notification rule id

Parameters

identifier (required)#

Identifier of the user to be searched

Type: string

ruleId (required)#

Id of the notification rule that step will belong to.

Type: string

enable_notification_rule_step#

Enables a new notification rule step

Parameters

id (required)#

Id of the rule step will be changed.

Type: string

identifier (required)#

Identifier of the user to be searched

Type: string

ruleId (required)#

Id of the notification rule that step will belong to.

Type: string

enable_policy#

Enable the policy with given id

Parameters

policyId (required)#

Id of the requested policy

Type: string

teamId#

TeamId of policy created if it belongs to a team

Type: string

escalate_alert#

Escalate alert with given identifier

Parameters

identifier (required)#

Identifier of alert which could be alert id, tiny id or alert alias

Type: string

$body#

Request payload of escalating alert action

Type: object

{
  "note" : "Additional note that will be added while creating the alert",
  "source" : "Source field of the alert. Default value is IP address of the incoming request",
  "user" : "Display name of the request owner",
  "escalation" : {
    "id" : "string",
    "type" : "Required string. Possible values: all | none | user | escalation | schedule | team | group",
    "name" : "string"
  }
}

identifierType#

Type of the identifier that is provided as an in-line parameter. Possible values are 'id', 'alias' or 'tiny'

Type: string

Potential values: id, alias, tiny

execute_custom_alert_action#

Custom actions for the alert

Parameters

actionName (required)#

Name of the action to execute

Type: string

identifier (required)#

Identifier of alert which could be alert id, tiny id or alert alias

Type: string

$body#

Request payload of executing custom alert action

Type: object

{
  "note" : "Additional note that will be added while creating the alert",
  "source" : "Source field of the alert. Default value is IP address of the incoming request",
  "user" : "Display name of the request owner"
}

identifierType#

Type of the identifier that is provided as an in-line parameter. Possible values are 'id', 'alias' or 'tiny'

Type: string

Potential values: id, alias, tiny

export_oncall_user#

Exports personal on-call timeline of 3 months to a .ics file

Parameters

identifier (required)#

Identifier of the user. Should be either 'id' or 'username' of the user

Type: string

export_schedule#

Returns an .ics file as byte array

Parameters

identifier (required)#

Identifier of schedule which could be id or name

Type: string

identifierType#

Type of the identifier that is provided as an in-line parameter. Possible values are 'id' or 'name'

Type: string

Potential values: id, name

get_alert#

Returns alert with given id, tiny id or alias

Parameters

identifier (required)#

Identifier of alert which could be alert id, tiny id or alert alias

Type: string

identifierType#

Type of the identifier that is provided as an in-line parameter. Possible values are 'id', 'alias' or 'tiny'

Type: string

Potential values: id, alias, tiny

get_attachment#

Get alert attachment name and url for the given identifier

Parameters

attachmentId (required)#

Identifier of alert attachment

Type: integer

identifier (required)#

Identifier of alert which could be alert id, tiny id or alert alias

Type: string

alertIdentifierType#

Type of the identifier that is provided as an in-line parameter. Possible values are 'id', 'alias' or 'tiny'

Type: string

Potential values: id, alias, tiny

get_contact#

Returns contact with given id

Parameters

contactId (required)#

Id of the contact

Type: string

identifier (required)#

Identifier of the user to be searched

Type: string

get_custom_user_role#

Returns custom user role with given 'id' or 'name'

Parameters

identifier (required)#

Identifier of custom user role which could be user role 'id' or 'name'

Type: string

identifierType#

Type of the identifier that is provided as an in-line parameter. Possible values are 'id' or 'name'

Type: string

Potential values: id, name

get_escalation#

Returns escalation with given 'id' or 'name'

Parameters

identifier (required)#

Identifier of escalation which could be escalation 'id' or 'name'

Type: string

identifierType#

Type of the identifier that is provided as an in-line parameter. Possible values are 'id' or 'name'

Type: string

Potential values: id, name

get_forwarding_rule#

Returns forwarding rule with given id or alias

Parameters

identifier (required)#

Identifier of the forwarding rule which could be forwarding rule 'id' or 'alias'

Type: string

identifierType#

Type of the identifier that is provided as an in-line parameter. Possible values are 'id' or 'alias'

Type: string

Potential values: id, alias

get_heartbeat#

Returns heartbeat with given name

Parameters

name (required)#

Name of the heartbeat

Type: string

get_incident#

Returns incident with given id, tiny id or alias

Parameters

identifier (required)#

Identifier of incident which could be incident id or tiny id

Type: string

identifierType#

Type of the identifier that is provided as an in-line parameter. Possible values are 'id' or 'tiny. Default is id'

Type: string

Potential values: id, tiny

get_incident_request_status#

Used to track the status and incident details (if any) of the request whose identifier is given

Parameters

requestId (required)#

Universally unique identifier of the questioned request

Type: string

get_info#

This operation has no parameters

get_integration#

Returns integration with given id

Parameters

id (required)#

Integration Id

Type: string

get_maintenance#

Returns maintenance with given id

Parameters

id (required)#

Identifier of the maintenance to be searched

Type: string

get_next_oncalls#

Gets next on-call participants of a specific schedule

Parameters

identifier (required)#

Identifier of schedule which could be id or name

Type: string

date#

Starting date of the timeline

Type: date-time

flat#

Retrieves user names of all on call participants if enabled

Type: boolean

scheduleIdentifierType#

Type of the identifier that is provided as an in-line parameter. Possible values are 'id' or 'name'

Type: string

Potential values: id, name

get_notification_rule#

Returns notification rule with given id

Parameters

identifier (required)#

Identifier of the user to be searched

Type: string

ruleId (required)#

Id of the notification rule that step will belong to.

Type: string

get_notification_rule_step#

Returns notification rule step with given user identifier and rule id

Parameters

id (required)#

Id of the rule step will be changed.

Type: string

identifier (required)#

Identifier of the user to be searched

Type: string

ruleId (required)#

Id of the notification rule that step will belong to.

Type: string

get_oncalls#

Gets current on-call participants of a specific schedule

Parameters

identifier (required)#

Identifier of schedule which could be id or name

Type: string

date#

Starting date of the timeline

Type: date-time

flat#

Retrieves user names of all on call participants if enabled

Type: boolean

scheduleIdentifierType#

Type of the identifier that is provided as an in-line parameter. Possible values are 'id' or 'name'

Type: string

Potential values: id, name

get_policy#

Used to get details of a single policy with id

Parameters

policyId (required)#

Id of the requested policy

Type: string

teamId#

TeamId of policy created if it belongs to a team

Type: string

get_request_status#

Used to track the status and alert details (if any) of the request whose identifier is given

Parameters

requestId (required)#

Universally unique identifier of the questioned request

Type: string

get_saved_search#

Get saved search for the given search identifier

Parameters

identifier (required)#

Identifier of the saved search which could be 'id' or 'name'

Type: string

identifierType#

Type of the identifier that is provided as an in-line parameter. Possible values are 'id', or 'name'

Type: string

Potential values: id, name

get_schedule#

Returns schedule with given id or name

Parameters

identifier (required)#

Identifier of schedule which could be id or name

Type: string

identifierType#

Type of the identifier that is provided as an in-line parameter. Possible values are 'id' or 'name'

Type: string

Potential values: id, name

get_schedule_override#

Gets schedule override details with given alias

Parameters

alias (required)#

Alias of the schedule override

Type: string

identifier (required)#

Identifier of schedule which could be id or name

Type: string

scheduleIdentifierType#

Type of the identifier that is provided as an in-line parameter. Possible values are 'id' or 'name'

Type: string

Potential values: id, name

get_schedule_rotation#

Returns schedule rotation with given id

Parameters

id (required)#

Identifier of schedule rotation

Type: string

identifier (required)#

Identifier of schedule which could be id or name

Type: string

scheduleIdentifierType#

Type of the identifier that is provided as an in-line parameter. Possible values are 'id' or 'name'

Type: string

Potential values: id, name

get_schedule_timeline#

Returns schedule timeline with given id or name

Parameters

identifier (required)#

Identifier of schedule which could be id or name

Type: string

date#

Time to return future date on-call participants. Default date is the moment of the time that request is received

Type: date-time

expand#

Returns more detailed response with expanding it. Possible values are 'base', 'forwarding', and 'override' which is also returned with expandable field of response

Type: array

[ "string" ]

identifierType#

Type of the identifier that is provided as an in-line parameter. Possible values are 'id' or 'name'

Type: string

Potential values: id, name

interval#

Length of time as integer in intervalUnits to retrieve the timeline. Default value is 1

Type: integer

intervalUnit#

Unit of the time to retrieve the timeline. Available values are 'days', 'weeks' and 'months'. Default value is 'weeks'

Type: string

Potential values: days, weeks, months

get_team#

Returns team with given 'id' or 'name'

Parameters

identifier (required)#

Identifier of the team

Type: string

identifierType#

Type of the identifier. Possible values are 'id' and 'name'. Default value is 'id'

Type: string

Potential values: id, name

get_team_role#

Returns team role with given 'id' or 'name'

Parameters

identifier (required)#

Identifier of the team

Type: string

teamRoleIdentifier (required)#

Identifier of team role which could be team role 'id' or 'name'

Type: string

identifierType#

Type of the identifier that is provided as an in-line parameter. Possible values are 'id' or 'name'

Type: string

Potential values: id, name

teamIdentifierType#

Type of the identifier. Possible values are 'id' and 'name'. Default value is 'id'

Type: string

Potential values: id, name

get_team_routing_rule#

Returns team routing rule with given id

Parameters

id (required)#

Id of the team routing rule

Type: string

identifier (required)#

Identifier of the team

Type: string

teamIdentifierType#

Type of the identifier. Possible values are 'id' and 'name'. Default value is 'id'

Type: string

Potential values: id, name

get_user#

Get user for the given identifier

Parameters

identifier (required)#

Identifier of the user to be searched

Type: string

expand#

Comma separated list of strings to create a more detailed response. The only expandable field for user api is 'contact'

Type: array

[ "string" ]

list_alert_policies#

Returns the list of alert policies

Parameters

teamId#

TeamId of policy created if it belongs to a team

Type: string

list_alerts#

Returns list of alerts

Parameters

order#

Sorting order of the result set

Type: string

Potential values: asc, desc

query#

Search query to apply while filtering the alerts

Type: string

searchIdentifier#

Identifier of the saved search query to apply while filtering the alerts

Type: string

searchIdentifierType#

Identifier type of the saved search query. Possible values are 'id', or 'name'

Type: string

Potential values: id, name

sort#

Name of the field that result set will be sorted by

Type: string

Potential values: createdAt, updatedAt, tinyId, alias, message, status, acknowledged, isSeen, snoozed, snoozedUntil, count, lastOccurredAt, source, owner, integration.name, integration.type, report.ackTime, report.closeTime, report.acknowledgedBy, report.closedBy

list_attachments#

List alert attachment names and urls for related alert

Parameters

identifier (required)#

Identifier of alert which could be alert id, tiny id or alert alias

Type: string

alertIdentifierType#

Type of the identifier that is provided as an in-line parameter. Possible values are 'id', 'alias' or 'tiny'

Type: string

Potential values: id, alias, tiny

list_contacts#

Returns list of contacts

Parameters

identifier (required)#

Identifier of the user to be searched

Type: string

list_custom_user_roles#

This operation has no parameters

list_escalations#

This operation has no parameters

list_forwarding_rules#

This operation has no parameters

list_heartbeats#

This operation has no parameters

list_incidents#

Return list of incidents

Parameters

query (required)#

Search query to apply while filtering the incidents.

Type: string

order#

Sorting order of the result set

Type: string

Potential values: asc, desc

sort#

Name of the field that result set will be sorted by

Type: string

Potential values: createdAt, tinyId, message, status, isSeen, owner

list_integration_actions#

List integration actions of given integration id

Parameters

id (required)#

Integration Id

Type: string

list_integrations#

Returns list of integrations with given parameters

Parameters

teamId#

The ID of the team. If the team ID parameter is given, the result will be filtered by teamId

Type: string

teamName#

The name of the team. If the team name parameter is given, the result will be filtered by teamName

Type: string

type#

Type of the integration (For instance, "API" for API Integration). If type parameter is given, the result will be filtered by type

Type: string

list_logs#

List alert logs for the given alert identifier

Parameters

identifier (required)#

Identifier of alert which could be alert id, tiny id or alert alias

Type: string

direction#

Page direction to apply for the given offset with 'next' and 'prev'

Type: string

Potential values: next, prev

identifierType#

Type of the identifier that is provided as an in-line parameter. Possible values are 'id', 'alias' or 'tiny'

Type: string

Potential values: id, alias, tiny

order#

Sorting order of the result set

Type: string

Potential values: asc, desc

list_maintenance#

List maintenance by type

Parameters

type#

Type of the maintenance list to be searched

Type: string

Potential values: all, past, non-expired

list_notes#

List alert notes for the given alert identifier

Parameters

identifier (required)#

Identifier of alert which could be alert id, tiny id or alert alias

Type: string

direction#

Page direction to apply for the given offset with 'next' and 'prev'

Type: string

Potential values: next, prev

identifierType#

Type of the identifier that is provided as an in-line parameter. Possible values are 'id', 'alias' or 'tiny'

Type: string

Potential values: id, alias, tiny

order#

Sorting order of the result set

Type: string

Potential values: asc, desc

list_notification_policies#

Returns the list of notification policies

Parameters

teamId#

TeamId of policy created if it belongs to a team

Type: string

list_notification_rule_steps#

Returns list of notification rule steps

Parameters

identifier (required)#

Identifier of the user to be searched

Type: string

ruleId (required)#

Id of the notification rule that step will belong to.

Type: string

list_notification_rules#

Returns list of notification rules

Parameters

identifier (required)#

Identifier of the user to be searched

Type: string

list_recipients#

List alert recipients for the given alert identifier

Parameters

identifier (required)#

Identifier of alert which could be alert id, tiny id or alert alias

Type: string

identifierType#

Type of the identifier that is provided as an in-line parameter. Possible values are 'id', 'alias' or 'tiny'

Type: string

Potential values: id, alias, tiny

list_saved_searches#

This operation has no parameters

list_schedule_override#

Returns list of schedule overrides

Parameters

identifier (required)#

Identifier of schedule which could be id or name

Type: string

scheduleIdentifierType#

Type of the identifier that is provided as an in-line parameter. Possible values are 'id' or 'name'

Type: string

Potential values: id, name

list_schedule_rotations#

Returns list of schedule rotations

Parameters

identifier (required)#

Identifier of schedule which could be id or name

Type: string

scheduleIdentifierType#

Type of the identifier that is provided as an in-line parameter. Possible values are 'id' or 'name'

Type: string

Potential values: id, name

list_schedules#

Returns list of schedule

Parameters

expand#

Returns more detailed response with expanding it. Possible value is 'rotation' which is also returned with expandable field of response

Type: array

[ "string" ]

list_team_logs#

Return logs of a team given with identifier

Parameters

identifier (required)#

Identifier of the team

Type: string

identifierType#

Type of the identifier. Possible values are 'id' and 'name'. Default value is 'id'

Type: string

Potential values: id, name

order#

Sorting order of the result set

Type: string

Potential values: asc, desc

list_team_roles#

Returns list of team roles

Parameters

identifier (required)#

Identifier of the team

Type: string

teamIdentifierType#

Type of the identifier. Possible values are 'id' and 'name'. Default value is 'id'

Type: string

Potential values: id, name

list_team_routing_rules#

Returns list of team routing rules

Parameters

identifier (required)#

Identifier of the team

Type: string

teamIdentifierType#

Type of the identifier. Possible values are 'id' and 'name'. Default value is 'id'

Type: string

Potential values: id, name

list_teams#

This operation has no parameters

list_user_escalations#

List escalations of the user for the given identifier

Parameters

identifier (required)#

Identifier of the user to be searched

Type: string

list_user_forwarding_rules#

List user forwarding rules for the given user identifier

Parameters

identifier (required)#

Identifier of the user to be searched

Type: string

list_user_schedules#

List schedules of the user for the given identifier

Parameters

identifier (required)#

Identifier of the user to be searched

Type: string

list_user_teams#

List user teams for the given user identifier

Parameters

identifier (required)#

Identifier of the user to be searched

Type: string

list_users#

List users with given parameters

Parameters

order#

Direction of sorting. Should be one of 'asc' or 'desc'

Type: string

Potential values: asc, desc

query#

Field:value combinations with most of user fields to make more advanced searches. Possible fields are username, fullName, blocked, verified, role, locale, timeZone, userAddress and createdAt

Type: string

sortField#

Field to use in sorting. Should be one of 'username', 'fullName' and 'insertedAt'

Type: string

ping#

Ping Heartbeat for given heartbeat name

Parameters

name (required)#

Name of the heartbeat

Type: string

remove_attachment#

Remove alert attachment for the given identifier

Parameters

attachmentId (required)#

Identifier of alert attachment

Type: integer

identifier (required)#

Identifier of alert which could be alert id, tiny id or alert alias

Type: string

alertIdentifierType#

Type of the identifier that is provided as an in-line parameter. Possible values are 'id', 'alias' or 'tiny'

Type: string

Potential values: id, alias, tiny

user#

Display name of the request owner

Type: string

remove_details#

Remove details of the alert with given identifier

Parameters

identifier (required)#

Identifier of alert which could be alert id, tiny id or alert alias

Type: string

keys (required)#

Comma separated list of keys to remove from the custom properties of the alert (e.g. 'key1,key2')

Type: array

[ "string" ]

identifierType#

Type of the identifier that is provided as an in-line parameter. Possible values are 'id', 'alias' or 'tiny'

Type: string

Potential values: id, alias, tiny

note#

Additional alert note to add

Type: string

source#

Display name of the request source

Type: string

user#

Display name of the request owner

Type: string

remove_tags#

Remove tags of the alert with given identifier

Parameters

identifier (required)#

Identifier of alert which could be alert id, tiny id or alert alias

Type: string

tags (required)#

Tags field of the given alert as comma seperated values (e.g. 'tag1, tag2')

Type: array

[ "string" ]

identifierType#

Type of the identifier that is provided as an in-line parameter. Possible values are 'id', 'alias' or 'tiny'

Type: string

Potential values: id, alias, tiny

note#

Additional alert note to add

Type: string

source#

Display name of the request source

Type: string

user#

Display name of the request owner

Type: string

snooze_alert#

Snooze alert with given identifier

Parameters

identifier (required)#

Identifier of alert which could be alert id, tiny id or alert alias

Type: string

$body#

Request payload of snoozing alert action

Type: object

{
  "note" : "Additional note that will be added while creating the alert",
  "source" : "Source field of the alert. Default value is IP address of the incoming request",
  "user" : "Display name of the request owner",
  "endTime" : "Date and time that snooze will lose effect"
}

identifierType#

Type of the identifier that is provided as an in-line parameter. Possible values are 'id', 'alias' or 'tiny'

Type: string

Potential values: id, alias, tiny

unacknowledge_alert#

UnAcknowledge alert with given identifier

Parameters

identifier (required)#

Identifier of alert which could be alert id, tiny id or alert alias

Type: string

$body#

Request payload of unacknowledging alert action

Type: object

{
  "note" : "Additional note that will be added while creating the alert",
  "source" : "Source field of the alert. Default value is IP address of the incoming request",
  "user" : "Display name of the request owner"
}

identifierType#

Type of the identifier that is provided as an in-line parameter. Possible values are 'id', 'alias' or 'tiny'

Type: string

Potential values: id, alias, tiny

update_alert_description#

Update the description of the alert with given identifier

Parameters

identifier (required)#

Identifier of alert which could be alert id, tiny id or alert alias

Type: string

$body#

Request payload of update alert description

Type: object

{
  "description" : "Description of the alert"
}

identifierType#

Type of the identifier that is provided as an in-line parameter. Possible values are 'id', 'alias' or 'tiny'

Type: string

Potential values: id, alias, tiny

update_alert_message#

Update the message of the alert with given identifier

Parameters

identifier (required)#

Identifier of alert which could be alert id, tiny id or alert alias

Type: string

$body#

Request payload of update alert message

Type: object

{
  "message" : "Message of the alert"
}

identifierType#

Type of the identifier that is provided as an in-line parameter. Possible values are 'id', 'alias' or 'tiny'

Type: string

Potential values: id, alias, tiny

update_alert_priority#

Update the priority of the alert with given identifier

Parameters

identifier (required)#

Identifier of alert which could be alert id, tiny id or alert alias

Type: string

$body#

Request payload of update alert priority

Type: object

{
  "priority" : "Priority level of the alert"
}

identifierType#

Type of the identifier that is provided as an in-line parameter. Possible values are 'id', 'alias' or 'tiny'

Type: string

Potential values: id, alias, tiny

update_contact#

Update contact of the user

Parameters

contactId (required)#

Id of the contact

Type: string

identifier (required)#

Identifier of the user to be searched

Type: string

$body#

Request payload of update contact action

Type: object

{
  "to" : "Address of contact method"
}

update_custom_user_role#

Updates the custom user role using role 'id' or 'name'

Parameters

identifier (required)#

Identifier of custom user role which could be user role 'id' or 'name'

Type: string

$body#

Request payload of update custom user role

Type: object

{
  "disallowedRights" : [ "string" ],
  "grantedRights" : [ "string" ],
  "name" : "Name of custom user role",
  "extendedRole" : "Custom role. Must not be one of the defined values (i.e. \"user\", \"observer\", \"stakeholder\")"
}

identifierType#

Type of the identifier that is provided as an in-line parameter. Possible values are 'id' or 'name'

Type: string

Potential values: id, name

update_escalation#

Updates the escalation using escalation 'id' or 'name'

Parameters

identifier (required)#

Identifier of escalation which could be escalation 'id' or 'name'

Type: string

$body#

Request payload of update escalation

Type: object

{
  "repeat" : {
    "closeAlertAfterAll" : "boolean",
    "count" : "integer",
    "resetRecipientStates" : "boolean",
    "waitInterval" : "integer"
  },
  "name" : "Name of the escalation",
  "description" : "Description of the escalation",
  "rules" : [ {
    "condition" : "Required string. Possible values: if-not-acked | if-not-closed",
    "notifyType" : "Required string. Possible values: default | next | previous | users | admins | all",
    "delay" : {
      "timeAmount" : "Required integer",
      "timeUnit" : "string. Possible values: days | hours | minutes | seconds | miliseconds | micros | nanos"
    },
    "recipient" : {
      "id" : "string",
      "type" : "Required string. Possible values: all | none | user | escalation | schedule | team | group"
    }
  } ],
  "ownerTeam" : {
    "name" : "string",
    "id" : "string"
  }
}

identifierType#

Type of the identifier that is provided as an in-line parameter. Possible values are 'id' or 'name'

Type: string

Potential values: id, name

update_forwarding_rule#

Update forwarding rule with given rule id or alias

Parameters

identifier (required)#

Identifier of the forwarding rule which could be forwarding rule 'id' or 'alias'

Type: string

$body#

Request payload of update forwarding rule action

Type: object

{
  "toUser" : {
    "id" : "string",
    "username" : "string"
  },
  "fromUser" : {
    "id" : "string",
    "username" : "string"
  },
  "endDate" : "The date and time for forwarding will end",
  "startDate" : "The date and time for forwarding will start"
}

identifierType#

Type of the identifier that is provided as an in-line parameter. Possible values are 'id' or 'alias'

Type: string

Potential values: id, alias

update_heartbeat#

Update Heartbeatwith given name

Parameters

name (required)#

Name of the heartbeat

Type: string

$body#

Request payload of update heartbeat action

Type: object

{
  "intervalUnit" : "Interval specified as 'minutes', 'hours' or 'days'",
  "description" : "An optional description of the heartbeat",
  "interval" : "Specifies how often a heartbeat message should be expected",
  "enabled" : "Enable/disable heartbeat monitoring"
}

update_integration#

Update integration with given id

Parameters

id (required)#

Integration Id

Type: string

$body#

Request payload of update integration action

Type: object

{
  "name" : "Name of the integration. Name must be unique for each integration",
  "isGlobal" : "boolean",
  "id" : "string",
  "type" : "Type of the integration. (For instance, \"API\" for API Integration)",
  "_readOnly" : [ "string" ],
  "ownerTeam" : {
    "name" : "string",
    "id" : "string"
  },
  "enabled" : "This parameter is for specifying whether the integration will be enabled or not"
}

update_integration_actions#

Updates integration actions of given integration id

Parameters

id (required)#

Integration Id

Type: string

$body#

Request payload to update integration actions

Type: object

{
  "_parent" : {
    "teamId" : "string",
    "name" : "string",
    "id" : "string",
    "type" : "string",
    "enabled" : "boolean"
  },
  "acknowledge" : [ {
    "filter" : {
      "conditions" : [ {
        "not" : "boolean",
        "field" : "string",
        "expectedValue" : "string",
        "operation" : "string. Possible values: matches | contains | starts-with | ends-with | equals | contains-key | contains-value | greater-than | less-than | is-empty | equals-ignore-whitespace"
      } ],
      "conditionMatchType" : "string. Possible values: match-all | match-any-condition | match-all-conditions"
    },
    "name" : "Required string",
    "type" : "Required string. Possible values: acknowledge | addNote | close | create | ignore",
    "order" : "integer",
    "note" : "string",
    "alias" : "string",
    "user" : "string"
  } ],
  "addNote" : [ {
    "filter" : {
      "conditions" : [ {
        "not" : "boolean",
        "field" : "string",
        "expectedValue" : "string",
        "operation" : "string. Possible values: matches | contains | starts-with | ends-with | equals | contains-key | contains-value | greater-than | less-than | is-empty | equals-ignore-whitespace"
      } ],
      "conditionMatchType" : "string. Possible values: match-all | match-any-condition | match-all-conditions"
    },
    "name" : "Required string",
    "type" : "Required string. Possible values: acknowledge | addNote | close | create | ignore",
    "order" : "integer",
    "note" : "string",
    "alias" : "string",
    "user" : "string"
  } ],
  "ignore" : [ {
    "filter" : {
      "conditions" : [ {
        "not" : "boolean",
        "field" : "string",
        "expectedValue" : "string",
        "operation" : "string. Possible values: matches | contains | starts-with | ends-with | equals | contains-key | contains-value | greater-than | less-than | is-empty | equals-ignore-whitespace"
      } ],
      "conditionMatchType" : "string. Possible values: match-all | match-any-condition | match-all-conditions"
    },
    "name" : "Required string",
    "type" : "Required string. Possible values: acknowledge | addNote | close | create | ignore",
    "order" : "integer"
  } ],
  "create" : [ {
    "filter" : {
      "conditions" : [ {
        "not" : "boolean",
        "field" : "string",
        "expectedValue" : "string",
        "operation" : "string. Possible values: matches | contains | starts-with | ends-with | equals | contains-key | contains-value | greater-than | less-than | is-empty | equals-ignore-whitespace"
      } ],
      "conditionMatchType" : "string. Possible values: match-all | match-any-condition | match-all-conditions"
    },
    "name" : "Required string",
    "type" : "Required string. Possible values: acknowledge | addNote | close | create | ignore",
    "order" : "integer",
    "note" : "string",
    "alias" : "string",
    "user" : "string",
    "ignoreExtraPropertiesFromPayload" : "boolean",
    "customPriority" : "string",
    "description" : "string",
    "appendAttachments" : "boolean",
    "extraProperties" : "object",
    "source" : "string",
    "message" : "string",
    "priority" : "string. Possible values: P1 | P2 | P3 | P4 | P5",
    "responders" : [ {
      "id" : "string",
      "type" : "Required string. Possible values: all | none | user | escalation | schedule | team | group"
    } ],
    "ignoreRecipientsFromPayload" : "boolean",
    "tags" : [ "string" ],
    "ignoreTagsFromPayload" : "boolean",
    "ignoreAlertActionsFromPayload" : "boolean",
    "recipients" : [ {
      "id" : "string",
      "type" : "Required string. Possible values: all | none | user | escalation | schedule | team | group"
    } ],
    "ignoreTeamsFromPayload" : "boolean",
    "ignoreRespondersFromPayload" : "boolean",
    "entity" : "string",
    "alertActions" : [ "string" ]
  } ],
  "close" : [ {
    "filter" : {
      "conditions" : [ {
        "not" : "boolean",
        "field" : "string",
        "expectedValue" : "string",
        "operation" : "string. Possible values: matches | contains | starts-with | ends-with | equals | contains-key | contains-value | greater-than | less-than | is-empty | equals-ignore-whitespace"
      } ],
      "conditionMatchType" : "string. Possible values: match-all | match-any-condition | match-all-conditions"
    },
    "name" : "Required string",
    "type" : "Required string. Possible values: acknowledge | addNote | close | create | ignore",
    "order" : "integer",
    "note" : "string",
    "alias" : "string",
    "user" : "string"
  } ]
}

update_maintenance#

Update maintenance with given id

Parameters

id (required)#

Identifier of the maintenance to be searched

Type: string

$body#

Request payload of the maintenance object

Type: object

{
  "description" : "Description for the maintenance",
  "rules" : [ {
    "state" : "Defines the state of the rule",
    "entity" : {
      "id" : "Identifier of the maintenance entity",
      "type" : "Required string. Possible values: policy | integration"
    }
  } ],
  "time" : {
    "endDate" : "End time of the time configuration of maintenance",
    "type" : "Type of the maintenance time",
    "startDate" : "Start time of the time configuration of maintenance"
  }
}

update_notification_rule#

Updates the notification rule with given notification rule id

Parameters

identifier (required)#

Identifier of the user to be searched

Type: string

ruleId (required)#

Id of the notification rule that step will belong to.

Type: string

$body#

Request payload of update notification rule

Type: object

{
  "notificationTime" : [ "string. Possible values: just-before | 15-minutes-ago | 1-hour-ago | 1-day-ago" ],
  "criteria" : {
    "type" : "Required string. Possible values: match-all | match-any-condition | match-all-conditions"
  },
  "schedules" : [ {
    "id" : "string",
    "type" : "Required string. Possible values: all | none | user | escalation | schedule | team | group",
    "name" : "string"
  } ],
  "repeat" : {
    "enabled" : "boolean",
    "loopAfter" : "integer"
  },
  "name" : "Name of the notification rule",
  "steps" : [ {
    "contact" : {
      "method" : "Required string. Possible values: email | sms | voice | mobile",
      "to" : "Required string"
    },
    "sendAfter" : {
      "timeAmount" : "Required integer",
      "timeUnit" : "string. Possible values: days | hours | minutes | seconds | miliseconds | micros | nanos"
    },
    "enabled" : "Specifies whether given step will be enabled or not when it is created."
  } ],
  "timeRestriction" : {
    "type" : "Required string. Possible values: weekday-and-time-of-day | time-of-day"
  },
  "enabled" : "Defines if notification rule will be enabled or not when it is created",
  "order" : "The order of the notification rule within the notification rules with the same action type"
}

update_notification_rule_step#

Update a notification rule step with given user identifier, rule id, and notification rule step id

Parameters

id (required)#

Id of the rule step will be changed.

Type: string

identifier (required)#

Identifier of the user to be searched

Type: string

ruleId (required)#

Id of the notification rule that step will belong to.

Type: string

$body#

Request payload of update schedule action

Type: object

{
  "contact" : {
    "method" : "Required string. Possible values: email | sms | voice | mobile",
    "to" : "Required string"
  },
  "sendAfter" : {
    "timeAmount" : "Required integer",
    "timeUnit" : "string. Possible values: days | hours | minutes | seconds | miliseconds | micros | nanos"
  },
  "enabled" : "Specifies whether given step will be enabled or not when it is updated."
}

update_policy#

Update alert policy with given id

Parameters

policyId (required)#

Id of the requested policy

Type: string

$body#

Payload of updated policy

Type: object

{
  "policyDescription" : "Description of the policy",
  "filter" : {
    "type" : "Required string. Possible values: match-all | match-any-condition | match-all-conditions"
  },
  "timeRestrictions" : {
    "type" : "Required string. Possible values: weekday-and-time-of-day | time-of-day"
  },
  "teamId" : "TeamId of the policy",
  "name" : "Name of the policy",
  "id" : "string",
  "type" : "Type of the policy",
  "enabled" : "Activity status of the alert policy"
}

teamId#

TeamId of policy created if it belongs to a team

Type: string

update_saved_search#

Update saved search for the given search identifier

Parameters

identifier (required)#

Identifier of the saved search which could be 'id' or 'name'

Type: string

$body#

Request payload of updating saved search

Type: object

{
  "owner" : {
    "id" : "string",
    "type" : "Required string. Possible values: all | none | user | escalation | schedule | team | group",
    "username" : "string"
  },
  "teams" : [ {
    "id" : "string",
    "type" : "Required string. Possible values: all | none | user | escalation | schedule | team | group",
    "name" : "string"
  } ],
  "query" : "Required string",
  "name" : "Required string",
  "description" : "string"
}

identifierType#

Type of the identifier that is provided as an in-line parameter. Possible values are 'id', or 'name'

Type: string

Potential values: id, name

update_schedule#

Update schedule with given id or name

Parameters

identifier (required)#

Identifier of schedule which could be id or name

Type: string

$body#

Request payload of update schedule action

Type: object

{
  "timezone" : "Timezone of schedule",
  "name" : "Name of the schedule",
  "description" : "The description of schedule",
  "ownerTeam" : {
    "name" : "string",
    "id" : "string"
  },
  "rotations" : [ {
    "endDate" : "Defines a date time as an override end. Minutes may take 0 or 30 as value. Otherwise they will be converted to nearest 0 or 30 automatically",
    "name" : "Name of rotation",
    "length" : "Length of the rotation with default value 1",
    "type" : "Type of rotation. May be one of 'daily', 'weekly' and 'hourly'",
    "startDate" : "Defines a date time as an override start. Minutes may take 0 or 30 as value. Otherwise they will be converted to nearest 0 or 30 automatically",
    "timeRestriction" : {
      "type" : "Required string. Possible values: weekday-and-time-of-day | time-of-day"
    },
    "participants" : [ {
      "id" : "string",
      "type" : "Required string. Possible values: all | none | user | escalation | schedule | team | group"
    } ]
  } ],
  "enabled" : "Enable/disable state of schedule"
}

identifierType#

Type of the identifier that is provided as an in-line parameter. Possible values are 'id' or 'name'

Type: string

Potential values: id, name

update_schedule_override#

Update schedule override with given alias

Parameters

alias (required)#

Alias of the schedule override

Type: string

identifier (required)#

Identifier of schedule which could be id or name

Type: string

$body#

Request payload of update schedule override

Type: object

{
  "endDate" : "Time for override ending",
  "user" : {
    "id" : "string",
    "type" : "Required string. Possible values: all | none | user | escalation | schedule | team | group"
  },
  "rotations" : [ {
    "name" : "string",
    "id" : "string"
  } ],
  "startDate" : "Time for override starting"
}

scheduleIdentifierType#

Type of the identifier that is provided as an in-line parameter. Possible values are 'id' or 'name'

Type: string

Potential values: id, name

update_schedule_rotation#

Update schedule rotation with given id

Parameters

id (required)#

Identifier of schedule rotation

Type: string

identifier (required)#

Identifier of schedule which could be id or name

Type: string

$body#

Request payload of update schedule rotation action

Type: object

{
  "endDate" : "Defines a date time as an override end. Minutes may take 0 or 30 as value. Otherwise they will be converted to nearest 0 or 30 automatically",
  "name" : "Name of rotation",
  "length" : "Length of the rotation with default value 1",
  "type" : "Type of rotation. May be one of 'daily', 'weekly' and 'hourly'",
  "startDate" : "Defines a date time as an override start. Minutes may take 0 or 30 as value. Otherwise they will be converted to nearest 0 or 30 automatically",
  "timeRestriction" : {
    "type" : "Required string. Possible values: weekday-and-time-of-day | time-of-day"
  },
  "participants" : [ {
    "id" : "string",
    "type" : "Required string. Possible values: all | none | user | escalation | schedule | team | group"
  } ]
}

scheduleIdentifierType#

Type of the identifier that is provided as an in-line parameter. Possible values are 'id' or 'name'

Type: string

Potential values: id, name

update_team#

Update team with given id

Parameters

identifier (required)#

Identifier of the team

Type: string

$body#

Request payload of update team action

Type: object

{
  "members" : [ {
    "role" : "Member role of the user, consisting 'user', 'admin' or a custom team role. Default value is 'user'",
    "user" : {
      "id" : "string",
      "username" : "string"
    }
  } ],
  "name" : "Name of the team",
  "description" : "The description of team"
}

update_team_role#

Updates the team role using team role 'id' or 'name'

Parameters

identifier (required)#

Identifier of the team

Type: string

teamRoleIdentifier (required)#

Identifier of team role which could be team role 'id' or 'name'

Type: string

$body#

Request payload of update team role

Type: object

{
  "rights" : [ {
    "right" : "Required string",
    "granted" : "boolean"
  } ],
  "name" : "Name of the team role"
}

identifierType#

Type of the identifier that is provided as an in-line parameter. Possible values are 'id' or 'name'

Type: string

Potential values: id, name

teamIdentifierType#

Type of the identifier. Possible values are 'id' and 'name'. Default value is 'id'

Type: string

Potential values: id, name

update_team_routing_rule#

Update Team Routing Rule (Partial)

Parameters

id (required)#

Id of the team routing rule

Type: string

identifier (required)#

Identifier of the team

Type: string

$body#

Request payload of update Team Routing Rule action

Type: object

{
  "criteria" : {
    "type" : "Required string. Possible values: match-all | match-any-condition | match-all-conditions"
  },
  "timezone" : "Timezone of team routing rule. If timezone field is not given, account timezone is used as default.",
  "name" : "Name of the team routing rule",
  "timeRestriction" : {
    "type" : "Required string. Possible values: weekday-and-time-of-day | time-of-day"
  },
  "notify" : {
    "id" : "string",
    "type" : "Required string. Possible values: all | none | user | escalation | schedule | team | group"
  }
}

teamIdentifierType#

Type of the identifier. Possible values are 'id' and 'name'. Default value is 'id'

Type: string

Potential values: id, name

update_user#

Update user with the given identifier

Parameters

identifier (required)#

Identifier of the user to be searched

Type: string

$body#

Request payload of the user object

Type: object

{
  "userAddress" : {
    "country" : "string",
    "zipCode" : "string",
    "city" : "string",
    "line" : "string",
    "state" : "string"
  },
  "role" : {
    "name" : "string",
    "id" : "string"
  },
  "skypeUsername" : "Skype username of the user",
  "fullName" : "Name of the user",
  "timeZone" : "Timezone of the user. If not set, timezone of the customer will be used instead.",
  "details" : "Set of user defined properties.",
  "invitationDisabled" : "Invitation email will not be sent if set to true. Default value is false",
  "locale" : "Location information of the user. If not set, locale of the customer will be used instead.",
  "username" : "E-mail address of the user",
  "tags" : [ "string" ]
}