VictorOps
victorops · Developer Tools
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 t
Authentication
Sample Requests
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, af
Hover any highlighted part to learn what it does
| X-VO-Api-Id | example |
| X-VO-Api-Key | example |
curl -X GET "https://api.apis.guru/v2/specs/victorops.com/0.0.3/api-reporting/v2/incidents?host=example&limit=20&offset=0&service=example&entityId=example&routingKey=example¤tPhase=example&startedAfter=example&startedBefore=example&incidentNumber=example" \ -H "X-VO-Api-Id: example" \ -H "X-VO-Api-Key: example"
import requests
params = {
"host": "example",
"limit": "20",
"offset": "0",
"service": "example",
"entityId": "example",
"routingKey": "example",
"currentPhase": "example",
"startedAfter": "example",
"startedBefore": "example",
"incidentNumber": "example"
}
headers = {
"X-VO-Api-Id": "example",
"X-VO-Api-Key": "example"
}
response = requests.get(
"https://api.apis.guru/v2/specs/victorops.com/0.0.3/api-reporting/v2/incidents",
params=params,
headers=headers,
)
print(response.json())const url = new URL('https://api.apis.guru/v2/specs/victorops.com/0.0.3/api-reporting/v2/incidents');
url.searchParams.set('host', 'example');
url.searchParams.set('limit', '20');
url.searchParams.set('offset', '0');
url.searchParams.set('service', 'example');
url.searchParams.set('entityId', 'example');
url.searchParams.set('routingKey', 'example');
url.searchParams.set('currentPhase', 'example');
url.searchParams.set('startedAfter', 'example');
url.searchParams.set('startedBefore', 'example');
url.searchParams.set('incidentNumber', 'example');
const response = await fetch(url, {
headers: {
'X-VO-Api-Id': 'example',
'X-VO-Api-Key': 'example'
},
});
const data = await response.json();
console.log(data);package main
import (
"fmt"
"io"
"net/http"
"net/url"
)
func main() {
baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/victorops.com/0.0.3/api-reporting/v2/incidents")
q := baseURL.Query()
q.Set("host", "example")
q.Set("limit", "20")
q.Set("offset", "0")
q.Set("service", "example")
q.Set("entityId", "example")
q.Set("routingKey", "example")
q.Set("currentPhase", "example")
q.Set("startedAfter", "example")
q.Set("startedBefore", "example")
q.Set("incidentNumber", "example")
baseURL.RawQuery = q.Encode()
targetURL := baseURL.String()
req, _ := http.NewRequest("GET", targetURL, nil)
req.Header.Set("X-VO-Api-Id", "example")
req.Header.Set("X-VO-Api-Key", "example")
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}require "net/http"
require "json"
uri = URI("https://api.apis.guru/v2/specs/victorops.com/0.0.3/api-reporting/v2/incidents")
uri.query = URI.encode_www_form({
"host" => "example",
"limit" => "20",
"offset" => "0",
"service" => "example",
"entityId" => "example",
"routingKey" => "example",
"currentPhase" => "example",
"startedAfter" => "example",
"startedBefore" => "example",
"incidentNumber" => "example"
})
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"
req = Net::HTTP::Get.new(uri)
req["X-VO-Api-Id"] = "example"
req["X-VO-Api-Key"] = "example"
res = http.request(req)
puts JSON.parse(res.body)<?php
$url = "https://api.apis.guru/v2/specs/victorops.com/0.0.3/api-reporting/v2/incidents?" . http_build_query([
"host" => "example",
"limit" => "20",
"offset" => "0",
"service" => "example",
"entityId" => "example",
"routingKey" => "example",
"currentPhase" => "example",
"startedAfter" => "example",
"startedBefore" => "example",
"incidentNumber" => "example"
]);
$opts = ["http" => [
"method" => "GET",
"header" => implode("\r\n", [
"X-VO-Api-Id: example",
"X-VO-Api-Key: example"
]),
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));Get a list of the currently open, acknowledged and recently resolved incidents. This API may be called a maximum of 60 times per minute.
Hover any highlighted part to learn what it does
| X-VO-Api-Id | example |
| X-VO-Api-Key | example |
curl -X GET "https://api.apis.guru/v2/specs/victorops.com/0.0.3/api-public/v1/incidents" \ -H "X-VO-Api-Id: example" \ -H "X-VO-Api-Key: example"
import requests
headers = {
"X-VO-Api-Id": "example",
"X-VO-Api-Key": "example"
}
response = requests.get(
"https://api.apis.guru/v2/specs/victorops.com/0.0.3/api-public/v1/incidents",
headers=headers,
)
print(response.json())const url = 'https://api.apis.guru/v2/specs/victorops.com/0.0.3/api-public/v1/incidents';
const response = await fetch(url, {
headers: {
'X-VO-Api-Id': 'example',
'X-VO-Api-Key': 'example'
},
});
const data = await response.json();
console.log(data);package main
import (
"fmt"
"io"
"net/http"
)
func main() {
targetURL := "https://api.apis.guru/v2/specs/victorops.com/0.0.3/api-public/v1/incidents"
req, _ := http.NewRequest("GET", targetURL, nil)
req.Header.Set("X-VO-Api-Id", "example")
req.Header.Set("X-VO-Api-Key", "example")
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}require "net/http"
require "json"
uri = URI("https://api.apis.guru/v2/specs/victorops.com/0.0.3/api-public/v1/incidents")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"
req = Net::HTTP::Get.new(uri)
req["X-VO-Api-Id"] = "example"
req["X-VO-Api-Key"] = "example"
res = http.request(req)
puts JSON.parse(res.body)<?php
$url = "https://api.apis.guru/v2/specs/victorops.com/0.0.3/api-public/v1/incidents";
$opts = ["http" => [
"method" => "GET",
"header" => implode("\r\n", [
"X-VO-Api-Id: example",
"X-VO-Api-Key: example"
]),
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));Get an organization's current maintenance mode state
Hover any highlighted part to learn what it does
| X-VO-Api-Id | example |
| X-VO-Api-Key | example |
curl -X GET "https://api.apis.guru/v2/specs/victorops.com/0.0.3/api-public/v1/maintenancemode" \ -H "X-VO-Api-Id: example" \ -H "X-VO-Api-Key: example"
import requests
headers = {
"X-VO-Api-Id": "example",
"X-VO-Api-Key": "example"
}
response = requests.get(
"https://api.apis.guru/v2/specs/victorops.com/0.0.3/api-public/v1/maintenancemode",
headers=headers,
)
print(response.json())const url = 'https://api.apis.guru/v2/specs/victorops.com/0.0.3/api-public/v1/maintenancemode';
const response = await fetch(url, {
headers: {
'X-VO-Api-Id': 'example',
'X-VO-Api-Key': 'example'
},
});
const data = await response.json();
console.log(data);package main
import (
"fmt"
"io"
"net/http"
)
func main() {
targetURL := "https://api.apis.guru/v2/specs/victorops.com/0.0.3/api-public/v1/maintenancemode"
req, _ := http.NewRequest("GET", targetURL, nil)
req.Header.Set("X-VO-Api-Id", "example")
req.Header.Set("X-VO-Api-Key", "example")
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}require "net/http"
require "json"
uri = URI("https://api.apis.guru/v2/specs/victorops.com/0.0.3/api-public/v1/maintenancemode")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"
req = Net::HTTP::Get.new(uri)
req["X-VO-Api-Id"] = "example"
req["X-VO-Api-Key"] = "example"
res = http.request(req)
puts JSON.parse(res.body)<?php
$url = "https://api.apis.guru/v2/specs/victorops.com/0.0.3/api-public/v1/maintenancemode";
$opts = ["http" => [
"method" => "GET",
"header" => implode("\r\n", [
"X-VO-Api-Id: example",
"X-VO-Api-Key: example"
]),
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));Postman Setup Guide
- See official documentation for authentication and setup.
What can you build with VictorOps?
VictorOps is a Developer Tools API. Developers commonly use developer tools APIs for:
- automating code review and quality checks
- integrating CI/CD pipelines and build systems
- managing feature flags and A/B tests
- monitoring errors and application performance
- generating and validating test data
No authentication required. This API is open — no signup or key needed. Ideal for quick prototypes and public-facing features. VictorOps is free to use, making it a low-risk choice to experiment with.
New to APIs? Read our beginner's guide · Learn about API keys · What is REST?