@datafire/victorops

v6.0.0

Published

2 years ago

DataFire integration for VictorOps

Downloads

0High
0Medium
0Low

datafire

@datafire/victorops

Client library for VictorOps

Installation and Usage

npm install --save @datafire/victorops

let victorops = require('@datafire/victorops').create();

.then(data => {
  console.log(data);
});

Description

This API allows you to interact with the VictorOps platform in various ways. Your account may be limited to a total number of API calls per month. Also, some of these API calls have rate limits.

NOTE: In this documentation when creating a sample curl request (clicking the TRY IT OUT! button), in some API viewing interfaces, the '@' in an email address may be encoded. Please note that the REST endpoints will not process the encoded version. Make sure that the encoded character '%40' is changed to its unencoded form before submitting the curl request.

Actions

api_public.v1.alerts.uuid.get

Retrieve the details of an alert that was sent VictorOps by you.

This API may be called a maximum of 60 times per minute.

victorops.api_public.v1.alerts.uuid.get({
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": "",
  "uuid": ""
}, context)

Input

input object
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key
- uuid required string: The VictorOps uuid of the alert

Output

output GetAlertResponse

api_public.v1.incidents.get

Get a list of the currently open, acknowledged and recently resolved incidents.

This API may be called a maximum of 60 times per minute.

victorops.api_public.v1.incidents.get({
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": ""
}, context)

Input

input object
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key

Output

output ActiveIncidentList

api_public.v1.incidents.post

Create a new incident.

This call replicates the function of our manual incident creation process. Monitoring tools and custom integrations should be configured using our REST Endpoint.

This API may be called a maximum of 60 times per minute.

victorops.api_public.v1.incidents.post({
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": "",
  "body": {
    "summary": "",
    "details": "",
    "userName": "",
    "targets": []
  }
}, context)

Input

input object
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key
- body required CreateIncidentRequest

Output

output CreatedIncident

api_public.v1.incidents.ack.patch

The incident(s) must be currently open. The user supplied must be a valid VictorOps user and a member of your organization.

This API may be called a maximum of 60 times per minute.

victorops.api_public.v1.incidents.ack.patch({
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": "",
  "body": {
    "userName": "",
    "incidentNames": []
  }
}, context)

Input

input object
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key
- body required AckOrResolveRequest

Output

output AckOrResolveResponse

api_public.v1.incidents.byUser.ack.patch

The incident(s) must be currently open. The user supplied must be a valid VictorOps user and a member of your organization.

This API may be called a maximum of 60 times per minute.

victorops.api_public.v1.incidents.byUser.ack.patch({
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": "",
  "body": {
    "userName": ""
  }
}, context)

Input

input object
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key
- body required AckOrResolveByUserRequest

Output

output AckOrResolveResponse

api_public.v1.incidents.byUser.resolve.patch

The incident(s) must be currently open. The user supplied must be a valid VictorOps user and a member of your organization.

This API may be called a maximum of 60 times per minute.

victorops.api_public.v1.incidents.byUser.resolve.patch({
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": "",
  "body": {
    "userName": ""
  }
}, context)

Input

input object
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key
- body required AckOrResolveByUserRequest

Output

output AckOrResolveResponse

api_public.v1.incidents.reroute.post

Reroute one or more incidents to one or more users and/or escalation policies

This API may be called a maximum of 60 times per minute.

victorops.api_public.v1.incidents.reroute.post({
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": "",
  "body": {
    "userName": "",
    "reroutes": []
  }
}, context)

Input

input object
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key
- body required RerouteCollection

Output

output RerouteStatusResponse

api_public.v1.incidents.resolve.patch

The incident(s) must be currently open. The user supplied must be a valid VictorOps user and a member of your organization.

This API may be called a maximum of 60 times per minute.

victorops.api_public.v1.incidents.resolve.patch({
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": "",
  "body": {
    "userName": "",
    "incidentNames": []
  }
}, context)

Input

input object
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key
- body required AckOrResolveRequest

Output

output AckOrResolveResponse

api_public.v1.maintenancemode.get

Get an organization's current maintenance mode state

victorops.api_public.v1.maintenancemode.get({
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": ""
}, context)

Input

input object
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key

Output

output MaintenanceModeState

api_public.v1.maintenancemode.start.post

Start maintenance mode for routing keys

victorops.api_public.v1.maintenancemode.start.post({
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": "",
  "body": {}
}, context)

Input

input object
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key
- body required object
  - names array: Routing keys that maintenance mode state covers. An empty list indicates global maintenance mode
    - items string
  - purpose string: the reason for the maintenance mode
  - type string (values: RoutingKeys)

Output

output MaintenanceModeState

api_public.v1.maintenancemode.maintenancemodeid.end.put

End maintenance mode for routing keys

victorops.api_public.v1.maintenancemode.maintenancemodeid.end.put({
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": "",
  "maintenancemodeid": ""
}, context)

Input

input object
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key
- maintenancemodeid required string: The id of the maintenance mode found in the active maintenance mode object

Output

output MaintenanceModeState

api_public.v1.oncall.current.get

Get all on-call users/teams for your organization.

This API may be called a maximum of 60 times per minute.

victorops.api_public.v1.oncall.current.get({
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": ""
}, context)

Input

input object
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key

Output

output object
- teamsOnCall array
  - items OnCallTeamsResource

api_public.v1.org.routing_keys.get

Retrieves a list of routing keys and associated teams. This API may be called a maximum of 60 times per minute.

victorops.api_public.v1.org.routing_keys.get({
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": ""
}, context)

Input

input object
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key

Output

output ListRoutingKeysResponse

api_public.v1.overrides.get

List all the scheduled overrides on the organization

