Skip to content

VictorOps API

by victorops.com

No authHTTPSDevelopment
Open documentation ↗

Overview

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.

VictorOps is a development API from victorops.com. It needs no API key. It is served over HTTPS. Its OpenAPI description documents 72 endpoints.

At a glance

Authentication
No auth
HTTPS
Yes
CORS
Unknown
Category
Development
Base URL
https://api.victorops.com/
Version
0.0.3
Endpoints
72
Spec updated
2019-07-22

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL
curl -X GET "https://api.victorops.com/api-public/v1/incidents" \
  -H "Accept: application/json"
JavaScript
const response = await fetch("https://api.victorops.com/api-public/v1/incidents", {
  method: "GET",
  headers: {
    "Accept": "application/json",
  },
});
const data = await response.json();
console.log(data);
Python
import requests

response = requests.request(
    "GET",
    "https://api.victorops.com/api-public/v1/incidents",
    headers={
    "Accept": "application/json",
    },
    timeout=30,
)
print(response.json())

Endpoints

MethodPathWhat it does
GET/api-public/v1/alerts/{uuid}Retrieve alert details.
GET/api-public/v1/incidentsGet current incident information
POST/api-public/v1/incidentsCreate a new incident
PATCH/api-public/v1/incidents/ackAcknowledge an incident or list of incidents
PATCH/api-public/v1/incidents/byUser/ackAcknowledge all incidents for which a user was paged.
PATCH/api-public/v1/incidents/byUser/resolveResolve all incidents for which a user was paged.
POST/api-public/v1/incidents/rerouteReroute one or more incidents to one or more new routable destinations.
PATCH/api-public/v1/incidents/resolveResolve an incident or list of incidents
GET/api-public/v1/maintenancemodeGet an organization's current maintenance mode state
POST/api-public/v1/maintenancemode/startStart maintenance mode for routing keys
PUT/api-public/v1/maintenancemode/{maintenancemodeid}/endEnd maintenance mode for routing keys
GET/api-public/v1/oncall/currentGet an organization's on-call users
GET/api-public/v1/org/routing-keysList routing keys with associated teams
GET/api-public/v1/overridesList the scheduled overrides
POST/api-public/v1/overridesCreates a new scheduled override
GET/api-public/v1/overrides/{publicId}Get the specified scheduled override
DELETE/api-public/v1/overrides/{publicId}Deletes a scheduled override
GET/api-public/v1/overrides/{publicId}/assignmentsGet the specified scheduled override
GET/api-public/v1/overrides/{publicId}/assignments/{policySlug}Get the specified scheduled override assignment
PUT/api-public/v1/overrides/{publicId}/assignments/{policySlug}Update the scheduled override assignment
DELETE/api-public/v1/overrides/{publicId}/assignments/{policySlug}Delete the scheduled override assignment
GET/api-public/v1/policiesGet escalation policy info
GET/api-public/v1/policies/types/contactsGet the available contact types
GET/api-public/v1/policies/types/notificationsGet the available notification types
GET/api-public/v1/policies/types/timeoutsGet the available timeout values
PATCH/api-public/v1/policies/{policy}/oncall/userCreate an on-call override (take on-call)
GET/api-public/v1/profile/{username}/policiesGet the user's paging policy
POST/api-public/v1/profile/{username}/policiesCreate a paging policy step
GET/api-public/v1/profile/{username}/policies/{step}Get a paging policy step
POST/api-public/v1/profile/{username}/policies/{step}Create a rule for a paging policy step
PUT/api-public/v1/profile/{username}/policies/{step}Update a paging policy step
GET/api-public/v1/profile/{username}/policies/{step}/{rule}Get a rule from a paging policy step
PUT/api-public/v1/profile/{username}/policies/{step}/{rule}Update a rule for a paging policy step
DELETE/api-public/v1/profile/{username}/policies/{step}/{rule}Delete a rule from a paging policy step
GET/api-public/v1/teamList teams
POST/api-public/v1/teamAdd a team
GET/api-public/v1/team/{team}Retrieve information for a team
PUT/api-public/v1/team/{team}Update a team
DELETE/api-public/v1/team/{team}Remove a team
GET/api-public/v1/team/{team}/adminsRetrieve a list of team admins for a team
GET/api-public/v1/team/{team}/membersRetrieve a list of members for a team
POST/api-public/v1/team/{team}/membersAdd a team member
DELETE/api-public/v1/team/{team}/members/{user}Remove a team member
GET/api-public/v1/team/{team}/oncall/scheduledeprecatedGet a team's on-call schedule
PATCH/api-public/v1/team/{team}/oncall/userdeprecatedCreate an on-call override (take on-call)
GET/api-public/v1/team/{team}/policiesRetrieve a list of escalation policies for a team
GET/api-public/v1/userList users
POST/api-public/v1/userAdd a user
GET/api-public/v1/user/{user}Retrieve information for a user
PUT/api-public/v1/user/{user}Update a user
DELETE/api-public/v1/user/{user}Remove a user
GET/api-public/v1/user/{user}/contact-methodsGet a list of all contact methods for a user
GET/api-public/v1/user/{user}/contact-methods/devicesGet a list of all contact devices for a user
GET/api-public/v1/user/{user}/contact-methods/devices/{contactId}Get the indicated contact device for a user
PUT/api-public/v1/user/{user}/contact-methods/devices/{contactId}Update a contact device for a user
DELETE/api-public/v1/user/{user}/contact-methods/devices/{contactId}Delete a contact device for a user
GET/api-public/v1/user/{user}/contact-methods/emailsGet a list of all contact emails for a user
POST/api-public/v1/user/{user}/contact-methods/emailsCreate a contact emails for a user
GET/api-public/v1/user/{user}/contact-methods/emails/{contactId}Get the indicated contact email for a user
DELETE/api-public/v1/user/{user}/contact-methods/emails/{contactId}Delete a contact email for a user
GET/api-public/v1/user/{user}/contact-methods/phonesGet a list of all contact phones for a user
POST/api-public/v1/user/{user}/contact-methods/phonesCreate a contact phones for a user
GET/api-public/v1/user/{user}/contact-methods/phones/{contactId}Get the indicated contact phone for a user
DELETE/api-public/v1/user/{user}/contact-methods/phones/{contactId}Delete a contact phone for a user
GET/api-public/v1/user/{user}/oncall/scheduledeprecatedGet a user's on-call schedule
GET/api-public/v1/user/{user}/policiesGet a list of paging policies for a user
GET/api-public/v1/user/{user}/teamsRetrieve the user's team membership
GET/api-public/v2/team/{team}/oncall/scheduleGet a team's on-call schedule
GET/api-public/v2/user/{user}/oncall/scheduleGet a user's on-call schedule
GET/api-reporting/v1/incidentsdeprecatedGet/search incident history
GET/api-reporting/v1/team/{team}/oncall/logA list of shift changes for a team
GET/api-reporting/v2/incidentsGet/search incident history

Questions

Does the VictorOps API need an API key?

No. The VictorOps API can be called without an API key or sign-up, which makes it handy for prototypes and front-end demos.

Does the VictorOps API support HTTPS?

Yes, the VictorOps API is served over HTTPS.

How many endpoints does the VictorOps API have?

Its OpenAPI description lists 72 endpoints in version 0.0.3. All of them are shown on this page.

What are alternatives to the VictorOps API?

Other Development APIs include Cloudflare, Azure DevOps, IPify, App Store Connect API, StackExchange.

Compare alternatives →

Listed from APIs.guru (CC0).