PagerDuty API Wrapper for Node.js
npm install --save node-pagerduty
The --save
tells NPM to automatically add it to your package.json
file
// Import a module
const pdClient = require('node-pagerduty');
const pdapiToken = 'yourapiTokenGoesHere';
const pd = new pdClient(pdapiToken);
let yourId = 'yourScheduleIdGoesHere';
let yourQs = {
time_zone: 'UTC',
since: 'yourSince',
until: 'yourUntil'
};
// Using it to get things done
pd.schedules.getSchedule(yourId, yourQs)
.then(res => {
console.log(res);
})
.catch(err => {
console.log(err);
});
This library also supports the usage of Bearer
tokens generated by OAuth2. To initialize a new pdClient
with a Bearer
token simply pass a second argument of Bearer
for the token type. The whole call would look something like this:
const pd = new pdClient(pdapiToken, 'Bearer');
All methods follow the official API documentation.
This is a promise based library: (fullfilled, rejected)
https://v2.developer.pagerduty.com/v2/page/api-reference#!/Abilities
abilities.listAbilities()
abilities.testAbility(id)
https://v2.developer.pagerduty.com/v2/page/api-reference#!/Add-ons
addOns.listAddOns(qs)
addOns.installAddOn(payload)
addOns.deleteAddOn(id)
addOns.getAddOn(id)
addOns.updateAddOn(id, payload)
https://v2.developer.pagerduty.com/v2/page/api-reference#!/Escalation_Policies
escalationPolicies.listEscalationPolicies(qs)
escalationPolicies.createEscalationPolicy(from, payload)
escalationPolicies.deleteEscalationPolicy(id)
escalationPolicies.getEscalationPolicy(id, qs)
escalationPolicies.updateEscalationPolicy(id, payload)
Note: Event Rules endpoint does not work with Bearer tokens. Only Token tokens https://v2.developer.pagerduty.com/docs/global-event-rules-api
eventRules.listEventRules()
eventRules.createEventRule(id, payload)
eventRules.deleteEventRule(id)
eventRules.updateEventRule(id, payload)
https://v2.developer.pagerduty.com/v2/page/api-reference#!/Extension_Schemas
extensionSchemas.listExtensionSchemas()
extensionSchemas.getExtensionVendor(id)
https://v2.developer.pagerduty.com/v2/page/api-reference#!/Extensions
extensions.listExtensions(qs)
extensions.createExtension(payload)
extensions.deleteExtension(id)
extensions.getExtension(id, qs)
extensions.updateExtension(id, payload)
https://v2.developer.pagerduty.com/docs/send-an-event-events-api-v2
events.sendEvent(payload)
https://v2.developer.pagerduty.com/v2/page/api-reference#!/Incidents
incidents.listIncidents(qs)
incidents.createIncident(from, payload)
incidents.manageIncident(from, payload)
incidents.mergeIncidents(id, from, payload)
incidents.getIncident(id)
incidents.updateIncident(id, from, payload)
incidents.listAlerts(id, qs)
incidents.manageAlerts(id, from, payload)
incidents.getAlert(id, alert_id)
incidents.updateAlert(id, alert_id, from, payload)
incidents.listLogEntries(id, qs)
incidents.listNotes(id)
incidents.createNote(id, from, payload)
incidents.snoozeIncident(id, from, payload)
https://v2.developer.pagerduty.com/v2/page/api-reference#!/Priorities
priorities.listPriorities()
https://v2.developer.pagerduty.com/v2/page/api-reference#!/Response_Plays
responsePlays.runResponsePlay(id, from, payload)
https://v2.developer.pagerduty.com/v2/page/api-reference#!/Log_Entries
logEntries.listLogEntries(qs)
logEntries.getLogEntry(id, qs)
https://v2.developer.pagerduty.com/v2/page/api-reference#!/Maintenance_Windows
maintenanceWindows.listMaintenanceWindows(qs)
maintenanceWindows.createMaintenanceWindow(from, payload)
maintenanceWindows.deleteMaintenanceWindow(id)
maintenanceWindows.getMaintenanceWindow(id, qs)
maintenanceWindows.updateMaintenanceWindow(id, payload)
https://v2.developer.pagerduty.com/v2/page/api-reference#!/Notifications
notifications.listNotifications(qs)
https://v2.developer.pagerduty.com/v2/page/api-reference#!/On-Calls
onCalls.listAllOnCalls(qs)
https://v2.developer.pagerduty.com/v2/page/api-reference#!/Schedules
schedules.listSchedule(qs)
schedules.createSchedule(payload)
schedules.previewSchedule(qs, payload)
schedules.deleteSchedule(id)
schedules.getSchedule(id, qs)
schedules.updateSchedule(id, qs, payload)
schedules.listOverrides(id, qs)
schedules.createOverride(id, payload)
schedules.deleteOverride(id, override_id)
schedules.listUsersOnCall(id, qs)
https://v2.developer.pagerduty.com/v2/page/api-reference#!/Services
services.listServices(qs)
services.createService(payload)
services.deleteService(id)
services.getService(id, qs)
services.updateService(id, payload)
services.createIntegration(id, payload)
services.viewIntegration(id, integration_id)
services.updateIntegration(id, integration_id, payload)
https://v2.developer.pagerduty.com/v2/page/api-reference#!/Teams
teams.listTeams(qs)
teams.createTeam(payload)
teams.deleteTeam(id)
teams.getTeam(id)
teams.updateTeam(id, payload)
teams.removeEscalationPolicy(id, policy_id)
teams.addEscalationPolicy(id, policy_id)
teams.removeUser(id, user_id)
teams.addUser(id, user_id)
https://v2.developer.pagerduty.com/v2/page/api-reference#!/Users
users.listUsers(qs)
users.createUser(from, payload)
users.deleteUser(id)
users.getUser(id, qs)
users.updateUser(id, payload)
users.listContactMethods(id)
users.createContactMethod(id, payload)
users.deleteContactMethod(id, contact_method_id)
users.getContactMethod(id, contact_method_id)
users.updateContactMethod(id, contact_method_id, payload)
users.listNotificationRules(id, qs)
users.createNotificationRule(id, payload)
users.deleteNotificationRule(id, rule_id)
users.getNotificationRule(id, rule_id, qs)
users.updateNotificationRule(id, rule_id, payload)
https://v2.developer.pagerduty.com/v2/page/api-reference#!/Vendors
vendors.listVendors()
vendors.getVendor(id)
MIT license. See the LICENSE file for details.