This API may be called a maximum of 60 times per minute.

victorops.api_public.v1.overrides.get({
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": ""
}, context)

Input

input object
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key

Output

output object
- _selfUrl string
- overrides array
  - items ScheduledOverride

api_public.v1.overrides.post

Creates a new scheduled override. Start and end dates are in ISO8601 format. E.g. 2018-09-28'T'05:00:00Z

This API may be called a maximum of 60 times per minute.

victorops.api_public.v1.overrides.post({
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": "",
  "body": {}
}, context)

Input

input object
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key
- body required ScheduledOverridePayload

Output

output object
- _selfUrl string
- schedule ScheduledOverride

api_public.v1.overrides.publicId.delete

Deletes a scheduled override

This API may be called a maximum of 60 times per minute.

victorops.api_public.v1.overrides.publicId.delete({
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": "",
  "publicId": ""
}, context)

Input

input object
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key
- publicId required string: The publicId of the scheduled override

Output

Output schema unknown

api_public.v1.overrides.publicId.get

Get the specified scheduled override

This API may be called a maximum of 60 times per minute.

victorops.api_public.v1.overrides.publicId.get({
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": "",
  "publicId": ""
}, context)

Input

input object
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key
- publicId required string: The publicId of the scheduled override

Output

output object
- _selfUrl string
- override ScheduledOverride

api_public.v1.overrides.publicId.assignments.get

Get the specified scheduled override assignments

This API may be called a maximum of 60 times per minute.

victorops.api_public.v1.overrides.publicId.assignments.get({
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": "",
  "publicId": ""
}, context)

Input

input object
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key
- publicId required string: The publicId of the scheduled override

Output

output array
- items Assignment

api_public.v1.overrides.publicId.assignments.policySlug.delete

Delete the scheduled override assignment

This API may be called a maximum of 60 times per minute.

victorops.api_public.v1.overrides.publicId.assignments.policySlug.delete({
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": "",
  "publicId": "",
  "policySlug": ""
}, context)

Input

input object
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key
- publicId required string: The publicId of the scheduled override
- policySlug required string: The policySlug of the assignment

Output

output Assignment

api_public.v1.overrides.publicId.assignments.policySlug.get

Get the specified scheduled override assignments

This API may be called a maximum of 60 times per minute.

victorops.api_public.v1.overrides.publicId.assignments.policySlug.get({
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": "",
  "publicId": "",
  "policySlug": ""
}, context)

Input

input object
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key
- publicId required string: The publicId of the scheduled override
- policySlug required string: The policySlug of the assignment

Output

output Assignment

api_public.v1.overrides.publicId.assignments.policySlug.put

Update the scheduled override assignment

This API may be called a maximum of 60 times per minute.

victorops.api_public.v1.overrides.publicId.assignments.policySlug.put({
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": "",
  "publicId": "",
  "policySlug": "",
  "body": {
    "policy": ""
  }
}, context)

Input

input object
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key
- publicId required string: The publicId of the scheduled override
- policySlug required string: The policySlug of the assignment
- body required UpdateAssignment

Output

output Assignment

api_public.v1.policies.get

Retrieves a list of escalation policy information. This API may be called a maximum of once a minute.

victorops.api_public.v1.policies.get({
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": ""
}, context)

Input

input object
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key

Output

output EscalationPolicyInfoList

api_public.v1.policies.types.contacts.get

Get the available contact types

description: "Email Address", type: "email" description: "Phone Number", type: "phone"

This API may be called a maximum of 60 times per minute.

victorops.api_public.v1.policies.types.contacts.get({
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": ""
}, context)

Input

input object
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key

Output

output object
- _selfUrl string
- contactTypes array
  - items ContactObject

api_public.v1.policies.types.notifications.get

Get the available notification types

description: "Send a push notification to all my devices", type: "push" description: "Send an email to an email address", type: "email" description: "Send an SMS to a phone number", type: "sms" description: "Make a phone call to a phone number", type: "phone"

This API may be called a maximum of 60 times per minute.

victorops.api_public.v1.policies.types.notifications.get({
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": ""
}, context)

Input

input object
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key

Output

output object
- _selfUrl string
- notificationTypes array
  - items NotificationObject

api_public.v1.policies.types.timeouts.get

Get the available timeout values

description: "If still unacked after 1 minute", type: 1 description: "If still unacked after 5 minutes", type: 5 description: "If still unacked after 10 minutes", type: 10 description: "If still unacked after 15 minutes", type: 15 description: "If still unacked after 20 minutes", type: 20 description: "If still unacked after 25 minutes", type: 25 description: "If still unacked after 30 minutes", type: 30 description: "If still unacked after 45 minutes", type: 45 description: "If still unacked after 60 minutes", type: 60

This API may be called a maximum of 60 times per minute.

victorops.api_public.v1.policies.types.timeouts.get({
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": ""
}, context)

Input

input object
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key

Output

output object
- _selfUrl string
- timeoutTypes array
  - items TimeoutObject

api_public.v1.policies.policy.oncall.user.patch

Replaces a currently on-call user in the escalation policy with another. In many cases, the policy slug will match the slug of the team that contains it.

This API may be called a maximum of 60 times per minute.

victorops.api_public.v1.policies.policy.oncall.user.patch({
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": "",
  "body": {
    "fromUser": "",
    "toUser": ""
  },
  "policy": ""
}, context)

Input

input object
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key
- body required TakeRequest
- policy required string: The VictorOps policy 'slug'

Output

output TakeResult

api_public.v1.profile.username.policies.get

Get all the paging policy steps for the user on the org associated with the API key

This API may be called a maximum of 60 times per minute.

victorops.api_public.v1.profile.username.policies.get({
  "username": "",
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": ""
}, context)

