The victorops-api-client library contains a simple and convenient HTTP client for making requests to
the VictorOps REST API.
Using NPM:
$ npm install victorops-api-clientUsing Yarn:
$ yarn add victorops-api-clientThe library exports a VictorOpsApiClient class. All you need to do is instantiate it, and you're ready to go.
You'll need an API ID and API key provided by VictorOps. You can provide these values as apiId and apiKey
options or set these values as environment variables using VO_API_ID and VO_API_KEY.
By default, the client will use the VO_API_ID and VO_API_KEY environment variables if apiId and apiKey
are not provided in the options.
const VictorOpsApiClient = require('victorops-api-client');
const client = new VictorOpsApiClient({
apiId: 'API-ID',
apiKey: 'API-KEY'
});import VictorOpsApiClient from 'victorops-api-client';
const client = new VictorOpsApiClient({
apiId: 'API-ID',
apiKey: 'API-KEY'
});It is required to set the API ID and API key parameters as either environment variables or as options when instantiating the client. These parameters are necessary to execute VictorOpsApiClient calls. If these parameters are not provided or cannot be determined, then an error is thrown.
const VictorOpsApiClient = require('victorops-api-client');
// Set the API ID and key as environment variables.
process.env.VO_API_ID = 'SOME-API-ID';
process.env.VO_API_KEY = 'SOME-API-KEY';
const client = new VictorOpsApiClient();Linux:
$ VO_API_ID=SOME-API-ID VO_API_KEY=SOME-API-KEY node app.jsWindows:
> cmd /C "set VO_API_ID=SOME-API-ID && set VO_API_KEY=SOME-API-KEY && node app.js"These are the available options for creating a VictorOpsApiClient instance. If the apiId and apiKey
options are not provided, then the VO_API_ID and VO_API_KEY environment variables will be used instead.
| Name | Default | Description |
|---|---|---|
apiId |
undefined |
VictorOps API ID |
apiKey |
undefined |
VictorOps API Key |
timeout |
5000 |
Number of milliseconds before the request times out |
baseUrl |
https://api.victorops.com |
The base URL for the VictorOps REST API |
fullResponse |
false |
Get the full response instead of just the body |
maxContentLength |
10000 |
The max size of the HTTP response content in bytes |
maxBodyLength |
2000 |
The max allowed size of the HTTP request body in bytes |
Create an instance:
const VictorOpsApiClient = require('victorops-api-client');
const client = new VictorOpsApiClient({
apiId: 'API-ID',
apiKey: 'API-KEY'
});Get a list of users:
async function getUsers() {
try {
const users = await client.users.getUsers();
return users;
} catch(err) {
console.error(err);
}
}Get a list of incidents:
async function getIncidents() {
try {
const incidents = await client.incidents.getIncidents();
return incidents;
} catch(err) {
console.error(err);
}
}Create a new incident:
async function createIncident() {
try {
const resp = await client.incidents.createIncident({
summary: 'Test incident',
details: 'Something bad happened!!!',
userName: 'johndoe',
targets: [
{
type: 'User',
slug: 'johndoe'
}
],
isMultiResponder: true
});
return resp;
} catch(err) {
console.error(err);
}
}Get a list of teams:
async function getTeams() {
try {
const teams = await client.teams.getTeams();
return teams;
} catch(err) {
console.error(err);
}
}The client instance has a named property for each of the public endpoints in the VictorOps REST API. Each endpoint property contains methods that correspond to the operations associated with the endpoint (according to the VictorOps API). All named endpoint methods return a Promise which resolves with the response data or rejects with an error. Below are the endpoints and operations included with the client.
Any endpoint operation that takes a query argument expects the value to be an Object that contains the query parameters for that particular endpoint operation. Please refer to the endpoint operation's documentation for the correct query parameters.
client.oncall.getUserSchedule(user, query)- Get a user's on-call schedule - VictorOps Documentationclient.oncall.getTeamSchedule(team, query)- Get a team's on-call schedule - VictorOps Documentationclient.oncall.getOncallUsers()- Get an organization's on-call users - VictorOps Documentationclient.oncall.createOncallOverride(policy, takeOncall)- Create an on-call override (take on-call) - VictorOps Documentation
client.incidents.getIncidents()- Get the current incident information - VictorOps Documentationclient.incidents.createIncident(details)- Creates a new incident - VictorOps Documentationclient.incidents.ackIncidents(ackInfo)- Acknowledge an incident or list of incidents - VictorOps Documentationclient.incidents.rerouteIncidents(rules)- Reroute one or more incidents - VictorOps Documentationclient.incidents.resolveIncidents(resolveInfo)- Resolve an incident or list of incidents - VictorOps Documentationclient.incidents.ackUserIncidents(ackInfo)- Acknowledge all incidents for which a user was paged - VictorOps Documentationclient.incidents.resolveUserIncidents(resolveInfo)- Resolve all incidents for which a user was paged - VictorOps Documentation
client.alerts.getAlert(uuid)- Get information about an alert - VictorOps Documentation
client.reporting.getShiftChanges(team, query)- Get a list of shift changes for a team - VictorOps Documentationclient.reporting.getIncidentHistory(query)- Get/search incident history - VictorOps Documentation
client.users.getUsers()- Get a list of users for an organization - VictorOps Documentationclient.users.addUser(user)- Add a user to an organization - VictorOps Documentationclient.users.addUsers(users)- Add users to an organization - VictorOps Documentationclient.users.deleteUser(user, replacement)- Remove a user from an organization - VictorOps Documentationclient.users.getUser(user)- Get the information for the specified user - VictorOps Documentationclient.users.updateUser(user, userInfo)- Update the designated user - VictorOps Documentationclient.users.getTeams(user)- Get the user's team membership - VictorOps Documentation
client.contactMethods.getContactMethods(user)- Get a list of all contact methods for a user - VictorOps Documentationclient.contactMethods.getContactDevices(user)- Get a list of all contact devices for a user - VictorOps Documentationclient.contactMethods.deleteContactDevice(user, contactId)- Delete a contact device for a user - VictorOps Documentationclient.contactMethods.getContactDevice(user, contactId)- Get the indicated contact device for a user - VictorOps Documentationclient.contactMethods.updateContactDevice(user, contactId, contactDevice)- Update a contact device for a user - VictorOps Documentationclient.contactMethods.getContactEmails(user)- Get a list of all contact emails for a user - VictorOps Documentationclient.contactMethods.createContactEmail(user, contactEmail)- Create a contact email for a user - VictorOps Documentationclient.contactMethods.deleteContactEmail(user, contactId)- Delete a contact email for a user - VictorOps Documentationclient.contactMethods.getContactEmail(user, contactId)- Get a contact email for a user - VictorOps Documentationclient.contactMethods.getContactPhones(user)- Get a list of all contact phones for a user - VictorOps Documentationclient.contactMethods.createContactPhone(user, contactPhone)- Create a contact phone for a user - VictorOps Documentationclient.contactMethods.deleteContactPhone(user, contactId)- Delete a contact phone for a user - VictorOps Documentationclient.contactMethods.getContactPhone(user, contactId)- Get a contact phone for a user - VictorOps Documentation
client.userPagingPolicies.getPagingPolicies(user)- Get paging policies for a user - VictorOps Documentation
client.pagingPolicyValues.getNotificationTypes()- Get the available notification types - VictorOps Documentationclient.pagingPolicyValues.getContactTypes()- Get the available contact types - VictorOps Documentationclient.pagingPolicyValues.getTimeoutValues()- Get the available timeout values - VictorOps Documentation
client.personalPagingPolicies.getPagingPolicy(username)- Get a user's paging policy - VictorOps Documentationclient.personalPagingPolicies.createPolicyStep(username, stepInfo)- Create a paging policy step - VictorOps Documentationclient.personalPagingPolicies.getPolicyStep(username, step)- Get a paging policy step - VictorOps Documentationclient.personalPagingPolicies.createPolicyStepRule(username, step, ruleInfo)- Creates a rule for a paging policy step. - VictorOps Documentationclient.personalPagingPolicies.updatePolicyStep(username, step, stepInfo)- Updates a paging policy step - VictorOps Documentationclient.personalPagingPolicies.deletePolicyStepRule(username, step, rule)- Deletes a rule for a paging policy step - VictorOps Documentationclient.personalPagingPolicies.getPolicyStepRule(username, step, rule)- Gets a rule for a paging policy step - VictorOps Documentationclient.personalPagingPolicies.updatePolicyStepRule(username, step, rule, ruleInfo)- Updates a rule for a paging policy step - VictorOps Documentation
client.teams.getTeams()- Get a list of teams for your organization - VictorOps Documentationclient.teams.addTeam(teamInfo)- Add a team to your organization - VictorOps Documentationclient.teams.removeTeam(team)- Remove a team from your organization - VictorOps Documentationclient.teams.getTeam(team)- Get the information for the specified team - VictorOps Documentationclient.teams.updateTeam(team, teamInfo)- Update the information for the specified team - VictorOps Documentationclient.teams.getAdmins(team)- Get the team admins for the specified team - VictorOps Documentationclient.teams.getMembers(team)- Get the team members for the specified team - VictorOps Documentationclient.teams.addMember(team, memberInfo)- Add a team member to the specified team - VictorOps Documentationclient.teams.removeMember(team, user, replacement)- Remove a team member from the specified team - VictorOps Documentation
client.escalationPolicies.getPolicies()- Get a list of escalation policy information - VictorOps Documentationclient.escalationPolicies.createPolicy(policyInfo)- Create an escalation policy - VictorOps Documentationclient.escalationPolicies.deletePolicy(policy)- Delete a specified escalation policy - VictorOps Documentationclient.escalationPolicies.getPolicy(policy)- Get a specific escalation policy - VictorOps Documentation
client.routingKeys.getRoutingKeys()- List routing keys and associated teams - VictorOps Documentationclient.routingKeys.createRoutingKey(keyInfo)- Create a new routing key with escalation policy mapping - VictorOps Documentation
client.scheduledOverrides.getOverrides()- List all the scheduled overrides for an organization - VictorOps Documentationclient.scheduledOverrides.createOverride(overrideInfo)- Create a new scheduled override - VictorOps Documentationclient.scheduledOverrides.deleteOverride(publicId)- Deletes a scheduled override - VictorOps Documentationclient.scheduledOverrides.getOverride(publicId)- Get the specified scheduled override - VictorOps Documentationclient.scheduledOverrides.getAssignments(publicId)- Get the specified scheduled override assignments - VictorOps Documentationclient.scheduledOverrides.deleteAssignment(publicId, policySlug)- Delete a scheduled override assignment - VictorOps Documentationclient.scheduledOverrides.getAssignment(publicId, policySlug)- Get the specified scheduled override assignments - VictorOps Documentationclient.scheduledOverrides.updateAssignment(publicId, policySlug, assignmentInfo)- Update a scheduled override assignment - VictorOps Documentation
client.rotations.getRotationGroups(team)- Get a list of all rotation groups for a team - VictorOps Documentation
client.webhooks.getWebhooks()- Get a list of all the webhooks for an organization - VictorOps Documentation
client.chat.sendChat(chatInfo)- Send a chat message - VictorOps Documentation
client.notes.getNotes(incidentNumber)- Get the notes associated with an incident - VictorOps Documentationclient.notes.createNote(incidentNumber, noteInfo)- Create a new note for an incident - VictorOps Documentationclient.notes.deleteNote(incidentNumber, noteName)- Delete a note - VictorOps Documentationclient.notes.updateNote(incidentNumber, noteName, noteInfo)- Update an existing note - VictorOps Documentation
client.maintenanceMode.getModeState()- Get an organization's current maintenance mode state - VictorOps Documentationclient.maintenanceMode.startMode(modeDef)- Start maintenance mode for routing keys - VictorOps Documentationclient.maintenanceMode.endMode(modeId)- End maintenance mode for routing keys - VictorOps Documentation
The CHANGELOG contains descriptions of notable changes.
This software is licensed under the Apache 2 license.