doc.overops.com

 

Main OverOps API.

All calls must be authenticated using one of the following methods:

  1. Using username:password.
  2. Using x-api-key header (To generate the token, go to Settings --> Account Settings in the OverOps App)
Suggest Edits

List all environments

List all environments accessible to the calling user

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
gethttps://api.overops.com/api/v1/services
curl --request GET \
  --url https://api.overops.com/api/v1/services
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/services")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.overops.com/api/v1/services");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

name
string

Environment key name

Response

List of all accessible environments to the calling user

servicesarray

list of environment

Unauthorized

Suggest Edits

Generate a new environment key

Defines a new environment

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
posthttps://api.overops.com/api/v1/services
curl --request POST \
  --url https://api.overops.com/api/v1/services
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.overops.com/api/v1/services' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/services")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.overops.com/api/v1/services");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

name
string

Response

New environment key properties

idstring
namestring
full_keystring

Unauthorized

Suggest Edits

Get information about the environment (Not yet implemented)

Get information about the environment (Not yet implemented)

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
gethttps://api.overops.com/api/v1/services/env_id
curl --request GET \
  --url https://api.overops.com/api/v1/services/env_id
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/env_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/services/env_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.overops.com/api/v1/services/env_id");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/env_id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

Response

TBD

Unauthorized

Suggest Edits

Rename an environment

Rename an environment. This call is allowed for admins only

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
posthttps://api.overops.com/api/v1/services/env_id
curl --request POST \
  --url https://api.overops.com/api/v1/services/env_id
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.overops.com/api/v1/services/env_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/services/env_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.overops.com/api/v1/services/env_id");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/env_id"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

Body Params

name
string

Response

Updated environment properties

idstring
namestring
full_keystring

Unauthorized

Suggest Edits

Get environment settings

Get environment settings

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
gethttps://api.overops.com/api/v1/services/env_id/settings
curl --request GET \
  --url https://api.overops.com/api/v1/services/env_id/settings
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/env_id/settings' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/services/env_id/settings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.overops.com/api/v1/services/env_id/settings");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/env_id/settings"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

Response

TBD

Unauthorized

Suggest Edits

List servers

List all (or just active) servers that were used to monitor applications. These can be either the IP/Hostname of a host or a cluster identifier. How to name your Server

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
gethttps://api.overops.com/api/v1/services/env_id/servers
curl --request GET \
  --url https://api.overops.com/api/v1/services/env_id/servers
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/env_id/servers' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/services/env_id/servers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.overops.com/api/v1/services/env_id/servers");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/env_id/servers"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

Query Params

active
boolean

Show only active servers

Response

List of servers

Unauthorized

Suggest Edits

List applications

List all (or just active) applications that were used to monitor applications. These can be either an application name, an integration suite name or a specific instance. How to name your Application

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
gethttps://api.overops.com/api/v1/services/env_id/applications
curl --request GET \
  --url https://api.overops.com/api/v1/services/env_id/applications
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/env_id/applications' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/services/env_id/applications")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.overops.com/api/v1/services/env_id/applications");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/env_id/applications"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

Query Params

active
boolean

Show only active applications

Response

List of applications

Unauthorized

Suggest Edits

List deployments

List all (or just active) deployments that were monitoring in the environment. These can be either the Jenkins build number, Git commit, Maven version, etc. How to tag your deployment

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
gethttps://api.overops.com/api/v1/services/env_id/deployments
curl --request GET \
  --url https://api.overops.com/api/v1/services/env_id/deployments
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/env_id/deployments' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/services/env_id/deployments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.overops.com/api/v1/services/env_id/deployments");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/env_id/deployments"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

Query Params

active
boolean

Show only active deployments

Response

List of deployments

Unauthorized

Suggest Edits

Get storage settings of an environment

In Hybrid OverOps installation, data collected from your JVMs is locally redacted for PII and encrypted using your private encryption key before it is stored in a server that resides behind your firewall. Use this API call to fetch the current settings of your storage server. Visit OverOps Hybrid Deployment Overview for full information

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
gethttps://api.overops.com/api/v1/services/env_id/settings/storage-settings
curl --request GET \
  --url https://api.overops.com/api/v1/services/env_id/settings/storage-settings
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/env_id/settings/storage-settings' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/services/env_id/settings/storage-settings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.overops.com/api/v1/services/env_id/settings/storage-settings");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/env_id/settings/storage-settings"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment to use

Response

Storage settings

typestring
hostnamestring

Relevant for hybrid storage only. Both hostname and ip may be used. For cloud storage, NA value will be returned

frontend_hostnamestring

OPTIONAL Relevant for hybrid storage only. Both hostname and ip may be used. For cloud storage, NA value will be returned

Unauthorized

Not Found

Suggest Edits

Set storage settings for a service

In Hybrid OverOps installation, data collected from your JVMs is locally redacted for PII and encrypted using your private encryption key before it is stored in a server that resides behind your firewall. This API call allows you to configure your storage server as part of your Hybrid OverOps setup. Visit OverOps Hybrid Deployment Overview for full information

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
posthttps://api.overops.com/api/v1/services/env_id/settings/storage-settings
curl --request POST \
  --url https://api.overops.com/api/v1/services/env_id/settings/storage-settings
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.overops.com/api/v1/services/env_id/settings/storage-settings' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/services/env_id/settings/storage-settings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.overops.com/api/v1/services/env_id/settings/storage-settings");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/env_id/settings/storage-settings"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment to use

Body Params

type
string
hostname
string

Relevant for hybrid storage only. Both hostname and ip may be used. For cloud storage, NA value will be returned

frontend_hostname
string

OPTIONAL Relevant for hybrid storage only. Both hostname and ip may be used. For cloud storage, NA value will be returned

Response

OK

Bad Request

Unauthorized

Not Found

Suggest Edits

Batch Force events snapshots

Force next snapshot for multiple events

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
posthttps://api.overops.com/api/v1/services/env_id/events/force-snapshots
curl --request POST \
  --url https://api.overops.com/api/v1/services/env_id/events/force-snapshots
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.overops.com/api/v1/services/env_id/events/force-snapshots' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/services/env_id/events/force-snapshots")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.overops.com/api/v1/services/env_id/events/force-snapshots");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/env_id/events/force-snapshots"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

Body Params

items
array of objects
event_id