Input

input object
- username required string: Your username
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key

Output

output object
- _selfUrl string
- steps UserPagingPolicy

api_public.v1.profile.username.policies.post

Create a paging policy step

This API may be called a maximum of 60 times per minute.

victorops.api_public.v1.profile.username.policies.post({
  "username": "",
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": "",
  "body": {}
}, context)

Input

input object
- username required string: Your username
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key
- body required AddGroupPayload

Output

output object
- _selfUrl string
- step PagingPolicyStep

api_public.v1.profile.username.policies.step.get

Get a paging policy step

This API may be called a maximum of 60 times per minute.

victorops.api_public.v1.profile.username.policies.step.get({
  "username": "",
  "step": 0,
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": ""
}, context)

Input

input object
- username required string: Your username
- step required number: Paging policy step
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key

Output

output object
- _selfUrl string
- step PagingPolicyStep

api_public.v1.profile.username.policies.step.post

Create a rule for a paging policy step

This API may be called a maximum of 60 times per minute.

victorops.api_public.v1.profile.username.policies.step.post({
  "username": "",
  "step": 0,
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": "",
  "body": {}
}, context)

Input

input object
- username required string: Your username
- step required number: Paging policy step
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key
- body required AddStepPayload

Output

output object
- _selfUrl string
- stepRule PagingPolicyStepRule

api_public.v1.profile.username.policies.step.put

Update a paging policy step

This API may be called a maximum of 60 times per minute.

victorops.api_public.v1.profile.username.policies.step.put({
  "username": "",
  "step": 0,
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": "",
  "body": {}
}, context)

Input

input object
- username required string: Your username
- step required number: Paging policy step
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key
- body required AddGroupPayload

Output

output object
- _selfUrl string
- step PagingPolicyStep

api_public.v1.profile.username.policies.step.rule.delete

Delete a rule from a paging policy step

This API may be called a maximum of 60 times per minute.

victorops.api_public.v1.profile.username.policies.step.rule.delete({
  "username": "",
  "step": 0,
  "rule": 0,
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": ""
}, context)

Input

input object
- username required string: Your username
- step required number: Paging policy step
- rule required number: Rule for a paging policy step
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key

Output

output object
- _selfUrl string
- stepRule PagingPolicyStepRule

api_public.v1.profile.username.policies.step.rule.get

Get a rule from a paging policy step

This API may be called a maximum of 60 times per minute.

victorops.api_public.v1.profile.username.policies.step.rule.get({
  "username": "",
  "step": 0,
  "rule": 0,
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": ""
}, context)

Input

input object
- username required string: Your username
- step required number: Paging policy step
- rule required number: Rule for a paging policy step
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key

Output

output object
- _selfUrl string
- stepRule PagingPolicyStepRule

api_public.v1.profile.username.policies.step.rule.put

Update a rule for a paging policy step

This API may be called a maximum of 60 times per minute.

victorops.api_public.v1.profile.username.policies.step.rule.put({
  "username": "",
  "step": 0,
  "rule": 0,
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": "",
  "body": {}
}, context)

Input

input object
- username required string: Your username
- step required number: Paging policy step
- rule required number: Rule for a paging policy step
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key
- body required AddStepPayload

Output

output object
- _selfUrl string
- stepRule PagingPolicyStepRule

api_public.v1.team.get

Get a list of teams for your organization.

This API may be called a maximum of 60 times per minute.

victorops.api_public.v1.team.get({
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": ""
}, context)

Input

input object
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key

Output

output ListTeamResponse

api_public.v1.team.post

Add a team to your organization.

This API may be called a maximum of 60 times per minute.

victorops.api_public.v1.team.post({
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": "",
  "body": {
    "name": ""
  }
}, context)

Input

input object
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key
- body required AddTeamPayload

Output

output AddTeamResponse

api_public.v1.team.team.delete

Remove a team from your organization.

This API may be called a maximum of 60 times per minute.

victorops.api_public.v1.team.team.delete({
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": "",
  "team": ""
}, context)

Input

input object
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key
- team required string: The VictorOps team to be deleted

Output

Output schema unknown

api_public.v1.team.team.get

Get the information for the specified team.

This API may be called a maximum of 60 times per minute.

victorops.api_public.v1.team.team.get({
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": "",
  "team": ""
}, context)

Input

input object
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key
- team required string: The VictorOps team to fetch

Output

output AddTeamResponse

api_public.v1.team.team.put

Update the designated team

This API may be called a maximum of 60 times per minute.

victorops.api_public.v1.team.team.put({
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": "",
  "team": "",
  "body": {
    "name": ""
  }
}, context)

Input

input object
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key
- team required string: The VictorOps team to be updated
- body required AddTeamPayload

Output

output AddTeamResponse

api_public.v1.team.team.admins.get

Get the team admins for the specified team.

This API may be called a maximum of 60 times per minute.

victorops.api_public.v1.team.team.admins.get({
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": "",
  "team": ""
}, context)

Input

input object
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key
- team required string: The VictorOps team

Output

output TeamAdminsResponse

api_public.v1.team.team.members.get

Get the members for the specified team.

This API may be called a maximum of 60 times per minute.

victorops.api_public.v1.team.team.members.get({
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": "",
  "team": ""
}, context)

Input

input object
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key
- team required string: The VictorOps team to fetch

Output

output ListTeamMembersResponse

api_public.v1.team.team.members.post

Add a team member to your team.

This API may be called a maximum of 60 times per minute.

victorops.api_public.v1.team.team.members.post({
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": "",
  "team": "",
  "body": {
    "username": ""
  }
}, context)

Input

input object
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key
- team required string: The VictorOps team to fetch
- body required AddTeamMemberPayload

