doc.overops.com

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 a service key

List all available UDFs (User Defined Functions) for selected service key

 

Basic Auth

Header Auth

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

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/service_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/service_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/service_id/udfs");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/service_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

service_id
string
required

Environment to use

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/service_id/udfs
curl --request POST \
  --url https://api.overops.com/api/v1/services/service_id/udfs
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.overops.com/api/v1/services/service_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/service_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/service_id/udfs");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/service_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

service_id
string
required

Environment to use

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/service_id/udfs/library_id
curl --request GET \
  --url https://api.overops.com/api/v1/services/service_id/udfs/library_id
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/service_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/service_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/service_id/udfs/library_id");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/service_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

service_id
string
required

Environment to use

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 a service key

Remove UDF library from specified service key

 

Basic Auth

Header Auth

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

var options = { method: 'DELETE',
  url: 'https://api.overops.com/api/v1/services/service_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/service_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/service_id/udfs/library_id");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/service_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

service_id
string
required

Environment to use

library_id
string
required

UDF library ID to be used

Response

OK

Unauthorized

Not Found

 

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 services

List all services accessible by the 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

Service key name

Response

List of all accessible services

Unauthorized

Suggest Edits

Generate a new service key

Create a new service

 

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 service key properties

Unauthorized

Suggest Edits

Get information about the service (Not yet implemented)

Get information about the service (Not yet implemented)

 

Basic Auth

Header Auth

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

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/service_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/service_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/service_id");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/service_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

service_id
string
required

Environment to use

Response

TBD

Unauthorized

Suggest Edits

List service team members

List service team members

 

Basic Auth

Header Auth

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

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/service_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/service_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/service_id/team");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/service_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

service_id
string
required

Environment to use

Query Params

email
string

Team member email

Response

List of team members

Unauthorized

Suggest Edits

Add members to a service key

Add members to a service key

 

Basic Auth

Header Auth

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

var options = { method: 'POST',
  url: 'https://api.overops.com/api/v1/services/service_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/service_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/service_id/team");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/service_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

service_id
string
required

Environment to use

Response

OK

Unauthorized

Suggest Edits

Get service settings

Get service settings

 

Basic Auth

Header Auth

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

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/service_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/service_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/service_id/settings");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/service_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

service_id
string
required

Environment to use

Response

TBD

Unauthorized

Suggest Edits

List deployments

List deployments

 

Basic Auth

Header Auth

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

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/service_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/service_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/service_id/deployments");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/service_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

service_id
string
required

Environment to use

Query Params

active
boolean

(TBD - Not yet implemented) Show only active deployments

Response

List of deployments

Unauthorized

Suggest Edits

List servers (Not yet implemented)

List servers (Not yet implemented)

 

Basic Auth

Header Auth

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

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/service_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/service_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/service_id/servers");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/service_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

service_id
string
required

Environment to use

Query Params

active
boolean

Show only active servers

Response

TBD

Unauthorized

Suggest Edits

List applications (Not yet implemented)

List applications (Not yet implemented)

 

Basic Auth

Header Auth

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

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/service_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/service_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/service_id/applications");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/service_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

service_id
string
required

Environment to use

Query Params

active
boolean

Show only active applications

Response

TBD

Unauthorized

Suggest Edits

Code Redaction

 
Suggest Edits

List all environment code redaction

List all environment code exclusions and inclusions

 

Basic Auth

Header Auth

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

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

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/service_id/settings/code-redaction")

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/service_id/settings/code-redaction");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/service_id/settings/code-redaction"

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

service_id
string
required

Environment to use

Response

List of included and excluded classes and packages

Unauthorized

Suggest Edits

List all code exclusions

List all code exclusions

 

Basic Auth

Header Auth

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

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/service_id/settings/code-redaction/exclude' };

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/service_id/settings/code-redaction/exclude")

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/service_id/settings/code-redaction/exclude");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/service_id/settings/code-redaction/exclude"

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

service_id
string
required

Environment to use

Response

List of excluded classes and packages

Unauthorized

Suggest Edits

List all excluded classes

List all excluded classes

 

Basic Auth

Header Auth

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

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/service_id/settings/code-redaction/exclude/classes' };

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/service_id/settings/code-redaction/exclude/classes")

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/service_id/settings/code-redaction/exclude/classes");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/service_id/settings/code-redaction/exclude/classes"

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

service_id
string
required

Environment to use

Response

List of excluded classes

Unauthorized

Suggest Edits

Retrieve an excluded class

Retrieve an excluded class

 

Basic Auth

Header Auth

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

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/service_id/settings/code-redaction/exclude/classes/class_name' };

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/service_id/settings/code-redaction/exclude/classes/class_name")

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/service_id/settings/code-redaction/exclude/classes/class_name");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/service_id/settings/code-redaction/exclude/classes/class_name"

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

service_id
string
required

Environment to use

class_name
string
required

Fully qualified Java class name

Response

An excluded class

Unauthorized

Not Found

Suggest Edits

Add a class to the exclusion list

Add a class to the exclusion list. The body class name must match the resource identifier

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
puthttps://api.overops.com/api/v1/services/service_id/settings/code-redaction/exclude/classes/class_name
curl --request PUT \
  --url https://api.overops.com/api/v1/services/service_id/settings/code-redaction/exclude/classes/class_name
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.overops.com/api/v1/services/service_id/settings/code-redaction/exclude/classes/class_name' };

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/service_id/settings/code-redaction/exclude/classes/class_name")

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

request = Net::HTTP::Put.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("PUT", "https://api.overops.com/api/v1/services/service_id/settings/code-redaction/exclude/classes/class_name");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/service_id/settings/code-redaction/exclude/classes/class_name"

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

service_id
string
required

Environment to use

class_name
string
required

Fully qualified Java class name

Body Params

name
string

Response

OK

Bad Request

Unauthorized

Suggest Edits

Remove a class from exclusion

Remove a class from the exclusion list

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
deletehttps://api.overops.com/api/v1/services/service_id/settings/code-redaction/exclude/classes/class_name
curl --request DELETE \
  --url https://api.overops.com/api/v1/services/service_id/settings/code-redaction/exclude/classes/class_name
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.overops.com/api/v1/services/service_id/settings/code-redaction/exclude/classes/class_name' };

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/service_id/settings/code-redaction/exclude/classes/class_name")

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/service_id/settings/code-redaction/exclude/classes/class_name");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/service_id/settings/code-redaction/exclude/classes/class_name"

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

service_id
string
required

Environment to use

class_name
string
required

Fully qualified Java class name

Response

OK

Unauthorized

Not Found

Suggest Edits

List all excluded packages

List all excluded packages

 

Basic Auth

Header Auth

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

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/service_id/settings/code-redaction/exclude/packages' };

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/service_id/settings/code-redaction/exclude/packages")

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/service_id/settings/code-redaction/exclude/packages");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/service_id/settings/code-redaction/exclude/packages"

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

service_id
string
required

Environment to use

Response

List of excluded packages

Unauthorized

Suggest Edits

Retrieve an excluded package

Retrieve an excluded package

 

Basic Auth

Header Auth

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

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/service_id/settings/code-redaction/exclude/packages/package_name' };

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/service_id/settings/code-redaction/exclude/packages/package_name")

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/service_id/settings/code-redaction/exclude/packages/package_name");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/service_id/settings/code-redaction/exclude/packages/package_name"

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

service_id
string
required

Environment to use

package_name
string
required

Fully qualified Java package name

Response

An excluded package

Unauthorized

Not Found

Suggest Edits

Add a package to the exclusion list

Add a package to the exclusion list. The body package name must match the resource identifier

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
puthttps://api.overops.com/api/v1/services/service_id/settings/code-redaction/exclude/packages/package_name
curl --request PUT \
  --url https://api.overops.com/api/v1/services/service_id/settings/code-redaction/exclude/packages/package_name
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.overops.com/api/v1/services/service_id/settings/code-redaction/exclude/packages/package_name' };

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/service_id/settings/code-redaction/exclude/packages/package_name")

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

request = Net::HTTP::Put.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("PUT", "https://api.overops.com/api/v1/services/service_id/settings/code-redaction/exclude/packages/package_name");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/service_id/settings/code-redaction/exclude/packages/package_name"

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

service_id
string
required

Environment to use

package_name
string
required

Fully qualified Java package name

Body Params

name
string

Response

OK

Bad Request

Unauthorized

Suggest Edits

Remove a package from the exclusion list

Remove a package from the exclusion list

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
deletehttps://api.overops.com/api/v1/services/service_id/settings/code-redaction/exclude/packages/package_name
curl --request DELETE \
  --url https://api.overops.com/api/v1/services/service_id/settings/code-redaction/exclude/packages/package_name
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.overops.com/api/v1/services/service_id/settings/code-redaction/exclude/packages/package_name' };

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/service_id/settings/code-redaction/exclude/packages/package_name")

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/service_id/settings/code-redaction/exclude/packages/package_name");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/service_id/settings/code-redaction/exclude/packages/package_name"

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

service_id
string
required

Environment to use

package_name
string
required

Fully qualified Java package name

Response

OK

Unauthorized

Not Found

Suggest Edits

List all code inclusions

List all code inclusions

 

Basic Auth

Header Auth

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

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/service_id/settings/code-redaction/include' };

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/service_id/settings/code-redaction/include")

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/service_id/settings/code-redaction/include");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/service_id/settings/code-redaction/include"

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

service_id
string
required

Environment to use

Response

List of included classes and packages

Unauthorized

Suggest Edits

List all included classes

List all included classes

 

Basic Auth

Header Auth

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

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/service_id/settings/code-redaction/include/classes' };

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/service_id/settings/code-redaction/include/classes")

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/service_id/settings/code-redaction/include/classes");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/service_id/settings/code-redaction/include/classes"

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

service_id
string
required

Environment to use

Response

List of included classes

Unauthorized

Suggest Edits

Retrieve an included class

Retrieve an included class

 

Basic Auth

Header Auth

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

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/service_id/settings/code-redaction/include/classes/class_name' };

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/service_id/settings/code-redaction/include/classes/class_name")

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/service_id/settings/code-redaction/include/classes/class_name");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/service_id/settings/code-redaction/include/classes/class_name"

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

service_id
string
required

Environment to use

class_name
string
required

Fully qualified Java class name

Response

An included class

Unauthorized

Not Found

Suggest Edits

Add a class to the inclusion list

Add a class to the inclusion list. The body class name must match the resource identifier

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
puthttps://api.overops.com/api/v1/services/service_id/settings/code-redaction/include/classes/class_name
curl --request PUT \
  --url https://api.overops.com/api/v1/services/service_id/settings/code-redaction/include/classes/class_name
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.overops.com/api/v1/services/service_id/settings/code-redaction/include/classes/class_name' };

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/service_id/settings/code-redaction/include/classes/class_name")

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

request = Net::HTTP::Put.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("PUT", "https://api.overops.com/api/v1/services/service_id/settings/code-redaction/include/classes/class_name");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/service_id/settings/code-redaction/include/classes/class_name"

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

service_id
string
required

Environment to use

class_name
string
required

Fully qualified Java class name

Body Params

name
string

Response

OK

Bad Request

Unauthorized

Suggest Edits

Remove a class from the inclusion list

Remove a class from the inclusion list

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
deletehttps://api.overops.com/api/v1/services/service_id/settings/code-redaction/include/classes/class_name
curl --request DELETE \
  --url https://api.overops.com/api/v1/services/service_id/settings/code-redaction/include/classes/class_name
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.overops.com/api/v1/services/service_id/settings/code-redaction/include/classes/class_name' };

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/service_id/settings/code-redaction/include/classes/class_name")

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/service_id/settings/code-redaction/include/classes/class_name");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/service_id/settings/code-redaction/include/classes/class_name"

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

service_id
string
required

Environment to use

class_name
string
required

Fully qualified Java class name

Response

OK

Unauthorized

Not Found

Suggest Edits

List all included packages

List all included packages

 

Basic Auth

Header Auth

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

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/service_id/settings/code-redaction/include/packages' };

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/service_id/settings/code-redaction/include/packages")

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/service_id/settings/code-redaction/include/packages");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/service_id/settings/code-redaction/include/packages"

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

service_id
string
required

Environment to use

Response

List of included packages

Unauthorized

Suggest Edits

Retrieve an included package

Retrieve an included package

 

Basic Auth

Header Auth

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

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/service_id/settings/code-redaction/include/packages/package_name' };

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/service_id/settings/code-redaction/include/packages/package_name")

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/service_id/settings/code-redaction/include/packages/package_name");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/service_id/settings/code-redaction/include/packages/package_name"

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

service_id
string
required

Environment to use

package_name
string
required

Fully qualified Java package name

Response

An included package

Unauthorized

Not Found

Suggest Edits

Add a package to the inclusion list

Add a package to the inclusion list. The body package name must match the resource identifier

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
puthttps://api.overops.com/api/v1/services/service_id/settings/code-redaction/include/packages/package_name
curl --request PUT \
  --url https://api.overops.com/api/v1/services/service_id/settings/code-redaction/include/packages/package_name
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.overops.com/api/v1/services/service_id/settings/code-redaction/include/packages/package_name' };

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/service_id/settings/code-redaction/include/packages/package_name")

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

request = Net::HTTP::Put.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("PUT", "https://api.overops.com/api/v1/services/service_id/settings/code-redaction/include/packages/package_name");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/service_id/settings/code-redaction/include/packages/package_name"

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

service_id
string
required

Environment to use

package_name
string
required

Fully qualified Java package name

Body Params

name
string

Response

OK

Bad Request

Unauthorized

Suggest Edits

Remove a package from the inclusion list

Remove a package from the inclusion list

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
deletehttps://api.overops.com/api/v1/services/service_id/settings/code-redaction/include/packages/package_name
curl --request DELETE \
  --url https://api.overops.com/api/v1/services/service_id/settings/code-redaction/include/packages/package_name
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.overops.com/api/v1/services/service_id/settings/code-redaction/include/packages/package_name' };

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/service_id/settings/code-redaction/include/packages/package_name")

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/service_id/settings/code-redaction/include/packages/package_name");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/service_id/settings/code-redaction/include/packages/package_name"

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

service_id
string
required

Environment to use

package_name
string
required

Fully qualified Java package name

Response

OK

Unauthorized

Not Found

Suggest Edits

Data Redaction

 
Suggest Edits

List all data redactions

List all data redactions

 

Basic Auth

Header Auth

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

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

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/service_id/settings/data-redaction")

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/service_id/settings/data-redaction");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/service_id/settings/data-redaction"

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

service_id
string
required

Environment to use

Response

List of data redaction

Unauthorized

Suggest Edits

List all regex patterns

List all regex patterns

 

Basic Auth

Header Auth

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

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/service_id/settings/data-redaction/patterns' };

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/service_id/settings/data-redaction/patterns")

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/service_id/settings/data-redaction/patterns");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/service_id/settings/data-redaction/patterns"

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

service_id
string
required

Environment to use

Response

List of regex patterns

Unauthorized

Suggest Edits

Retrieve a pattern

Retrieve a pattern

 

Basic Auth

Header Auth

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

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/service_id/settings/data-redaction/patterns/pattern' };

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/service_id/settings/data-redaction/patterns/pattern")

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/service_id/settings/data-redaction/patterns/pattern");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/service_id/settings/data-redaction/patterns/pattern"

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

service_id
string
required

Environment to use

pattern
string
required

A RegEx pattern name

Response

A pattern

namestring
categorystring
regexstring
is_activeboolean

Unauthorized

Suggest Edits

Create a pattern

Add a RegEx pattern to be redacted. The pattern name must match the resource identifier

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
puthttps://api.overops.com/api/v1/services/service_id/settings/data-redaction/patterns/pattern
curl --request PUT \
  --url https://api.overops.com/api/v1/services/service_id/settings/data-redaction/patterns/pattern
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.overops.com/api/v1/services/service_id/settings/data-redaction/patterns/pattern' };

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/service_id/settings/data-redaction/patterns/pattern")

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

request = Net::HTTP::Put.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("PUT", "https://api.overops.com/api/v1/services/service_id/settings/data-redaction/patterns/pattern");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/service_id/settings/data-redaction/patterns/pattern"

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

service_id
string
required

Environment to use

pattern
string
required

A RegEx pattern name

Body Params

name
string
category
string
regex
string
is_active
boolean

Response

OK

Bad Request

Unauthorized

Suggest Edits

Delete a pattern

Removes a pattern from the redaction list

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
deletehttps://api.overops.com/api/v1/services/service_id/settings/data-redaction/patterns/pattern
curl --request DELETE \
  --url https://api.overops.com/api/v1/services/service_id/settings/data-redaction/patterns/pattern
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.overops.com/api/v1/services/service_id/settings/data-redaction/patterns/pattern' };

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/service_id/settings/data-redaction/patterns/pattern")

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/service_id/settings/data-redaction/patterns/pattern");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/service_id/settings/data-redaction/patterns/pattern"

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

service_id
string
required

Environment to use

pattern
string
required

A RegEx pattern name

Response

OK

Unauthorized

Not Found

Suggest Edits

List all identifiers

List all identifiers

 

Basic Auth

Header Auth

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

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/service_id/settings/data-redaction/identifiers' };

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/service_id/settings/data-redaction/identifiers")

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/service_id/settings/data-redaction/identifiers");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/service_id/settings/data-redaction/identifiers"

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

service_id
string
required

Environment to use

Response

List of identifiers

Unauthorized

Suggest Edits

Retrieve an identifier

Retrieve an identifier

 

Basic Auth

Header Auth

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

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/service_id/settings/data-redaction/identifiers/identifier' };

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/service_id/settings/data-redaction/identifiers/identifier")

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/service_id/settings/data-redaction/identifiers/identifier");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/service_id/settings/data-redaction/identifiers/identifier"

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

service_id
string
required

Environment to use

identifier
string
required

A code identifier

Response

If the redaction exists

Unauthorized

Suggest Edits

Add an identifier

Add an identifier. The body identifier name must match the resource identifier

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
puthttps://api.overops.com/api/v1/services/service_id/settings/data-redaction/identifiers/identifier
curl --request PUT \
  --url https://api.overops.com/api/v1/services/service_id/settings/data-redaction/identifiers/identifier
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.overops.com/api/v1/services/service_id/settings/data-redaction/identifiers/identifier' };

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/service_id/settings/data-redaction/identifiers/identifier")

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

request = Net::HTTP::Put.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("PUT", "https://api.overops.com/api/v1/services/service_id/settings/data-redaction/identifiers/identifier");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/service_id/settings/data-redaction/identifiers/identifier"

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

service_id
string
required

Environment to use

identifier
string
required

A code identifier

Body Params

name
string

Response

OK

Bad Request

Unauthorized

Suggest Edits

Delete identifier

Delete identifier

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
deletehttps://api.overops.com/api/v1/services/service_id/settings/data-redaction/identifiers/identifier
curl --request DELETE \
  --url https://api.overops.com/api/v1/services/service_id/settings/data-redaction/identifiers/identifier
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.overops.com/api/v1/services/service_id/settings/data-redaction/identifiers/identifier' };

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/service_id/settings/data-redaction/identifiers/identifier")

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/service_id/settings/data-redaction/identifiers/identifier");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/service_id/settings/data-redaction/identifiers/identifier"

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

service_id
string
required

Environment to use

identifier
string
required

A code identifier

Response

OK

Unauthorized

Not Found

Suggest Edits

List all classes

List all classes

 

Basic Auth

Header Auth

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

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/service_id/settings/data-redaction/classes' };

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/service_id/settings/data-redaction/classes")

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/service_id/settings/data-redaction/classes");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/service_id/settings/data-redaction/classes"

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

service_id
string
required

Environment to use

Response

List of classes

Unauthorized

Suggest Edits

Retrieve a class

Retrieve a class from the data redaction list

 

Basic Auth

Header Auth

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

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/service_id/settings/data-redaction/classes/class_name' };

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/service_id/settings/data-redaction/classes/class_name")

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/service_id/settings/data-redaction/classes/class_name");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/service_id/settings/data-redaction/classes/class_name"

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

service_id
string
required

Environment to use

class_name
string
required

Class name to redact.

Response

If the redaction exists

Unauthorized

Suggest Edits

Add a class for data redaction

Add a class to the redaction list. The body class name must match the resource identifier

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
puthttps://api.overops.com/api/v1/services/service_id/settings/data-redaction/classes/class_name
curl --request PUT \
  --url https://api.overops.com/api/v1/services/service_id/settings/data-redaction/classes/class_name
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.overops.com/api/v1/services/service_id/settings/data-redaction/classes/class_name' };

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/service_id/settings/data-redaction/classes/class_name")

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

request = Net::HTTP::Put.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("PUT", "https://api.overops.com/api/v1/services/service_id/settings/data-redaction/classes/class_name");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/service_id/settings/data-redaction/classes/class_name"

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

service_id
string
required

Environment to use

class_name
string
required

Class name to redact.

Body Params

name
string

Response

OK

Bad Request

Unauthorized

Suggest Edits

Delete a class

Delete a class

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
deletehttps://api.overops.com/api/v1/services/service_id/settings/data-redaction/classes/class_name
curl --request DELETE \
  --url https://api.overops.com/api/v1/services/service_id/settings/data-redaction/classes/class_name
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.overops.com/api/v1/services/service_id/settings/data-redaction/classes/class_name' };

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/service_id/settings/data-redaction/classes/class_name")

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/service_id/settings/data-redaction/classes/class_name");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/service_id/settings/data-redaction/classes/class_name"

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

service_id
string
required

Environment to use

class_name
string
required

Class name to redact.

Response

OK

Unauthorized

Not Found

Suggest Edits

List all packages

List all packages

 

Basic Auth

Header Auth

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

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/service_id/settings/data-redaction/packages' };

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/service_id/settings/data-redaction/packages")

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/service_id/settings/data-redaction/packages");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/service_id/settings/data-redaction/packages"

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

service_id
string
required

Environment to use

Response

List of packages

Unauthorized

Suggest Edits

Retrieve a package

Retrieve a package

 

Basic Auth

Header Auth

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

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/service_id/settings/data-redaction/packages/package_name' };

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/service_id/settings/data-redaction/packages/package_name")

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/service_id/settings/data-redaction/packages/package_name");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/service_id/settings/data-redaction/packages/package_name"

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

service_id
string
required

Environment to use

package_name
string
required

Fully qualified Java package name

Response

If the redaction exists

Unauthorized

Suggest Edits

Create a package

Create a package. The body package name must match the resource identifier

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
puthttps://api.overops.com/api/v1/services/service_id/settings/data-redaction/packages/package_name
curl --request PUT \
  --url https://api.overops.com/api/v1/services/service_id/settings/data-redaction/packages/package_name
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.overops.com/api/v1/services/service_id/settings/data-redaction/packages/package_name' };

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/service_id/settings/data-redaction/packages/package_name")

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

request = Net::HTTP::Put.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("PUT", "https://api.overops.com/api/v1/services/service_id/settings/data-redaction/packages/package_name");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/service_id/settings/data-redaction/packages/package_name"

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

service_id
string
required

Environment to use

package_name
string
required

Fully qualified Java package name

Body Params

name
string

Response

OK

Bad Request

Unauthorized

Suggest Edits

Delete package

Delete package

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
deletehttps://api.overops.com/api/v1/services/service_id/settings/data-redaction/packages/package_name
curl --request DELETE \
  --url https://api.overops.com/api/v1/services/service_id/settings/data-redaction/packages/package_name
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.overops.com/api/v1/services/service_id/settings/data-redaction/packages/package_name' };

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/service_id/settings/data-redaction/packages/package_name")

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/service_id/settings/data-redaction/packages/package_name");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/service_id/settings/data-redaction/packages/package_name"

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

service_id
string
required

Environment to use

package_name
string
required

Fully qualified Java package name

Response

OK

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/service_id/categories
curl --request GET \
  --url https://api.overops.com/api/v1/services/service_id/categories
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/service_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/service_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/service_id/categories");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/service_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

service_id
string
required

Environment to use

Response

List of View Categories and their info

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/service_id/categories
curl --request POST \
  --url https://api.overops.com/api/v1/services/service_id/categories
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.overops.com/api/v1/services/service_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/service_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/service_id/categories");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/service_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

service_id
string
required

Environment to use

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

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/service_id/categories/category_id
curl --request GET \
  --url https://api.overops.com/api/v1/services/service_id/categories/category_id
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/service_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/service_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/service_id/categories/category_id");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/service_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

service_id
string
required

Environment to use

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/service_id/categories/category_id
curl --request DELETE \
  --url https://api.overops.com/api/v1/services/service_id/categories/category_id
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.overops.com/api/v1/services/service_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/service_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/service_id/categories/category_id");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/service_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

service_id
string
required

Environment to use

category_id
string
required

View category to use

Response

OK

Unauthorized

Forbidden

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/service_id/categories/category_id/views
curl --request POST \
  --url https://api.overops.com/api/v1/services/service_id/categories/category_id/views
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.overops.com/api/v1/services/service_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/service_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/service_id/categories/category_id/views");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/service_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

service_id
string
required

Environment to use

category_id
string
required

View category to use

Response

OK

Unauthorized

Forbidden

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/service_id/views
curl --request GET \
  --url https://api.overops.com/api/v1/services/service_id/views
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/service_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/service_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/service_id/views");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/service_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

service_id
string
required

Environment to use

Response

List of views including basic info about each view.

Unauthorized

Suggest Edits

Create view

Create view

 

Basic Auth

Header Auth

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

var options = { method: 'POST',
  url: 'https://api.overops.com/api/v1/services/service_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/service_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/service_id/views");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/service_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

service_id
string
required

Environment to use

Body Params

name
string
description
string
shared
boolean
admin
boolean

TBD - NOT YET IMPLEMENTED

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

(Not implemented yet) List of event names

filters.event_location
array of strings

(Not implemented yet) List of event locations

filters.event_package
array of strings

(Not implemented yet) List of event packages

filters.entry_point
array of strings

(Not implemented yet) List of entrypoints

filters.servers
array of strings

(Not implemented yet) List of server names

filters.apps
array of strings

(Not implemented yet) List of application names

filters.deployments
array of strings

(Not implemented yet) List of deployment names

filters.introduced_by
array of strings

(Not implemented yet) Filters events by deployment they originated in

filters.search
string

(Not implemented yet) Free text search

alert_on_new
boolean

TBD - NOT YET IMPLEMENTED

alert_on_anomaly
boolean

TBD - NOT YET IMPLEMENTED

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/service_id/views/view_id
curl --request GET \
  --url https://api.overops.com/api/v1/services/service_id/views/view_id
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/service_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/service_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/service_id/views/view_id");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/service_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

service_id
string
required

Environment to use

view_id
string
required

View to use

Response

Full list of view properties

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/service_id/views/view_id
curl --request POST \
  --url https://api.overops.com/api/v1/services/service_id/views/view_id
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.overops.com/api/v1/services/service_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/service_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/service_id/views/view_id");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/service_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

service_id
string
required

Environment to use

view_id
string
required

View to use

Body Params

name
string
description
string
shared
boolean
admin
boolean

TBD - NOT YET IMPLEMENTED

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

(Not implemented yet) List of event names

filters.event_location
array of strings

(Not implemented yet) List of event locations

filters.event_package
array of strings

(Not implemented yet) List of event packages

filters.entry_point
array of strings

(Not implemented yet) List of entrypoints

filters.servers
array of strings

(Not implemented yet) List of server names

filters.apps
array of strings

(Not implemented yet) List of application names

filters.deployments
array of strings

(Not implemented yet) List of deployment names

filters.introduced_by
array of strings

(Not implemented yet) Filters events by deployment they originated in

filters.search
string

(Not implemented yet) Free text search

alert_on_new
boolean

TBD - NOT YET IMPLEMENTED

alert_on_anomaly
boolean

TBD - NOT YET IMPLEMENTED

Response

OK

Unauthorized

Forbidden

Not Found

Suggest Edits

Delete view (Not implemented yet)

Delete view (Not implemented yet)

 

Basic Auth

Header Auth

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

var options = { method: 'DELETE',
  url: 'https://api.overops.com/api/v1/services/service_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/service_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/service_id/views/view_id");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/service_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

service_id
string
required

Environment to use

view_id
string
required

View to use

Response

OK

Unauthorized

Forbidden

Suggest Edits

Fetch events details

Fetch events data in a selected timeframe

 

Basic Auth

Header Auth

 Authentication is required for this endpoint.
gethttps://api.overops.com/api/v1/services/service_id/views/view_id/events
curl --request GET \
  --url 'https://api.overops.com/api/v1/services/service_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/service_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/service_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/service_id/views/view_id/events?from=from&to=to");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/service_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

service_id
string
required

Environment to use

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 statistics per event in the response

Response

Event data

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/service_id/views/view_id/entrypoints
curl --request GET \
  --url 'https://api.overops.com/api/v1/services/service_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/service_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/service_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/service_id/views/view_id/entrypoints?from=from&to=to");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/service_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

service_id
string
required

Environment to use

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

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/service_id/views/view_id/metrics/view/graph
curl --request GET \
  --url 'https://api.overops.com/api/v1/services/service_id/views/view_id/metrics/view/graph?from=from&to=to&points=points'
var request = require("request");

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

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/service_id/views/view_id/metrics/view/graph?from=from&to=to&points=points")

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/service_id/views/view_id/metrics/view/graph?from=from&to=to&points=points");

xhr.send(data);
import requests

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

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

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

service_id
string
required

Environment to use

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
required

Number of data points to return within the interval

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

Event metrics

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/service_id/views/view_id/metrics/entrypoint/graph
curl --request GET \
  --url 'https://api.overops.com/api/v1/services/service_id/views/view_id/metrics/entrypoint/graph?from=from&to=to&points=points'
var request = require("request");

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

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/service_id/views/view_id/metrics/entrypoint/graph?from=from&to=to&points=points")

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/service_id/views/view_id/metrics/entrypoint/graph?from=from&to=to&points=points");

xhr.send(data);
import requests

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

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

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

service_id
string
required

Environment to use

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
required

Number of data points to return within the interval

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

Event metrics split by entry point

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/service_id/views/view_id/metrics/event/graph
curl --request GET \
  --url 'https://api.overops.com/api/v1/services/service_id/views/view_id/metrics/event/graph?from=from&to=to&points=points'
var request = require("request");

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

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/service_id/views/view_id/metrics/event/graph?from=from&to=to&points=points")

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/service_id/views/view_id/metrics/event/graph?from=from&to=to&points=points");

xhr.send(data);
import requests

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

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

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

service_id
string
required

Environment to use

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
required

Number of data points to return within the interval

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

event metrics split by event

Unauthorized

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/service_id/views/view_id/anomaly
curl --request POST \
  --url https://api.overops.com/api/v1/services/service_id/views/view_id/anomaly
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.overops.com/api/v1/services/service_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/service_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/service_id/views/view_id/anomaly");

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/service_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

service_id
string
required

Environment to use

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<