Response

OK

Bad Request

Unauthorized

Not Found

Suggest Edits

Fetch event data

Fetch event data

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
gethttps://api.overops.com/api/v1/services/env_id/events/event_id
curl --request GET \
  --url https://api.overops.com/api/v1/services/env_id/events/event_id
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/env_id/events/event_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/services/env_id/events/event_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.overops.com/api/v1/services/env_id/events/event_id");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/env_id/events/event_id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

event_id
string
required

Event to use

Response

Event data

idstring
summarystring
typestring
namestring
messagestring
first_seenstring
introduced_bystring
labelsarray
similar_event_idsarray
jira_issue_urlstring
error_locationobject

A code location, for error location, etc

error_location.prettified_namestring
error_location.class_namestring
error_location.method_namestring
error_location.method_descstring
entry_pointobject

A code location, for error location, etc

entry_point.prettified_namestring
entry_point.class_namestring
entry_point.method_namestring
entry_point.method_descstring
error_originobject

A code location, for error location, etc

error_origin.prettified_namestring
error_origin.class_namestring
error_origin.method_namestring
error_origin.method_descstring
statsobject
stats.hitsinteger
stats.invocationsinteger

Unauthorized

Not Found

Suggest Edits

Fetch event snapshot

Fetch event snapshot. Fetches the last relevant snapshot for the specific filters provided. All filters are optional.

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
gethttps://api.overops.com/api/v1/services/env_id/events/event_id/snapshot
curl --request GET \
  --url 'https://api.overops.com/api/v1/services/env_id/events/event_id/snapshot?from=from&to=to'
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/env_id/events/event_id/snapshot',
  qs: 
   { from: 'from',
     to: 'to' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/services/env_id/events/event_id/snapshot?from=from&to=to")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.overops.com/api/v1/services/env_id/events/event_id/snapshot?from=from&to=to");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/env_id/events/event_id/snapshot"