Output

output ListTeamMembersResponse

api_public.v1.team.team.members.user.delete

Remove a team from your organization.

This API may be called a maximum of 60 times per minute.

victorops.api_public.v1.team.team.members.user.delete({
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": "",
  "team": "",
  "user": "",
  "body": {
    "replacement": ""
  }
}, context)

Input

input object
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key
- team required string: The VictorOps team to be deleted
- user required string: The team member username
- body required RemoveTeamMemberPayload

Output

Output schema unknown

api_public.v1.team.team.oncall.schedule.get

NOTE: This call is deprecated. Please use GET /api-public/v2/team/{team}/oncall/schedule.

Get the on-call schedule for a team, including on-call overrides.

This API may be called a maximum of 60 times per minute.

victorops.api_public.v1.team.team.oncall.schedule.get({
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": "",
  "team": ""
}, context)

Input

input object
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key
- team required string: The VictorOps team 'slug'
- daysForward number: Days to include in returned schedule (30 max)
- daysSkip number: Days to skip before computing schedule to return (90 max)
- step number: Step of escalation policy (3 max)

Output

output OnCallAndOverrides

api_public.v1.team.team.oncall.user.patch

NOTE: This API call is deprecated. Please use PATCH /api-public/v2/policies/{policy}/oncall/user

Replaces a currently on-call user on the team with another.

This API may be called a maximum of 60 times per minute.

victorops.api_public.v1.team.team.oncall.user.patch({
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": "",
  "body": {
    "fromUser": "",
    "toUser": ""
  },
  "team": ""
}, context)

Input

input object
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key
- body required TakeRequest
- team required string: The VictorOps team 'slug'

Output

output TakeResult

api_public.v1.team.team.policies.get

Get the escalation policies for the specified team.

This API may be called a maximum of 60 times per minute.

victorops.api_public.v1.team.team.policies.get({
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": "",
  "team": ""
}, context)

Input

input object
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key
- team required string: The VictorOps team to fetch

Output

output EscalationPolicyList

api_public.v1.user.get

Get a list of users for your organization

This API may be called a maximum of 60 times per minute.

victorops.api_public.v1.user.get({
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": ""
}, context)

Input

input object
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key

Output

output ListUserResponse

api_public.v1.user.post

Add a user to your organization

This API may be called a maximum of 60 times per minute.

victorops.api_public.v1.user.post({
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": "",
  "body": {
    "firstName": "",
    "lastName": "",
    "username": "",
    "email": ""
  }
}, context)

Input

input object
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key
- body required AddUserPayload

Output

output AddUserResponse

api_public.v1.user.user.delete

Remove a user from your organization. If no replacement is specified, an empty JSON payload ("{}") is still required.

This API may be called a maximum of 60 times per minute.

victorops.api_public.v1.user.user.delete({
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": "",
  "user": "",
  "body": {}
}, context)

Input

input object
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key
- user required string: The VictorOps user to be deleted
- body required DeleteUserPayload

Output

Output schema unknown

api_public.v1.user.user.get

Get the information for the specified user

This API may be called a maximum of 60 times per minute.

victorops.api_public.v1.user.user.get({
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": "",
  "user": ""
}, context)

Input

input object
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key
- user required string: The VictorOps user to fetch

Output

output AddUserResponse

api_public.v1.user.user.put

Update the designated user

This API may be called a maximum of 60 times per minute.

victorops.api_public.v1.user.user.put({
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": "",
  "user": "",
  "body": {
    "firstName": "",
    "lastName": "",
    "username": "",
    "email": ""
  }
}, context)

Input

input object
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key
- user required string: The VictorOps user to be updated
- body required AddUserPayload

Output

output AddUserResponse

api_public.v1.user.user.contact_methods.get

Get the contact methods for a user

This API may be called a maximum of 60 times per minute.

victorops.api_public.v1.user.user.contact_methods.get({
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": "",
  "user": ""
}, context)

Input

input object
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key
- user required string: The VictorOps user ID

Output

output object
- devices array
  - items ContactDevice
- emails array
  - items UserContact
- phones array
  - items UserContact

api_public.v1.user.user.contact_methods.devices.get

Get the contact methods for a user

This API may be called a maximum of 60 times per minute.

victorops.api_public.v1.user.user.contact_methods.devices.get({
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": "",
  "user": ""
}, context)

Input

input object
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key
- user required string: The VictorOps user ID

Output

output array
- items ContactDevice

api_public.v1.user.user.contact_methods.devices.contactId.delete

Delete a contact device for a user

This API may be called a maximum of 60 times per minute.

victorops.api_public.v1.user.user.contact_methods.devices.contactId.delete({
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": "",
  "user": "",
  "contactId": ""
}, context)

Input

input object
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key
- user required string: The VictorOps user ID
- contactId required string: The unique contact identifier

Output

output ContactDevice

api_public.v1.user.user.contact_methods.devices.contactId.get

Get the indicated contact device for a user

This API may be called a maximum of 60 times per minute.

victorops.api_public.v1.user.user.contact_methods.devices.contactId.get({
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": "",
  "user": "",
  "contactId": ""
}, context)

Input

input object
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key
- user required string: The VictorOps user ID
- contactId required string: The unique contact identifier

Output

output array
- items ContactDevice

api_public.v1.user.user.contact_methods.devices.contactId.put

Update a contact device for a user

This API may be called a maximum of 60 times per minute.

victorops.api_public.v1.user.user.contact_methods.devices.contactId.put({
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": "",
  "user": "",
  "contactId": "",
  "body": {}
}, context)

Input

input object
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key
- user required string: The VictorOps user ID
- contactId required string: The unique contact identifier
- body required ContactDeviceAdd

Output

output ContactDevice

api_public.v1.user.user.contact_methods.emails.get

Get the contact emails for a user

This API may be called a maximum of 60 times per minute.

victorops.api_public.v1.user.user.contact_methods.emails.get({
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": "",
  "user": ""
}, context)

Input

input object
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key
- user required string: The VictorOps user ID

Output

output array
- items UserContact

api_public.v1.user.user.contact_methods.emails.post

Create a contact email for a user

This API may be called a maximum of 60 times per minute.

victorops.api_public.v1.user.user.contact_methods.emails.post({
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": "",
  "user": "",
  "body": {
    "label": "",
    "email": ""
  }
}, context)

Input

input object
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key
- user required string: The VictorOps user ID
- body required ContactEmailAdd

Output

output UserContact

api_public.v1.user.user.contact_methods.emails.contactId.delete

Delete the indicated contact email for the user

This API may be called a maximum of 60 times per minute.

victorops.api_public.v1.user.user.contact_methods.emails.contactId.delete({
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": "",
  "user": "",
  "contactId": ""
}, context)

Input

input object
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key
- user required string: The VictorOps user ID
- contactId required string: The unique contact identifier

Output

output UserContact

api_public.v1.user.user.contact_methods.emails.contactId.get

Get the indicated contact email for a user

This API may be called a maximum of 60 times per minute.

victorops.api_public.v1.user.user.contact_methods.emails.contactId.get({
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": "",
  "user": "",
  "contactId": ""
}, context)

Input

input object
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key
- user required string: The VictorOps user ID
- contactId required string: The unique contact identifier

Output

output array
- items UserContact

api_public.v1.user.user.contact_methods.phones.get

Get the contact phones for a user

This API may be called a maximum of 60 times per minute.

victorops.api_public.v1.user.user.contact_methods.phones.get({
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": "",
  "user": ""
}, context)

Input

input object
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key
- user required string: The VictorOps user ID

Output

output array
- items UserContact

api_public.v1.user.user.contact_methods.phones.post

Create a contact phone for a user

This API may be called a maximum of 60 times per minute.

victorops.api_public.v1.user.user.contact_methods.phones.post({
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": "",
  "user": "",
  "body": {
    "label": "",
    "phone": ""
  }
}, context)

Input

input object
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key
- user required string: The VictorOps user ID
- body required ContactPhoneAdd

Output

output UserContact

api_public.v1.user.user.contact_methods.phones.contactId.delete

Delete the indicated contact phone for the user

This API may be called a maximum of 60 times per minute.

victorops.api_public.v1.user.user.contact_methods.phones.contactId.delete({
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": "",
  "user": "",
  "contactId": ""
}, context)

Input

input object
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key
- user required string: The VictorOps user ID
- contactId required string: The unique contact identifier

Output

output UserContact

api_public.v1.user.user.contact_methods.phones.contactId.get

Get the indicated contact phone for a user

This API may be called a maximum of 60 times per minute.

victorops.api_public.v1.user.user.contact_methods.phones.contactId.get({
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": "",
  "user": "",
  "contactId": ""
}, context)

Input

input object
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key
- user required string: The VictorOps user ID
- contactId required string: The unique contact identifier

Output

output array
- items UserContact

api_public.v1.user.user.oncall.schedule.get

NOTE: This call is deprecated. Please use GET /api-public/v2/user/{user}/oncall/schedule.

Get the on-call schedule for a user for all teams, including on-call overrides.

This API may be called a maximum of 60 times per minute.

victorops.api_public.v1.user.user.oncall.schedule.get({
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": "",
  "user": ""
}, context)

Input

input object
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key
- user required string: The VictorOps user ID
- daysForward number: Days to include in returned schedule (30 max)
- daysSkip number: Days to skip before computing schedule to return (90 max)
- step number: Step of escalation policy (3 max)

Output

output array
- items OnCallAndOverrides

api_public.v1.user.user.policies.get

Get paging policies for a user

This API may be called a maximum of 60 times per minute.

victorops.api_public.v1.user.user.policies.get({
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": "",
  "user": ""
}, context)

Input

input object
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key
- user required string: The VictorOps user ID

Output

output Policies

api_public.v1.user.user.teams.get

This API may be called a maximum of 60 times per minute.

victorops.api_public.v1.user.user.teams.get({
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": "",
  "user": ""
}, context)

Input

input object
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key
- user required string: The VictorOps user

Output

output UserTeamsResponse

api_public.v2.team.team.oncall.schedule.get

Get the on-call schedule for a team, including on-call overrides.

This API may be called a maximum of 60 times per minute.

victorops.api_public.v2.team.team.oncall.schedule.get({
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": "",
  "team": ""
}, context)

Input

input object
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key
- team required string: The VictorOps team 'slug'
- daysForward number: Days to include in returned schedule (30 max)
- daysSkip number: Days to skip before computing schedule to return (90 max)
- step number: Step of escalation policy (3 max)

Output

output TeamSchedule

api_public.v2.user.user.oncall.schedule.get

Get the on-call schedule for a user for all teams the user is on, including on-call overrides.

This API may be called a maximum of 60 times per minute.

victorops.api_public.v2.user.user.oncall.schedule.get({
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": "",
  "user": ""
}, context)

Input

input object
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key
- user required string: The VictorOps user ID
- daysForward number: Days to include in returned schedule (30 max)
- daysSkip number: Days to skip before computing schedule to return (90 max)
- step number: Step of escalation policy (3 max)

Output

output UserSchedule

api_reporting.v1.incidents.get

NOTE: This call is deprecated. Please use GET /api-reporting/v2/incidents.