querystring = {"from":"from","to":"to"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

event_id
string
required

Event to use

Query Params

from
string
required

Start time of requested events. Date in ISO8601 format (yyyy-MM-ddTHH:mm:ss.SSSZZ)

to
string
required

Start time of requested events. Date in ISO8601 format (yyyy-MM-ddTHH:mm:ss.SSSZZ)

server
string

Server(s) added to the filter

app
string

Application(s) added to the filter

deployment
string

Deployment(s) added to the filter

similar_event_id
string

Event(s) added to the filter

Response

Link to snapshot

linkstring

Unauthorized

Not Found

Suggest Edits

Delete all event snapshots

Removes all existing snapshots for an event. All snapshots will be permanently deleted. Event statistics will be kept.

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
deletehttps://api.overops.com/api/v1/services/env_id/events/event_id/snapshots
curl --request DELETE \
  --url https://api.overops.com/api/v1/services/env_id/events/event_id/snapshots
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.overops.com/api/v1/services/env_id/events/event_id/snapshots' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/services/env_id/events/event_id/snapshots")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.overops.com/api/v1/services/env_id/events/event_id/snapshots");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/env_id/events/event_id/snapshots"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

event_id
string
required

Event to use

Response

OK

Unauthorized

Not Found

Suggest Edits

Force Event Snapshot

Force snapshot for the next time the event occurs

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
posthttps://api.overops.com/api/v1/services/env_id/events/event_id/force-snapshot
curl --request POST \
  --url https://api.overops.com/api/v1/services/env_id/events/event_id/force-snapshot
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.overops.com/api/v1/services/env_id/events/event_id/force-snapshot' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/services/env_id/events/event_id/force-snapshot")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.overops.com/api/v1/services/env_id/events/event_id/force-snapshot");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/env_id/events/event_id/force-snapshot"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

event_id
string
required

Event to use

Response

OK

Unauthorized

Suggest Edits

Fetch event actions

Fetch event actions

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
gethttps://api.overops.com/api/v1/services/env_id/events/event_id/actions
curl --request GET \
  --url https://api.overops.com/api/v1/services/env_id/events/event_id/actions
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/env_id/events/event_id/actions' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/services/env_id/events/event_id/actions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.overops.com/api/v1/services/env_id/events/event_id/actions");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/env_id/events/event_id/actions"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

event_id
string
required

Event to use

Query Params

type
string

Filter by specific type

Response

Event actions

Unauthorized

Not Found

Suggest Edits

Move to Inbox

Move the specified event into Inbox

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
posthttps://api.overops.com/api/v1/services/env_id/events/event_id/inbox
curl --request POST \
  --url https://api.overops.com/api/v1/services/env_id/events/event_id/inbox
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.overops.com/api/v1/services/env_id/events/event_id/inbox' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/services/env_id/events/event_id/inbox")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.overops.com/api/v1/services/env_id/events/event_id/inbox");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/env_id/events/event_id/inbox"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

event_id
string
required

Event to use

Query Params

force
boolean

Force adding labels, even if it exists

handle_similar_events
boolean

Change the labels on all similar events

Response

OK

Unauthorized

Not Found

Suggest Edits

Move to Trash

Move the specified event into Trash

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
posthttps://api.overops.com/api/v1/services/env_id/events/event_id/delete
curl --request POST \
  --url https://api.overops.com/api/v1/services/env_id/events/event_id/delete
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.overops.com/api/v1/services/env_id/events/event_id/delete' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/services/env_id/events/event_id/delete")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.overops.com/api/v1/services/env_id/events/event_id/delete");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/env_id/events/event_id/delete"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

event_id
string
required

Event to use

Query Params

force
boolean

Force adding labels, even if it exists

handle_similar_events
boolean

Change the labels on all similar events

Response

OK

Unauthorized

Not Found

Suggest Edits

Mark as resolved

Marks the specified event as resolved

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
posthttps://api.overops.com/api/v1/services/env_id/events/event_id/resolve
curl --request POST \
  --url https://api.overops.com/api/v1/services/env_id/events/event_id/resolve
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.overops.com/api/v1/services/env_id/events/event_id/resolve' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/services/env_id/events/event_id/resolve")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.overops.com/api/v1/services/env_id/events/event_id/resolve");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/env_id/events/event_id/resolve"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

event_id
string
required

Event to use

Query Params

force
boolean

Force adding labels, even if it exists

handle_similar_events
boolean

Change the labels on all similar events

Response

OK

Unauthorized

Not Found

Suggest Edits

List labels

List all existing labels

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
gethttps://api.overops.com/api/v1/services/env_id/labels
curl --request GET \
  --url https://api.overops.com/api/v1/services/env_id/labels
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/env_id/labels' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/services/env_id/labels")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.overops.com/api/v1/services/env_id/labels");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/env_id/labels"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

Response

List of labels

labelsarray

Unauthorized

Suggest Edits

Create new label

Create a new label. Labels are used to tag events with custom classifications. Labels help support use cases such as classifying an event as severe / regressed, assign it to a specific developer or team (e.g prod-team-A) or any other user defined categorization.

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
posthttps://api.overops.com/api/v1/services/env_id/labels
curl --request POST \
  --url https://api.overops.com/api/v1/services/env_id/labels
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.overops.com/api/v1/services/env_id/labels' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/services/env_id/labels")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.overops.com/api/v1/services/env_id/labels");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/env_id/labels"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

Body Params

name
string
type
string
color
string
created_on
string

Label creation time. Date in ISO8601 format (yyyy-MM-ddTHH:mm:ss.SSSZ)

created_by
string

View creator

Response

OK

Bad Request

Unauthorized

Conflict

Suggest Edits

Batch Add/Remove labels

Append/Detach labels to/from events

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
posthttps://api.overops.com/api/v1/services/env_id/events/labels
curl --request POST \
  --url https://api.overops.com/api/v1/services/env_id/events/labels
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.overops.com/api/v1/services/env_id/events/labels' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/services/env_id/events/labels")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.overops.com/api/v1/services/env_id/events/labels");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/env_id/events/labels"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

Query Params

force
boolean

Force adding labels, even if it exists

handle_similar_events
boolean

Change the labels on all similar events

Body Params

items
array of objects
event_id
add
remove

Response

OK

Bad Request

Unauthorized

Not Found

Suggest Edits

Add/Remove labels

Append and remove label(s) from an event

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
posthttps://api.overops.com/api/v1/services/env_id/events/event_id/labels
curl --request POST \
  --url https://api.overops.com/api/v1/services/env_id/events/event_id/labels
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.overops.com/api/v1/services/env_id/events/event_id/labels' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/services/env_id/events/event_id/labels")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.overops.com/api/v1/services/env_id/events/event_id/labels");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/env_id/events/event_id/labels"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

event_id
string
required

Event to use

Query Params

force
boolean

Force adding labels, even if it exists

handle_similar_events
boolean

Change the labels on all similar events

Body Params

add
array of strings
remove
array of strings

Response

OK

Bad Request

Unauthorized

Not Found

Suggest Edits

List views

List views

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
gethttps://api.overops.com/api/v1/services/env_id/views
curl --request GET \
  --url https://api.overops.com/api/v1/services/env_id/views
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/env_id/views' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/services/env_id/views")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.overops.com/api/v1/services/env_id/views");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/env_id/views"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

Response

List of views including basic info about each view.

viewsarray

Unauthorized

Suggest Edits

Create view

Create view

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
posthttps://api.overops.com/api/v1/services/env_id/views
curl --request POST \
  --url https://api.overops.com/api/v1/services/env_id/views
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.overops.com/api/v1/services/env_id/views' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/services/env_id/views")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.overops.com/api/v1/services/env_id/views");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/env_id/views"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

Body Params

name
string
description
string
shared
boolean
admin
boolean

Indicates that this view is accessible to environment admins only.

default
boolean

TBD - NOT YET IMPLEMENTED

filters
object

Filter properties

 
filters.first_seen
object

Defines the first time an event occured using a absolute time frame or a relative ime frame. If absolute time frame is defined, the relative will be ignored.

 
filters.first_seen.absolute
object
 
filters.first_seen.absolute.from
string

Start time. Date in ISO8601 format (yyyy-MM-ddTHH:mm:ss.SSSZZ)

filters.first_seen.absolute.to
string

End time. Date in ISO8601 format (yyyy-MM-ddTHH:mm:ss.SSSZZ)

filters.first_seen.relative
string
filters.labels
array of strings

List of labels

filters.event_type
array of strings

List of event types

filters.event_name
array of strings

List of event names

filters.event_location
array of strings

(Not implemented yet) List of event locations

filters.event_package
array of strings

List of event packages

filters.entry_point
array of strings

(Not implemented yet) List of entrypoints

filters.servers
array of strings

List of server names

filters.apps
array of strings

List of application names

filters.deployments
array of strings

List of deployment names

filters.introduced_by
array of strings

Filters events by deployment they originated in

filters.search
string

Free text search

Response

OK

Bad Request

Unauthorized

Conflict

Suggest Edits

Get view properties

Get full list of view properties

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
gethttps://api.overops.com/api/v1/services/env_id/views/view_id
curl --request GET \
  --url https://api.overops.com/api/v1/services/env_id/views/view_id
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/env_id/views/view_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/services/env_id/views/view_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.overops.com/api/v1/services/env_id/views/view_id");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/env_id/views/view_id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

view_id
string
required

View to use

Response

Full list of view properties

viewsarray

Unauthorized

Forbidden

Not Found

Suggest Edits

Edit view data

Edit view data

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
posthttps://api.overops.com/api/v1/services/env_id/views/view_id
curl --request POST \
  --url https://api.overops.com/api/v1/services/env_id/views/view_id
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.overops.com/api/v1/services/env_id/views/view_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/services/env_id/views/view_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.overops.com/api/v1/services/env_id/views/view_id");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/env_id/views/view_id"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

view_id
string
required

View to use

Body Params

name
string
description
string
shared
boolean
admin
boolean

Indicates that this view is accessible to environment admins only.

default
boolean

TBD - NOT YET IMPLEMENTED

filters
object

Filter properties

 
filters.first_seen
object

Defines the first time an event occured using a absolute time frame or a relative ime frame. If absolute time frame is defined, the relative will be ignored.

 
filters.first_seen.absolute
object
 
filters.first_seen.absolute.from
string

Start time. Date in ISO8601 format (yyyy-MM-ddTHH:mm:ss.SSSZZ)

filters.first_seen.absolute.to
string

End time. Date in ISO8601 format (yyyy-MM-ddTHH:mm:ss.SSSZZ)

filters.first_seen.relative
string
filters.labels
array of strings

List of labels

filters.event_type
array of strings

List of event types

filters.event_name
array of strings

List of event names

filters.event_location
array of strings

(Not implemented yet) List of event locations

filters.event_package
array of strings

List of event packages

filters.entry_point
array of strings

(Not implemented yet) List of entrypoints

filters.servers
array of strings

List of server names

filters.apps
array of strings

List of application names

filters.deployments
array of strings

List of deployment names

filters.introduced_by
array of strings

Filters events by deployment they originated in

filters.search
string

Free text search

Response

OK

Unauthorized

Forbidden

Not Found

Suggest Edits

Delete view

Delete view

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
deletehttps://api.overops.com/api/v1/services/env_id/views/view_id
curl --request DELETE \
  --url https://api.overops.com/api/v1/services/env_id/views/view_id
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.overops.com/api/v1/services/env_id/views/view_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/services/env_id/views/view_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.overops.com/api/v1/services/env_id/views/view_id");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/env_id/views/view_id"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

view_id
string
required

View to use

Response

OK

Unauthorized

Forbidden

Suggest Edits

Fetch events details

Fetch events data for a target timeframe, application / server / deployment set.

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
gethttps://api.overops.com/api/v1/services/env_id/views/view_id/events
curl --request GET \
  --url 'https://api.overops.com/api/v1/services/env_id/views/view_id/events?from=from&to=to'
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/env_id/views/view_id/events',
  qs: 
   { from: 'from',
     to: 'to' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/services/env_id/views/view_id/events?from=from&to=to")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.overops.com/api/v1/services/env_id/views/view_id/events?from=from&to=to");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/env_id/views/view_id/events"

querystring = {"from":"from","to":"to"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

view_id
string
required

View to use

Query Params

from
string
required

Start time of requested events. Date in ISO8601 format (yyyy-MM-ddTHH:mm:ss.SSSZZ)

to
string
required

Start time of requested events. Date in ISO8601 format (yyyy-MM-ddTHH:mm:ss.SSSZZ)

server
string

Server(s) added to the filter

app
string

Application(s) added to the filter

deployment
string

Deployment(s) added to the filter

stats
string

Include event volumes (e.g. number of event instances and calls into the method containing the event) in the response

Response

Event data

eventsarray

Unauthorized

Not Found

Suggest Edits

Fetch stats for all events in the specified view

Fetch stats for a target timeframe, application / server / deployment set.

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
gethttps://api.overops.com/api/v1/services/env_id/views/view_id/events/stats
curl --request GET \
  --url 'https://api.overops.com/api/v1/services/env_id/views/view_id/events/stats?from=from&to=to'
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/env_id/views/view_id/events/stats',
  qs: 
   { from: 'from',
     to: 'to' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/services/env_id/views/view_id/events/stats?from=from&to=to")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.overops.com/api/v1/services/env_id/views/view_id/events/stats?from=from&to=to");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/env_id/views/view_id/events/stats"

querystring = {"from":"from","to":"to"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

view_id
string
required

View to use

Query Params

from
string
required

Start time of requested events. Date in ISO8601 format (yyyy-MM-ddTHH:mm:ss.SSSZZ)

to
string
required

Start time of requested events. Date in ISO8601 format (yyyy-MM-ddTHH:mm:ss.SSSZZ)

server
string

Server(s) added to the filter

app
string

Application(s) added to the filter

deployment
string

Deployment(s) added to the filter

stats
string

return only selected stats. 'all' is default.

Response

Event stats

events-statsarray

Unauthorized

Not Found

Suggest Edits

Fetch entrypoints details

Fetch entrypoints data in a selected timeframe

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
gethttps://api.overops.com/api/v1/services/env_id/views/view_id/entrypoints
curl --request GET \
  --url 'https://api.overops.com/api/v1/services/env_id/views/view_id/entrypoints?from=from&to=to'
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/env_id/views/view_id/entrypoints',
  qs: 
   { from: 'from',
     to: 'to' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/services/env_id/views/view_id/entrypoints?from=from&to=to")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.overops.com/api/v1/services/env_id/views/view_id/entrypoints?from=from&to=to");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/env_id/views/view_id/entrypoints"

querystring = {"from":"from","to":"to"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

view_id
string
required

View to use

Query Params

from
string
required

Start time of requested events. Date in ISO8601 format (yyyy-MM-ddTHH:mm:ss.SSSZZ)

to
string
required

Start time of requested events. Date in ISO8601 format (yyyy-MM-ddTHH:mm:ss.SSSZZ)

server
string

Server(s) added to the filter

app
string

Application(s) added to the filter

deployment
string

Deployment(s) added to the filter

Response

Entrypoints data

entrypointsarray

Unauthorized

Not Found

Suggest Edits

Fetch event metrics

Fetch event metrics

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
gethttps://api.overops.com/api/v1/services/env_id/views/view_id/metrics/view/graph
curl --request GET \
  --url 'https://api.overops.com/api/v1/services/env_id/views/view_id/metrics/view/graph?from=from&to=to'
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/env_id/views/view_id/metrics/view/graph',
  qs: 
   { from: 'from',
     to: 'to' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/services/env_id/views/view_id/metrics/view/graph?from=from&to=to")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.overops.com/api/v1/services/env_id/views/view_id/metrics/view/graph?from=from&to=to");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/env_id/views/view_id/metrics/view/graph"

querystring = {"from":"from","to":"to"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

view_id
string
required

View to use

Query Params

from
string
required

Start time of requested graph. Date in ISO8601 format (yyyy-MM-ddTHH:mm:ss.SSSZ)

to
string
required

End time of requested graph. Date in ISO8601 format (yyyy-MM-ddTHH:mm:ss.SSSZ)

points
integer

Number of data points to return within the interval. IMPORTANT: either 'points' or 'resolution' parameters have to be passed. When both are passed, resolution takes precedence.

resolution
string

Select graph resolution (use M1/M5 for 1 point per 1/5 minutes; use H1/H8 for 1 point per 1/8 hours). IMPORTANT: either 'points' or 'resolution' parameters have to be passed. When both are passed, resolution takes precedence.

server
string

Server(s) added to the filter

app
string

Application(s) added to the filter

deployment
string

Deployment(s) added to the filter

stats
string

Include statistics per event in the response

Response

Event metrics

graphsarray

Unauthorized

Not Found

Suggest Edits

Fetch event metrics split by entrypoint

Fetch event metrics split by entrypoint

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
gethttps://api.overops.com/api/v1/services/env_id/views/view_id/metrics/entrypoint/graph
curl --request GET \
  --url 'https://api.overops.com/api/v1/services/env_id/views/view_id/metrics/entrypoint/graph?from=from&to=to'
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/env_id/views/view_id/metrics/entrypoint/graph',
  qs: 
   { from: 'from',
     to: 'to' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/services/env_id/views/view_id/metrics/entrypoint/graph?from=from&to=to")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.overops.com/api/v1/services/env_id/views/view_id/metrics/entrypoint/graph?from=from&to=to");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/env_id/views/view_id/metrics/entrypoint/graph"

querystring = {"from":"from","to":"to"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

view_id
string
required

View to use

Query Params

from
string
required

Start time of requested graph. Date in ISO8601 format (yyyy-MM-ddTHH:mm:ss.SSSZ)

to
string
required

End time of requested graph. Date in ISO8601 format (yyyy-MM-ddTHH:mm:ss.SSSZ)

points
integer

Number of data points to return within the interval. IMPORTANT: either 'points' or 'resolution' parameters have to be passed. When both are passed, resolution takes precedence.

resolution
string

Select graph resolution (use M1/M5 for 1 point per 1/5 minutes; use H1/H8 for 1 point per 1/8 hours). IMPORTANT: either 'points' or 'resolution' parameters have to be passed. When both are passed, resolution takes precedence.

server
string

Server(s) added to the filter

app
string

Application(s) added to the filter

deployment
string

Deployment(s) added to the filter

stats
string

Include statistics per event in the response

Response

Event metrics split by entry point

graphsarray

Unauthorized

Not Found

Suggest Edits

Fetch event metrics split by event

Fetch event metrics split by event

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
gethttps://api.overops.com/api/v1/services/env_id/views/view_id/metrics/event/graph
curl --request GET \
  --url 'https://api.overops.com/api/v1/services/env_id/views/view_id/metrics/event/graph?from=from&to=to'
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/env_id/views/view_id/metrics/event/graph',
  qs: 
   { from: 'from',
     to: 'to' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/services/env_id/views/view_id/metrics/event/graph?from=from&to=to")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.overops.com/api/v1/services/env_id/views/view_id/metrics/event/graph?from=from&to=to");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/env_id/views/view_id/metrics/event/graph"

querystring = {"from":"from","to":"to"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

view_id
string
required

View to use

Query Params

from
string
required

Start time of requested graph. Date in ISO8601 format (yyyy-MM-ddTHH:mm:ss.SSSZ)

to
string
required

End time of requested graph. Date in ISO8601 format (yyyy-MM-ddTHH:mm:ss.SSSZ)

points
integer

Number of data points to return within the interval. IMPORTANT: either 'points' or 'resolution' parameters have to be passed. When both are passed, resolution takes precedence.

resolution
string

Select graph resolution (use M1/M5 for 1 point per 1/5 minutes; use H1/H8 for 1 point per 1/8 hours). IMPORTANT: either 'points' or 'resolution' parameters have to be passed. When both are passed, resolution takes precedence.

server
string

Server(s) added to the filter

app
string

Application(s) added to the filter

deployment
string

Deployment(s) added to the filter

stats
string

Include statistics per event in the response

Response

event metrics split by event

graphsarray

Unauthorized

Not Found

Suggest Edits

Fetch View History

This call allows to get data about the creation and the last update to the view and provides information about the update initiator and timestamp.

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
gethttps://api.overops.com/api/v1/services/env_id/views/view_id/history
curl --request GET \
  --url https://api.overops.com/api/v1/services/env_id/views/view_id/history
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/env_id/views/view_id/history' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/services/env_id/views/view_id/history")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.overops.com/api/v1/services/env_id/views/view_id/history");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/env_id/views/view_id/history"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment to use

view_id
string
required

View to use

Response

View History

created_onstring

View creation time. Date in ISO8601 format (yyyy-MM-ddTHH:mm:ss.SSSZ)

creation_methodstring

View creation method

created_bystring

View creator

updated_onstring

View update time. Date in ISO8601 format (yyyy-MM-ddTHH:mm:ss.SSSZ)

update_methodstring

View update method

updated_bystring

updated by

Unauthorized

Not Found

Suggest Edits

Add view to selected category

Add view to selected category

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
posthttps://api.overops.com/api/v1/services/env_id/categories/category_id/views
curl --request POST \
  --url https://api.overops.com/api/v1/services/env_id/categories/category_id/views
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.overops.com/api/v1/services/env_id/categories/category_id/views' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/services/env_id/categories/category_id/views")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.overops.com/api/v1/services/env_id/categories/category_id/views");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/env_id/categories/category_id/views"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

category_id
string
required

View category to use

Response

OK

Unauthorized

Forbidden

Not Found

Suggest Edits

Alert on anomalies

Alert on anomalies

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
posthttps://api.overops.com/api/v1/services/env_id/views/view_id/anomaly
curl --request POST \
  --url https://api.overops.com/api/v1/services/env_id/views/view_id/anomaly
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.overops.com/api/v1/services/env_id/views/view_id/anomaly' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/services/env_id/views/view_id/anomaly")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.overops.com/api/v1/services/env_id/views/view_id/anomaly");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/env_id/views/view_id/anomaly"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

view_id
string
required

View to use

Body Params

desc
string
timeframe
object
 
timeframe.from
string
timeframe.to
string
timeframe.name
string
anomaly
object
 
anomaly.periods
array of objects
id
from
to
anomaly.contributors
array of objects
id
value

Response

OK

Unauthorized

Not Found

Suggest Edits

Fetch Default Alert Settings

Use this call to fetch default alert settings for selected environment

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
gethttps://api.overops.com/api/v1/services/env_id/settings/alerts
curl --request GET \
  --url https://api.overops.com/api/v1/services/env_id/settings/alerts
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/env_id/settings/alerts' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/services/env_id/settings/alerts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.overops.com/api/v1/services/env_id/settings/alerts");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/env_id/settings/alerts"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment to use

Response

List of alert defaults

emailobject
email.alert_meboolean
email.alert_all_team_membersboolean
email.alert_additional_emailsboolean
email.additional_emails_to_alertarray
slackobject
slack.inhook_urlstring
pager_dutyobject
pager_duty.service_integration_keystring
service_nowobject
service_now.urlstring
service_now.user_idstring
service_now.passwordstring
service_now.tablestring
hip_chatobject
hip_chat.tokenstring
hip_chat.roomstring
webhookobject
webhook.webhook_urlstring

Unauthorized

Not Found

Suggest Edits

Update Default Alert Settings

Use this call to update default alert settings for selected environment which will be used as initial settings for every new alert opened in this environment.

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
posthttps://api.overops.com/api/v1/services/env_id/settings/alerts
curl --request POST \
  --url https://api.overops.com/api/v1/services/env_id/settings/alerts
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.overops.com/api/v1/services/env_id/settings/alerts' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/services/env_id/settings/alerts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.overops.com/api/v1/services/env_id/settings/alerts");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/env_id/settings/alerts"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment to use

Body Params

email
object
 
email.alert_me
boolean
email.alert_all_team_members
boolean
email.alert_additional_emails
boolean
email.additional_emails_to_alert
array of strings
slack
object
 
slack.inhook_url
string
pager_duty
object
 
pager_duty.service_integration_key
string
service_now
object
 
service_now.url
string
service_now.user_id
string
service_now.password
string
service_now.table
string
hip_chat
object
 
hip_chat.token
string
hip_chat.room
string
webhook
object
 
webhook.webhook_url
string

Response

OK

Unauthorized

Not Found

Suggest Edits

Fetch Alert settings for a View

Fetch Alert settings for a View (Slack, Email, UDF, etc)

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
gethttps://api.overops.com/api/v1/services/env_id/views/view_id/alerts
curl --request GET \
  --url https://api.overops.com/api/v1/services/env_id/views/view_id/alerts
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/env_id/views/view_id/alerts' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/services/env_id/views/view_id/alerts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.overops.com/api/v1/services/env_id/views/view_id/alerts");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/env_id/views/view_id/alerts"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

view_id
string
required

View ID to use (e.g. P283)

Response

Alert data

globalboolean

TBD - Not developed yet - marks the alert as a global alert, i.e. will affect all users that share this view. Only admins will be able to edit these alerts.

alert_on_newboolean
alert_on_anomalyboolean
periodic_udf_settings
slack_settingsobject
slack_settings.enabledboolean
slack_settings.inhook_urlstring
hip_chat_settingsobject
hip_chat_settings.enabledboolean
hip_chat_settings.tokenstring
hip_chat_settings.roomstring
pager_duty_settingsobject
pager_duty_settings.enabledboolean
pager_duty_settings.service_integration_keystring
webhook_settingsobject
webhook_settings.enabledboolean
webhook_settings.webhook_urlstring
service_now_settingsobject
service_now_settings.enabledboolean
service_now_settings.urlstring
service_now_settings.user_idstring
service_now_settings.passwordstring
service_now_settings.tablestring
email_settingsobject
email_settings.is_activeboolean
email_settings.alert_meboolean
email_settings.alert_all_team_membersboolean
email_settings.alert_adminsboolean
email_settings.alert_additional_emailsboolean
email_settings.additional_emails_to_alertarray
udf_settingsobject
udf_settings.enabledboolean
udf_settings.library_idstring
udf_settings.function_idstring
udf_settings.argsstring

Unauthorized

Forbidden

Not Found

Suggest Edits

Edit Alert settings of a View

Edit Alert settings of a View

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
posthttps://api.overops.com/api/v1/services/env_id/views/view_id/alerts
curl --request POST \
  --url https://api.overops.com/api/v1/services/env_id/views/view_id/alerts
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.overops.com/api/v1/services/env_id/views/view_id/alerts' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/services/env_id/views/view_id/alerts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.overops.com/api/v1/services/env_id/views/view_id/alerts");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/env_id/views/view_id/alerts"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

view_id
string
required

View ID to use (e.g. P283)

Body Params

global
boolean

TBD - Not developed yet - marks the alert as a global alert, i.e. will affect all users that share this view. Only admins will be able to edit these alerts.

alert_on_new
boolean
alert_on_anomaly
boolean
periodic_udf_settings
slack_settings
object
 
slack_settings.enabled
boolean
slack_settings.inhook_url
string
hip_chat_settings
object
 
hip_chat_settings.enabled
boolean
hip_chat_settings.token
string
hip_chat_settings.room
string
pager_duty_settings
object
 
pager_duty_settings.enabled
boolean
pager_duty_settings.service_integration_key
string
webhook_settings
object
 
webhook_settings.enabled
boolean
webhook_settings.webhook_url
string
service_now_settings
object
 
service_now_settings.enabled
boolean
service_now_settings.url
string
service_now_settings.user_id
string
service_now_settings.password
string
service_now_settings.table
string
email_settings
object
 
email_settings.is_active
boolean
email_settings.alert_me
boolean
email_settings.alert_all_team_members
boolean
email_settings.alert_admins
boolean
email_settings.alert_additional_emails
boolean
email_settings.additional_emails_to_alert
array of strings
udf_settings
object
 
udf_settings.enabled
boolean
udf_settings.library_id
string
udf_settings.function_id
string
udf_settings.args
string

Response

OK

Unauthorized

Forbidden

Not Found

Suggest Edits

Remove Alert settings

Disables all Alert settings for a View

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
deletehttps://api.overops.com/api/v1/services/env_id/views/view_id/alerts
curl --request DELETE \
  --url https://api.overops.com/api/v1/services/env_id/views/view_id/alerts
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.overops.com/api/v1/services/env_id/views/view_id/alerts' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/services/env_id/views/view_id/alerts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.overops.com/api/v1/services/env_id/views/view_id/alerts");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/env_id/views/view_id/alerts"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

view_id
string
required

View ID to use (e.g. P283)

Response

OK

Unauthorized

Forbidden

Suggest Edits

List timers

List all existing timers

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
gethttps://api.overops.com/api/v1/services/env_id/timers
curl --request GET \
  --url https://api.overops.com/api/v1/services/env_id/timers
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/env_id/timers' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/services/env_id/timers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.overops.com/api/v1/services/env_id/timers");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/env_id/timers"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

Response

List of timers

timersarray

Unauthorized

Suggest Edits

Create new timer

Create new timer

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
posthttps://api.overops.com/api/v1/services/env_id/timers
curl --request POST \
  --url https://api.overops.com/api/v1/services/env_id/timers
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.overops.com/api/v1/services/env_id/timers' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/services/env_id/timers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.overops.com/api/v1/services/env_id/timers");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/env_id/timers"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

Body Params

id
string

This is an auto generated ID. When creating/editing a timer, the value recevied in this field will be ignored.

class_name
string
method_name
string
threshold
integer

Threshold in ms

servers
array of strings
applications
array of strings

Response

OK

Bad Request

Unauthorized

Conflict

Suggest Edits

Get timer properties

Get timer properties

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
gethttps://api.overops.com/api/v1/services/env_id/timers/timer_id
curl --request GET \
  --url https://api.overops.com/api/v1/services/env_id/timers/timer_id
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/env_id/timers/timer_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/services/env_id/timers/timer_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.overops.com/api/v1/services/env_id/timers/timer_id");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/env_id/timers/timer_id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

timer_id
string
required

Timer to use

Response

Timer properties

idstring

This is an auto generated ID. When creating/editing a timer, the value recevied in this field will be ignored.

class_namestring
method_namestring
thresholdinteger

Threshold in ms

serversarray
applicationsarray

Unauthorized

Suggest Edits

Edit timer data

Edit timer data

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
posthttps://api.overops.com/api/v1/services/env_id/timers/timer_id
curl --request POST \
  --url https://api.overops.com/api/v1/services/env_id/timers/timer_id
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.overops.com/api/v1/services/env_id/timers/timer_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/services/env_id/timers/timer_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.overops.com/api/v1/services/env_id/timers/timer_id");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/env_id/timers/timer_id"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

timer_id
string
required

View to use

Body Params

id
string

This is an auto generated ID. When creating/editing a timer, the value recevied in this field will be ignored.

class_name
string
method_name
string
threshold
integer

Threshold in ms

servers
array of strings
applications
array of strings

Response

OK

Unauthorized

Forbidden

Not Found

Suggest Edits

Delete timer

Delete timer

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
deletehttps://api.overops.com/api/v1/services/env_id/timers/timer_id
curl --request DELETE \
  --url https://api.overops.com/api/v1/services/env_id/timers/timer_id
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.overops.com/api/v1/services/env_id/timers/timer_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/services/env_id/timers/timer_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.overops.com/api/v1/services/env_id/timers/timer_id");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/env_id/timers/timer_id"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

timer_id
string
required

Timer to use

Response

OK

Unauthorized

Forbidden

Suggest Edits

Publish Metrics

 
Suggest Edits

Fetch Publish Metrics settings

Use this call to fetch data about publish metrics settings, output format and the actual metrics which are currently beeing published

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
gethttps://api.overops.com/api/v1/services/env_id/settings/publish-metrics
curl --request GET \
  --url https://api.overops.com/api/v1/services/env_id/settings/publish-metrics
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/env_id/settings/publish-metrics' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/services/env_id/settings/publish-metrics")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.overops.com/api/v1/services/env_id/settings/publish-metrics");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/env_id/settings/publish-metrics"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment to use

Response

Current settings for publish metrics

enabledboolean
hostnamestring

The hostname and (optional) port of your StatsD server.

output_formatstring
metricsarray

Unauthorized

Not Found

Suggest Edits

Set Publish Metrics

Use this call to set and customize publish metrics. Use one of the presets, or customize you tokens by setting output_format to 'custom'.

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
posthttps://api.overops.com/api/v1/services/env_id/settings/publish-metrics
curl --request POST \
  --url https://api.overops.com/api/v1/services/env_id/settings/publish-metrics
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.overops.com/api/v1/services/env_id/settings/publish-metrics' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/services/env_id/settings/publish-metrics")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.overops.com/api/v1/services/env_id/settings/publish-metrics");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/env_id/settings/publish-metrics"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment to use

Body Params

enabled
boolean
hostname
string

The hostname and (optional) port of your StatsD server.

output_format
string
metrics
array of objects
name
pattern

Response

OK

Unauthorized

Not Found

Suggest Edits

Fetch Available formats

Use this call to fetch available formats / presets, their metrics and their tokens

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
gethttps://api.overops.com/api/v1/services/env_id/settings/publish-metrics/available_formats
curl --request GET \
  --url https://api.overops.com/api/v1/services/env_id/settings/publish-metrics/available_formats
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/env_id/settings/publish-metrics/available_formats' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/services/env_id/settings/publish-metrics/available_formats")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.overops.com/api/v1/services/env_id/settings/publish-metrics/available_formats");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/env_id/settings/publish-metrics/available_formats"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment to use

Response

List of Available formats and metrics

Unauthorized

Not Found

Suggest Edits

Categories

 
Suggest Edits

List categories

List view categories

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
gethttps://api.overops.com/api/v1/services/env_id/categories
curl --request GET \
  --url https://api.overops.com/api/v1/services/env_id/categories
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/env_id/categories' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/services/env_id/categories")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.overops.com/api/v1/services/env_id/categories");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/env_id/categories"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

Response

List of View Categories and their info

categoriesarray

Unauthorized

Suggest Edits

Create category (Not implemented yet)

Create category (Not implemented yet)

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
posthttps://api.overops.com/api/v1/services/env_id/categories
curl --request POST \
  --url https://api.overops.com/api/v1/services/env_id/categories
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.overops.com/api/v1/services/env_id/categories' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/services/env_id/categories")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.overops.com/api/v1/services/env_id/categories");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/env_id/categories"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

Body Params

id
string
name
string

Category Name

shared
boolean

Indicates whether this category is visible for all users under this key or only for the category creator.

admin
boolean

(TBD - NOT YET IMPLEMENTED) marks the category as visible only to key admins

icon
string

(TBD - NOT YET IMPLEMENTED) based 64 encoded SVG

views
array of objects
id
name
shared
admin

Response

TBD

Bad Request

Unauthorized

Conflict

Suggest Edits

Get category details (Not implemented yet)

Get category details (Not implemented yet)

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
gethttps://api.overops.com/api/v1/services/env_id/categories/category_id
curl --request GET \
  --url https://api.overops.com/api/v1/services/env_id/categories/category_id
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/env_id/categories/category_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/services/env_id/categories/category_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.overops.com/api/v1/services/env_id/categories/category_id");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/env_id/categories/category_id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

category_id
string
required

View category to use

Response

Category info

idstring
namestring

Category Name

sharedboolean

Indicates whether this category is visible for all users under this key or only for the category creator.

adminboolean

(TBD - NOT YET IMPLEMENTED) marks the category as visible only to key admins

iconstring

(TBD - NOT YET IMPLEMENTED) based 64 encoded SVG

viewsarray

Unauthorized

Forbidden

Suggest Edits

Delete category (Not implemented yet)

Delete category (Not implemented yet)

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
deletehttps://api.overops.com/api/v1/services/env_id/categories/category_id
curl --request DELETE \
  --url https://api.overops.com/api/v1/services/env_id/categories/category_id
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.overops.com/api/v1/services/env_id/categories/category_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/services/env_id/categories/category_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.overops.com/api/v1/services/env_id/categories/category_id");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/env_id/categories/category_id"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

category_id
string
required

View category to use

Response

OK

Unauthorized

Forbidden

Suggest Edits

List available UDF libraries

List available UDF (User Defined Functions) libraries

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
gethttps://api.overops.com/api/v1/global-settings/udfs
curl --request GET \
  --url https://api.overops.com/api/v1/global-settings/udfs
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/global-settings/udfs' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/global-settings/udfs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.overops.com/api/v1/global-settings/udfs");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/global-settings/udfs"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

UDF libraries list

Unauthorized

Suggest Edits

Add a new UDF library

Add a new UDF library

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
posthttps://api.overops.com/api/v1/global-settings/udfs
curl --request POST \
  --url https://api.overops.com/api/v1/global-settings/udfs
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.overops.com/api/v1/global-settings/udfs' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/global-settings/udfs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.overops.com/api/v1/global-settings/udfs");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/global-settings/udfs"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

udf
binary

Response

OK

Unauthorized

Suggest Edits

Get UDF library properties

Get UDF (User Defined Function) library properties

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
gethttps://api.overops.com/api/v1/global-settings/udfs/library_id
curl --request GET \
  --url https://api.overops.com/api/v1/global-settings/udfs/library_id
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/global-settings/udfs/library_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/global-settings/udfs/library_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.overops.com/api/v1/global-settings/udfs/library_id");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/global-settings/udfs/library_id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

library_id
string
required

UDF library ID to be used

Response

UDF library properties

idstring
versionstring
backward_compatiblestring
functionsarray

Unauthorized

Suggest Edits

Remove UDF library (TBD - Not yet implemented)

Remove UDF library (TBD - Not yet implemented)

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
deletehttps://api.overops.com/api/v1/global-settings/udfs/library_id
curl --request DELETE \
  --url https://api.overops.com/api/v1/global-settings/udfs/library_id
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.overops.com/api/v1/global-settings/udfs/library_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/global-settings/udfs/library_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.overops.com/api/v1/global-settings/udfs/library_id");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/global-settings/udfs/library_id"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

library_id
string
required

UDF library ID to be used

Response

OK

Unauthorized

Not Found

Suggest Edits

List available UDF libraries for the environment

List all available UDFs (User Defined Functions) for selected environment

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
gethttps://api.overops.com/api/v1/services/env_id/udfs
curl --request GET \
  --url https://api.overops.com/api/v1/services/env_id/udfs
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/env_id/udfs' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/services/env_id/udfs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.overops.com/api/v1/services/env_id/udfs");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/env_id/udfs"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

Response

UDF libraries list

Unauthorized

Suggest Edits

Add a new UDF library

Add a new UDF library

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
posthttps://api.overops.com/api/v1/services/env_id/udfs
curl --request POST \
  --url https://api.overops.com/api/v1/services/env_id/udfs
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.overops.com/api/v1/services/env_id/udfs' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/services/env_id/udfs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.overops.com/api/v1/services/env_id/udfs");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/env_id/udfs"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

Body Params

udf
binary

Response

UDF library was successfully added

Unauthorized

Suggest Edits

Get UDF library properties

Get UDF (User Defined Function) library properties

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
gethttps://api.overops.com/api/v1/services/env_id/udfs/library_id
curl --request GET \
  --url https://api.overops.com/api/v1/services/env_id/udfs/library_id
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/env_id/udfs/library_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/services/env_id/udfs/library_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.overops.com/api/v1/services/env_id/udfs/library_id");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/env_id/udfs/library_id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

library_id
string
required

UDF library ID to be used

Response

UDF properties

idstring
versionstring
backward_compatiblestring
functionsarray

Unauthorized

Suggest Edits

Remove UDF library from the environment

Remove UDF library from specified environment

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
deletehttps://api.overops.com/api/v1/services/env_id/udfs/library_id
curl --request DELETE \
  --url https://api.overops.com/api/v1/services/env_id/udfs/library_id
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.overops.com/api/v1/services/env_id/udfs/library_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/services/env_id/udfs/library_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.overops.com/api/v1/services/env_id/udfs/library_id");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/env_id/udfs/library_id"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

library_id
string
required

UDF library ID to be used

Response

OK

Unauthorized

Not Found

Suggest Edits

Team Management

 
Suggest Edits

List environment team members

List team members with access to this environment

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
gethttps://api.overops.com/api/v1/services/env_id/team
curl --request GET \
  --url https://api.overops.com/api/v1/services/env_id/team
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/env_id/team' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/services/env_id/team")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.overops.com/api/v1/services/env_id/team");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/env_id/team"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

Query Params

email
string

Team member email

Response

List of team members

Unauthorized

Suggest Edits

Add new members

Add new members

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
posthttps://api.overops.com/api/v1/services/env_id/team
curl --request POST \
  --url https://api.overops.com/api/v1/services/env_id/team
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.overops.com/api/v1/services/env_id/team' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/services/env_id/team")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.overops.com/api/v1/services/env_id/team");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/env_id/team"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment to use

Response

List of added members

Unauthorized

Suggest Edits

Delete members from an environment

Delete members from an environment. This call requires admin role

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
deletehttps://api.overops.com/api/v1/services/env_id/team
curl --request DELETE \
  --url https://api.overops.com/api/v1/services/env_id/team
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.overops.com/api/v1/services/env_id/team' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.overops.com/api/v1/services/env_id/team")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.<