Retrieve incident history for your company, searching over date ranges and with filtering options. This is historical data, and may be up to 15 minutes behind real-time incident data. By default, only resolved incidents will be returned.

This API may be called a maximum of once a minute.

Incident requests are paginated with a offset and limit query string parameters. The query for incidents is run and offset records are skipped, after which limit records will be returned.

The default offset is 0 and the default limit is 20. The maximum value allowed for limit is 100.

On return, the total number of records available for that query will be returned in the payload as 'total'.

victorops.api_reporting.v1.incidents.get({
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": ""
}, context)

Input

input object
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key
- offset number: The offset within the set of matching incidents
- limit number: The maximum number of matching incidents to return (100 max)
- entityId string: The entity ID involved This is the unique identifier for the entity causing the incident.
- incidentNumber string: The incident number as shown in VictorOps Multiple values and ranges are allowed: 4,5,20:50
- startedAfter string: Return incidents started after this timestamp Specify the timestamp in ISO8601 format
- startedBefore string: Find incidents started before this timestamp Specify the timestamp in ISO8601 format
- host string: The host involved in the incident Multiple values can be separated with commas.
- service string: The service involved in the incident (if any) Multiple values can be separated with commas.
- currentPhase string: The current phase of the incident "resolved", "triggered" or "acknowledged". Multiple values can be separated with commas.

Output

output array
- items IncidentList

api_reporting.v1.team.team.oncall.log.get

Returns a log of user shift changes for the specified team. This is historical data, and may be up to 15 minutes behind real-time log data.

This API may be called a maximum of 60 times per minute.

victorops.api_reporting.v1.team.team.oncall.log.get({
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": "",
  "team": ""
}, context)

Input

input object
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key
- team required string: The VictorOps team 'slug'
- start string: Return shift changes occurring after this timestamp. The default is the start of the day at midnight. Specify the timestamp in ISO8601 format
- end string: Return shift changes occurring before this timestamp. The default is the end of the day at 11:59:59. Specify the timestamp in ISO8601 format
- userName string: The VictorOps user ID. Return shift changes occurring during the interval specified for this user. Without this parameter, all relevant users (with respect to the specified interval) are returned

Output

output OnCallLog

api_reporting.v2.incidents.get

Retrieve incident history for your company, searching over date ranges and with filtering options.

This API may be called a maximum of once a minute.

Incident requests are paginated with a offset and limit query string parameters. The query for incidents is run and offset records are skipped, after which limit records will be returned.

The default offset is 0 and the default limit is 20. The maximum value allowed for limit is 100.

Unless specified otherwise with the parameter currentPhase, the response will only contain resolved incidents.

On return, the total number of records available for that query will be returned in the payload as 'total'.

victorops.api_reporting.v2.incidents.get({
  "X-VO-Api-Id": "",
  "X-VO-Api-Key": ""
}, context)

Input

input object
- X-VO-Api-Id required string: Your API ID
- X-VO-Api-Key required string: Your API Key
- offset number: The offset within the set of matching incidents
- limit number: The maximum number of matching incidents to return (100 max)
- entityId string: The entity ID involved This is the unique identifier for the entity causing the incident.
- incidentNumber string: The incident number as shown in VictorOps Multiple values and ranges are allowed: 4,5,20:50
- startedAfter string: Return incidents started after this timestamp Specify the timestamp in ISO8601 format
- startedBefore string: Find incidents started before this timestamp Specify the timestamp in ISO8601 format
- host string: The host involved in the incident Multiple values can be separated with commas.
- service string: The service involved in the incident (if any) Multiple values can be separated with commas.
- currentPhase string: The current phase of the incident "resolved", "triggered" or "acknowledged". Multiple values can be separated with commas. By default, response contains only "resolved" incidents
- routingKey string: The original routing of the incident

Output

output ActiveIncidentList

Definitions

AckOrResolveByUserRequest

AckOrResolveByUserRequest object
- message string
- userName required string

AckOrResolveRequest

AckOrResolveRequest object
- incidentNames required array
  - items string
- message string
- userName required string

AckOrResolveResponse

AckOrResolveResponse object: The results of ack/resolve for each incident
- results array
  - items AckOrResolveResult

AckOrResolveResult

AckOrResolveResult object: The results of ack/resolve for a individual incident
- cmdAccepted boolean
- entityId string
- incidentNumber string
- message string

AckUser

AckUser object: A JSON object with first/last name and email of the user that acknowledged the incident.
- email string
- first string
- last string

ActiveIncidentInfo

ActiveIncidentInfo object: Incidents contain the following fields (all should be considered optional)
- alertCount number: The number of alerts received for this incident
- currentPhase string: The current phase of the incident "resolved", "triggered" or "acknowledged".
- entityId string: The unique identification of the entity being monitored that caused the incident
- host string: The host on which the incident occurred
- incidentNumber string: The VictorOps incident number
- lastAlertId string: The unique id of the last alert for the incident
- lastAlertTime string: The time of the last alert received for the incident
- pagedPolicies array: The escalation policies that were triggered for the incident
  - items EscalationPolicyInfo
- pagedTeams array: The teams that were paged for the incident
  - items string
- pagedUsers array: The users that were paged for the incident.
  - items string
- service string: The service name causing the incident (if any)
- startTime string: The time the incident started
- transitions array: Transitions of the incident state over time
  - items IncidentTransition

ActiveIncidentList

ActiveIncidentList object: The list of incidents in various states
- incidents array: The incident data
  - items ActiveIncidentInfo

ActiveMaintenanceMode

ActiveMaintenanceMode object
- instanceId string: external friendly unique id for maintenance mode
- isGlobal boolean: whether this instance is a global maintenance mode or for specific routing keys
- startedAt number: millis from epoch marking the start time
- startedBy string: username of the user that started maintenance mode
- targets array
  - items MaintenanceModeTarget

AddGroupPayload

AddGroupPayload object
- rules array
  - items PagingPolicyStepRuleAdd
- timeout TimeoutType

AddStepPayload

AddStepPayload object
- contact Contact
- type NotificationType

AddTeamMemberPayload

AddTeamMemberPayload object: The user information
- username required string

AddTeamPayload

AddTeamPayload object: The team information
- name required string

AddTeamResponse

AddTeamResponse TeamDetail

AddUserPayload

AddUserPayload object: The user information
- admin boolean
- email required string
- expirationHours number: The validity duration for the invitatation/set password link sent to the added user.
- firstName required string
- lastName required string
- username required string

AddUserResponse

AddUserResponse V1User

Assignment

Assignment object
- _selfUrl string
- assigned boolean
- policy string
- team string
- user string

Contact

Contact object
- id number
- type ContactType

ContactDescription

ContactDescription string (values: Email Address, Phone Number)

ContactDevice

ContactDevice object
- _selfUrl string
- deviceType string
- extId string
- label string

ContactDeviceAdd

ContactDeviceAdd object: The contact device
- chat_escalation_sound string
- device_label string
- escalation_notification_sound string
- resolved_notification_sound string

ContactEmailAdd

ContactEmailAdd object: The contact email
- email required string
- label required string
- rank integer

ContactObject

ContactObject object
- description ContactDescription
- type ContactType

ContactPhoneAdd

ContactPhoneAdd object: The contact phone
- label required string
- phone required string
- rank integer

ContactType

ContactType string (values: email, phone)

CreateIncidentRequest

CreateIncidentRequest object
- details required string
- summary required string
- targets required array
  - items IncidentTarget
- userName required string

CreatedIncident

CreatedIncident object
- error string: An error message
- incidentNumber string: The VictorOps incident number

DeleteUserPayload

DeleteUserPayload object: The information about what to do with the deleted user
- replacement string: The user to take the place of the deleted user in escalations

EscalationPolicy

EscalationPolicy object
- name string
- slug string

EscalationPolicyInfo

EscalationPolicyInfo object
- policy required EscalationPolicy
- team Team

EscalationPolicyInfoList

EscalationPolicyInfoList object
- policies required array
  - items EscalationPolicyInfo

EscalationPolicyList

EscalationPolicyList object
- policies array
  - items EscalationPolicy

GetAlertResponse

GetAlertResponse object: Alert details. All fields should be considered optional.
- ackAuthor string: The user that acknowledged the incident.
- ackMsg string: A user entered comment for the acknowledgment.
- entityDisplayName string: Used within VictorOps to display a human-readable name for the entity.
- entityId string: Identifies the entity (host, service, etc.) this alert was about.
- messageType string: The type of alert; INFO, WARNING, ACKNOWLEDGEMENT, CRITICAL, RECOVERY
- monitoringTool string: The name of the monitoring system software (eg. nagios, icinga, sensu, etc.)
- raw string: The full, raw alert details JSON string (i.e. parse the string into a JSON object)
- stateMessage string: Any additional status information from the alert item.
- stateStartTime number: The time this entity entered its current state (seconds since epoch).
- timestamp number: Timestamp of the alert in seconds since epoch.

IncidentInfo

IncidentInfo object: Incidents contain the following fields (all should be considered optional)
- ackTime string: The time of the last acknowledgment of the incident
- ackUser AckUser
- ackUserId string: The VictorOps user id of the user that acknowledged the incident
- alertCount number: The number of alerts received for this incident
- currentPhase string: The current phase of the incident "resolved", "triggered" or "acknowledged".
- endTime string: The time the incident ended
- entityDispName string: The display name of the entity causing the incident
- entityId string: The unique identification of the entity being monitored that caused the incident
- entityType string: The type of entity causing the incident (host/service)
- host string: The host on which the incident occurred
- incidentNumber string: The VictorOps incident number
- lastAlertID string: The unique id of the last alert for the incident
- lastAlertTime string: The time of the last alert received for the incident
- service string: The service name causing the incident (if any)
- startTime string: The time the incident started
- teams string: The teams that were paged for the incident (comma separated).

IncidentList

IncidentList object: The results of an incident history request
- incidents array: An array of incident objects matching the search
  - items IncidentInfo
- limit number: The limit value passed in the request
- offset number: The offset passed in the request
- total number: The total number of incidents available for this search

IncidentTarget

IncidentTarget object
- slug required string: User name or escalation policy slug
- type required string (values: User, EscalationPolicy): Type of target

IncidentTransition

IncidentTransition object: A transition of incident state
- alertId string: The unique alert ID that caused the transition
- alertUrl string: A URL to retrieve the details of the alert that caused the transition
- at string: The time of the transition
- by string: The user that caused the transition (if any)
- manually boolean: If the incident transition was caused by a person
- message string: The message entered by that user (if any)
- name string: The transition name

ListRoutingKeysResponse

ListRoutingKeysResponse object: Info about routing keys in the org
- _selfUrl string
- routingKeys array
  - items RoutingKeyInfo

ListTeamMembersResponse

ListTeamMembersResponse object: A list of members for the team
- _selfUrl string
- _teamUrl string
- members array
  - items TeamMember

ListTeamResponse

ListTeamResponse array
- items TeamDetail

ListUserResponse

ListUserResponse object: Some info about the user
- _selfUrl string
- users array
  - items V1User

MaintenanceModeState

MaintenanceModeState object
- activeInstances array
  - items ActiveMaintenanceMode
- companyId string

MaintenanceModeTarget

MaintenanceModeTarget object
- names array: Routing keys that maintenance mode state covers. An empty list indicates global maintenance mode
  - items string
- type string (values: RoutingKeys)

NotificationDescription

NotificationDescription string (values: Send a push notification to all my devices, Send an email to an email address, Send an SMS to a phone number, Make a phone call to a phone number)

NotificationObject

NotificationObject object
- description NotificationDescription
- type NotificationType

NotificationType

NotificationType string (values: push, email, sms, phone)

OnCallAndOverrides

OnCallAndOverrides object
- overrides array
  - items TeamScheduleOverlayResource
- schedule array
  - items TeamScheduleResource
- team string

OnCallEntry

OnCallEntry object
- onCallType required OnCallType
- onCallUser User
- overrideOnCallUser User
- rolls required array
  - items OnCallRoll
- rotationName string
- shiftName string
- shiftRoll string: The shift roll time (ISO 8601)

OnCallEscalationPolicyResource

OnCallEscalationPolicyResource object
- name string
- slug string

OnCallInterval

OnCallInterval object
- duration object
  - hours number
  - minutes number
- escalationPolicy EscalationPolicy
- off string
- on string

OnCallLog

OnCallLog object
- end string
- start string
- teamSlug string
- userLogs array
  - items UserLog

OnCallNowResource

OnCallNowResource object
- escalationPolicy OnCallEscalationPolicyResource
- users array
  - items OnCallUsersResource

OnCallOverride

OnCallOverride object
- end string: The override end time (ISO 8601)
- origOnCallUser User
- overrideOnCallUser User
- start string: The override start time (ISO 8601)

OnCallRoll

OnCallRoll object
- end required string: The on-call period end time (ISO 8601)
- isRoll required boolean
- onCallUser User
- start required string: The on-call period start time (ISO 8601)

OnCallTeamResource

OnCallTeamResource object
- name string
- slug string

OnCallTeamsResource

OnCallTeamsResource object
- onCallNow array
  - items OnCallNowResource
- team OnCallTeamResource

OnCallType

OnCallType string (values: user, rotation_group, rotation_group_next, rotation_group_previous, team, team_routing, webhook, email, policy_routing)

OnCallUsersResource

OnCallUsersResource object
- onCallUser object
  - username string

PagingPolicy

PagingPolicy object: Paging policy fields
- contactType string
- extId string
- order integer
- timeout integer

PagingPolicyStep

PagingPolicyStep object
- index number
- rules array
  - items PagingPolicyStepRule
- timeout TimeoutType

PagingPolicyStepRule

PagingPolicyStepRule object
- contact Contact
- index number
- type NotificationType

PagingPolicyStepRuleAdd

PagingPolicyStepRuleAdd object
- contact Contact
- type NotificationType

Policies

Policies object: Paging policies accociated which this user
- policies array
  - items PagingPolicy
- userId integer
- username string

PolicySchedule

PolicySchedule object
- overrides array
  - items OnCallOverride
- policy EscalationPolicy
- schedule array
  - items OnCallEntry

RemoveTeamMemberPayload

RemoveTeamMemberPayload object: The user information
- replacement required string

Reroute

Reroute object
- incidentNumber required string
- targets required array
  - items IncidentTarget

RerouteCollection

RerouteCollection object
- reroutes required array
  - items Reroute
- userName required string

RerouteStatus

RerouteStatus object
- incidentNumber required string
- message string
- success required boolean
- targetStatus required array
  - items RerouteTargetStatus

RerouteStatusResponse

RerouteStatusResponse object
- statuses array
  - items RerouteStatus

RerouteTargetStatus

RerouteTargetStatus object
- message string
- slug required string: User name or escalation policy slug
- success required boolean

RoutingKeyInfo

RoutingKeyInfo object: Routing keys contain the following fields
- isDefault boolean
- routingKey string
- targets array
  - items RoutingKeyTarget

RoutingKeyTarget

RoutingKeyTarget object: Routing key target
- _teamUrl string
- policyName string
- policySlug string

ScheduledOverride

ScheduledOverride object
- assignments array
  - items Assignment
- end string: The override end time (ISO 8601)
- publicId string
- start string: The override start time (ISO 8601).
- timezone string

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

@datafire/victorops

Installation and Usage

Description

Actions

api_public.v1.alerts.uuid.get

Input

Output

api_public.v1.incidents.get

Input

Output

api_public.v1.incidents.post

Input

Output

api_public.v1.incidents.ack.patch

Input

Output

api_public.v1.incidents.byUser.ack.patch

Input

Output

api_public.v1.incidents.byUser.resolve.patch

Input

Output

api_public.v1.incidents.reroute.post

Input

Output

api_public.v1.incidents.resolve.patch

Input

Output

api_public.v1.maintenancemode.get

Input

Output

api_public.v1.maintenancemode.start.post

Input

Output

api_public.v1.maintenancemode.maintenancemodeid.end.put

Input

Output

api_public.v1.oncall.current.get

Input

Output

api_public.v1.org.routing_keys.get

Input

Output

api_public.v1.overrides.get

Input

Output

api_public.v1.overrides.post

Input

Output

api_public.v1.overrides.publicId.delete

Input

Output

api_public.v1.overrides.publicId.get

Input

Output

api_public.v1.overrides.publicId.assignments.get

Input

Output

api_public.v1.overrides.publicId.assignments.policySlug.delete

Input

Output

api_public.v1.overrides.publicId.assignments.policySlug.get

Input

Output

api_public.v1.overrides.publicId.assignments.policySlug.put

Input

Output

api_public.v1.policies.get

Input

Output

api_public.v1.policies.types.contacts.get

Input

Output

api_public.v1.policies.types.notifications.get