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 the environment

List all available UDFs (User Defined Functions) for selected environment

 

Basic Auth

Header Auth

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

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

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

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

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

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

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

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

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

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

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

xhr.send(data);
import requests

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

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

Response

UDF libraries list

Unauthorized

Suggest Edits

Add a new UDF library

Add a new UDF library

 

Basic Auth

Header Auth

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

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

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

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

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

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

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

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

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

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

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

xhr.send(data);
import requests

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

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

Body Params

udf
binary

Response

UDF library was successfully added

Unauthorized

Suggest Edits

Get UDF library properties

Get UDF (User Defined Function) library properties

 

Basic Auth

Header Auth

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

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

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

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

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

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

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

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

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

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

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

xhr.send(data);
import requests

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

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

library_id
string
required

UDF library ID to be used

Response

UDF properties

idstring
versionstring
backward_compatiblestring
functionsarray

Unauthorized

Suggest Edits

Remove UDF library from the environment

Remove UDF library from specified environment

 

Basic Auth

Header Auth

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

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

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

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

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

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

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

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

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

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

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

xhr.send(data);
import requests

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

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

library_id
string
required

UDF library ID to be used

Response

OK

Unauthorized

Not Found

 

Main OverOps API.

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

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

List all environments

List all environments accessible to the calling user

 

Basic Auth

Header Auth

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

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

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

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

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

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

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

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

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

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

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

xhr.send(data);
import requests

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

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

name
string

Environment key name

Response

List of all accessible environments to the calling user

servicesarray

list of environment

Unauthorized

Suggest Edits

Generate a new environment key

Defines a new environment

 

Basic Auth

Header Auth

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

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

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

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

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

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

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

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

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

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

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

xhr.send(data);
import requests

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

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

name
string

Response

New environment key properties

idstring
namestring
full_keystring

Unauthorized

Suggest Edits

Get information about the environment (Not yet implemented)

Get information about the environment (Not yet implemented)

 

Basic Auth

Header Auth

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

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

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

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

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

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

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

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

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

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

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

xhr.send(data);
import requests

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

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

Response

TBD

Unauthorized

Suggest Edits

Rename an environment

Rename an environment. This call is allowed for admins only

 

Basic Auth

Header Auth

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

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

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

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

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

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

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

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

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

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

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

xhr.send(data);
import requests

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

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

Body Params

name
string

Response

Updated environment properties

idstring
namestring
full_keystring

Unauthorized

Suggest Edits

Get environment settings

Get environment settings

 

Basic Auth

Header Auth

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

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

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

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

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

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

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

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

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

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

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

xhr.send(data);
import requests

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

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

Response

TBD

Unauthorized

Suggest Edits

List servers

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

 

Basic Auth

Header Auth

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

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

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

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

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

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

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

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

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

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

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

xhr.send(data);
import requests

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

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

Query Params

active
boolean

Show only active servers

Response

List of servers

Unauthorized

Suggest Edits

List applications

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

 

Basic Auth

Header Auth

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

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

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

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

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

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

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

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

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

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

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

xhr.send(data);
import requests

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

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

Query Params

active
boolean

Show only active applications

Response

List of applications

Unauthorized

Suggest Edits

List deployments

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

 

Basic Auth

Header Auth

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

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

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

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

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

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

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

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

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

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

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

xhr.send(data);
import requests

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

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

Query Params

active
boolean

Show only active deployments

Response

List of deployments

Unauthorized

Suggest Edits

Get storage settings of an environment

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

 

Basic Auth

Header Auth

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

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

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

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

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

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

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

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

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

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

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

xhr.send(data);
import requests

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

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment to use

Response

Storage settings

typestring
hostnamestring

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

frontend_hostnamestring

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

Unauthorized

Not Found

Suggest Edits

Set storage settings for a service

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

 

Basic Auth

Header Auth

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

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

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

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

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

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

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

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

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

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

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

xhr.send(data);
import requests

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

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment to use

Body Params

type
string
hostname
string

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

frontend_hostname
string

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

Response

OK

Bad Request

Unauthorized

Not Found

Suggest Edits

Team Management

 
Suggest Edits

List environment team members

List team members with access to this environment

 

Basic Auth

Header Auth

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

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

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

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

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

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

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

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

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

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

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

xhr.send(data);
import requests

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

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

Query Params

email
string

Team member email

Response

List of team members

Unauthorized

Suggest Edits

Add new members

Add new members

 

Basic Auth

Header Auth

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

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

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

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

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

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

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

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

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

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

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

xhr.send(data);
import requests

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

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment to use

Response

OK

Unauthorized

Suggest Edits

Delete members from an environment

Delete members from an environment. This call requires admin role

 

Basic Auth

Header Auth

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

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

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

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

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

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

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

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

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

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

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

xhr.send(data);
import requests

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

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

Response

OK

Unauthorized

Suggest Edits

Edit roles

Edit roles for selected group of users

 

Basic Auth

Header Auth

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

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

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

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

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

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

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

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

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

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

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

xhr.send(data);
import requests

url = "https://api.overops.com/api/v1/services/env_id/team/change-role"

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment to use

Response

OK

Unauthorized

Suggest Edits

Code Redaction

 
Suggest Edits

List all environment code redaction settings

List all environment code exclusions and inclusions

 

Basic Auth

Header Auth

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

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

xhr.send(data);
import requests

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

env_id
string
required

Environment ID to use (e.g. S1234)

Response

List of included and excluded classes and packages

excludeobject
exclude.classesarray
exclude.packagesarray
includeobject
include.classesarray
include.packagesarray

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

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

xhr.send(data);
import requests

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

env_id
string
required

Environment ID to use (e.g. S1234)

Response

List of excluded classes and packages

classesarray
packagesarray

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/env_id/settings/code-redaction/exclude/classes
curl --request GET \
  --url https://api.overops.com/api/v1/services/env_id/settings/code-redaction/exclude/classes
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/env_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/env_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/env_id/settings/code-redaction/exclude/classes");

xhr.send(data);
import requests

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

env_id
string
required

Environment ID to use (e.g. S1234)

Response

List of excluded classes

classesarray

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/env_id/settings/code-redaction/exclude/classes/class_name
curl --request GET \
  --url https://api.overops.com/api/v1/services/env_id/settings/code-redaction/exclude/classes/class_name
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/env_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/env_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/env_id/settings/code-redaction/exclude/classes/class_name");

xhr.send(data);
import requests

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

env_id
string
required

Environment ID to use (e.g. S1234)

class_name
string
required

Fully qualified Java class name

Response

An excluded class

namestring

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/env_id/settings/code-redaction/exclude/classes/class_name
curl --request PUT \
  --url https://api.overops.com/api/v1/services/env_id/settings/code-redaction/exclude/classes/class_name
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.overops.com/api/v1/services/env_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/env_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/env_id/settings/code-redaction/exclude/classes/class_name");

xhr.send(data);
import requests

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

env_id
string
required

Environment ID to use (e.g. S1234)

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/env_id/settings/code-redaction/exclude/classes/class_name
curl --request DELETE \
  --url https://api.overops.com/api/v1/services/env_id/settings/code-redaction/exclude/classes/class_name
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.overops.com/api/v1/services/env_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/env_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/env_id/settings/code-redaction/exclude/classes/class_name");

xhr.send(data);
import requests

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

env_id
string
required

Environment ID to use (e.g. S1234)

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/env_id/settings/code-redaction/exclude/packages
curl --request GET \
  --url https://api.overops.com/api/v1/services/env_id/settings/code-redaction/exclude/packages
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/env_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/env_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/env_id/settings/code-redaction/exclude/packages");

xhr.send(data);
import requests

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

env_id
string
required

Environment ID to use (e.g. S1234)

Response

List of excluded packages

packagesarray

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/env_id/settings/code-redaction/exclude/packages/package_name
curl --request GET \
  --url https://api.overops.com/api/v1/services/env_id/settings/code-redaction/exclude/packages/package_name
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/env_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/env_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/env_id/settings/code-redaction/exclude/packages/package_name");

xhr.send(data);
import requests

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

env_id
string
required

Environment ID to use (e.g. S1234)

package_name
string
required

Fully qualified Java package name

Response

An excluded package

namestring

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/env_id/settings/code-redaction/exclude/packages/package_name
curl --request PUT \
  --url https://api.overops.com/api/v1/services/env_id/settings/code-redaction/exclude/packages/package_name
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.overops.com/api/v1/services/env_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/env_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/env_id/settings/code-redaction/exclude/packages/package_name");

xhr.send(data);
import requests

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

env_id
string
required

Environment ID to use (e.g. S1234)

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/env_id/settings/code-redaction/exclude/packages/package_name
curl --request DELETE \
  --url https://api.overops.com/api/v1/services/env_id/settings/code-redaction/exclude/packages/package_name
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.overops.com/api/v1/services/env_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/env_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/env_id/settings/code-redaction/exclude/packages/package_name");

xhr.send(data);
import requests

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

env_id
string
required

Environment ID to use (e.g. S1234)

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

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

xhr.send(data);
import requests

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

env_id
string
required

Environment ID to use (e.g. S1234)

Response

List of included classes and packages

classesarray
packagesarray

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/env_id/settings/code-redaction/include/classes
curl --request GET \
  --url https://api.overops.com/api/v1/services/env_id/settings/code-redaction/include/classes
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/env_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/env_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/env_id/settings/code-redaction/include/classes");

xhr.send(data);
import requests

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

env_id
string
required

Environment ID to use (e.g. S1234)

Response

List of included classes

classesarray

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/env_id/settings/code-redaction/include/classes/class_name
curl --request GET \
  --url https://api.overops.com/api/v1/services/env_id/settings/code-redaction/include/classes/class_name
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/env_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/env_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/env_id/settings/code-redaction/include/classes/class_name");

xhr.send(data);
import requests

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

env_id
string
required

Environment ID to use (e.g. S1234)

class_name
string
required

Fully qualified Java class name

Response

An included class

namestring

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/env_id/settings/code-redaction/include/classes/class_name
curl --request PUT \
  --url https://api.overops.com/api/v1/services/env_id/settings/code-redaction/include/classes/class_name
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.overops.com/api/v1/services/env_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/env_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/env_id/settings/code-redaction/include/classes/class_name");

xhr.send(data);
import requests

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

env_id
string
required

Environment ID to use (e.g. S1234)

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/env_id/settings/code-redaction/include/classes/class_name
curl --request DELETE \
  --url https://api.overops.com/api/v1/services/env_id/settings/code-redaction/include/classes/class_name
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.overops.com/api/v1/services/env_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/env_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/env_id/settings/code-redaction/include/classes/class_name");

xhr.send(data);
import requests

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

env_id
string
required

Environment ID to use (e.g. S1234)

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/env_id/settings/code-redaction/include/packages
curl --request GET \
  --url https://api.overops.com/api/v1/services/env_id/settings/code-redaction/include/packages
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/env_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/env_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/env_id/settings/code-redaction/include/packages");

xhr.send(data);
import requests

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

env_id
string
required

Environment ID to use (e.g. S1234)

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/env_id/settings/code-redaction/include/packages/package_name
curl --request GET \
  --url https://api.overops.com/api/v1/services/env_id/settings/code-redaction/include/packages/package_name
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/env_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/env_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/env_id/settings/code-redaction/include/packages/package_name");

xhr.send(data);
import requests

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

env_id
string
required

Environment ID to use (e.g. S1234)

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/env_id/settings/code-redaction/include/packages/package_name
curl --request PUT \
  --url https://api.overops.com/api/v1/services/env_id/settings/code-redaction/include/packages/package_name
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.overops.com/api/v1/services/env_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/env_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/env_id/settings/code-redaction/include/packages/package_name");

xhr.send(data);
import requests

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

env_id
string
required

Environment ID to use (e.g. S1234)

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/env_id/settings/code-redaction/include/packages/package_name
curl --request DELETE \
  --url https://api.overops.com/api/v1/services/env_id/settings/code-redaction/include/packages/package_name
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.overops.com/api/v1/services/env_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/env_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/env_id/settings/code-redaction/include/packages/package_name");

xhr.send(data);
import requests

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

env_id
string
required

Environment ID to use (e.g. S1234)

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

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

xhr.send(data);
import requests

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

env_id
string
required

Environment ID to use (e.g. S1234)

Response

List of data redaction

packagesarray
patternsarray
identifiersarray
classesarray

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

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

xhr.send(data);
import requests

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

env_id
string
required

Environment ID to use (e.g. S1234)

Response

List of regex patterns

patternsarray

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/env_id/settings/data-redaction/patterns/pattern
curl --request GET \
  --url https://api.overops.com/api/v1/services/env_id/settings/data-redaction/patterns/pattern
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/env_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/env_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/env_id/settings/data-redaction/patterns/pattern");

xhr.send(data);
import requests

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

env_id
string
required

Environment ID to use (e.g. S1234)

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/env_id/settings/data-redaction/patterns/pattern
curl --request PUT \
  --url https://api.overops.com/api/v1/services/env_id/settings/data-redaction/patterns/pattern
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.overops.com/api/v1/services/env_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/env_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/env_id/settings/data-redaction/patterns/pattern");

xhr.send(data);
import requests

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

env_id
string
required

Environment ID to use (e.g. S1234)

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/env_id/settings/data-redaction/patterns/pattern
curl --request DELETE \
  --url https://api.overops.com/api/v1/services/env_id/settings/data-redaction/patterns/pattern
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.overops.com/api/v1/services/env_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/env_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/env_id/settings/data-redaction/patterns/pattern");

xhr.send(data);
import requests

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

env_id
string
required

Environment ID to use (e.g. S1234)

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

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

xhr.send(data);
import requests

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

env_id
string
required

Environment ID to use (e.g. S1234)

Response

List of identifiers

identifiersarray

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/env_id/settings/data-redaction/identifiers/identifier
curl --request GET \
  --url https://api.overops.com/api/v1/services/env_id/settings/data-redaction/identifiers/identifier
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/env_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/env_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/env_id/settings/data-redaction/identifiers/identifier");

xhr.send(data);
import requests

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

env_id
string
required

Environment ID to use (e.g. S1234)

identifier
string
required

A code identifier

Response

If the redaction exists

namestring

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/env_id/settings/data-redaction/identifiers/identifier
curl --request PUT \
  --url https://api.overops.com/api/v1/services/env_id/settings/data-redaction/identifiers/identifier
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.overops.com/api/v1/services/env_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/env_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/env_id/settings/data-redaction/identifiers/identifier");

xhr.send(data);
import requests

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

env_id
string
required

Environment ID to use (e.g. S1234)

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/env_id/settings/data-redaction/identifiers/identifier
curl --request DELETE \
  --url https://api.overops.com/api/v1/services/env_id/settings/data-redaction/identifiers/identifier
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.overops.com/api/v1/services/env_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/env_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/env_id/settings/data-redaction/identifiers/identifier");

xhr.send(data);
import requests

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

env_id
string
required

Environment ID to use (e.g. S1234)

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

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

xhr.send(data);
import requests

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

env_id
string
required

Environment ID to use (e.g. S1234)

Response

List of classes

classesarray

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/env_id/settings/data-redaction/classes/class_name
curl --request GET \
  --url https://api.overops.com/api/v1/services/env_id/settings/data-redaction/classes/class_name
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/env_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/env_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/env_id/settings/data-redaction/classes/class_name");

xhr.send(data);
import requests

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

env_id
string
required

Environment ID to use (e.g. S1234)

class_name
string
required

Class name to redact.

Response

If the redaction exists

namestring

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/env_id/settings/data-redaction/classes/class_name
curl --request PUT \
  --url https://api.overops.com/api/v1/services/env_id/settings/data-redaction/classes/class_name
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.overops.com/api/v1/services/env_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/env_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/env_id/settings/data-redaction/classes/class_name");

xhr.send(data);
import requests

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

env_id
string
required

Environment ID to use (e.g. S1234)

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/env_id/settings/data-redaction/classes/class_name
curl --request DELETE \
  --url https://api.overops.com/api/v1/services/env_id/settings/data-redaction/classes/class_name
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.overops.com/api/v1/services/env_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/env_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/env_id/settings/data-redaction/classes/class_name");

xhr.send(data);
import requests

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

env_id
string
required

Environment ID to use (e.g. S1234)

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

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

xhr.send(data);
import requests

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

env_id
string
required

Environment ID to use (e.g. S1234)

Response

List of packages

packagesarray

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/env_id/settings/data-redaction/packages/package_name
curl --request GET \
  --url https://api.overops.com/api/v1/services/env_id/settings/data-redaction/packages/package_name
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.overops.com/api/v1/services/env_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/env_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/env_id/settings/data-redaction/packages/package_name");

xhr.send(data);
import requests

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

env_id
string
required

Environment ID to use (e.g. S1234)

package_name
string
required

Fully qualified Java package name

Response

If the redaction exists

namestring

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/env_id/settings/data-redaction/packages/package_name
curl --request PUT \
  --url https://api.overops.com/api/v1/services/env_id/settings/data-redaction/packages/package_name
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.overops.com/api/v1/services/env_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/env_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/env_id/settings/data-redaction/packages/package_name");

xhr.send(data);
import requests

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

env_id
string
required

Environment ID to use (e.g. S1234)

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/env_id/settings/data-redaction/packages/package_name
curl --request DELETE \
  --url https://api.overops.com/api/v1/services/env_id/settings/data-redaction/packages/package_name
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.overops.com/api/v1/services/env_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/env_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/env_id/settings/data-redaction/packages/package_name");

xhr.send(data);
import requests

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

env_id
string
required

Environment ID to use (e.g. S1234)

package_name
string
required

Fully qualified Java package name

Response

OK

Unauthorized

Not Found

Suggest Edits

Publish Metrics

 
Suggest Edits

Fetch Publish Metrics settings

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

 

Basic Auth

Header Auth

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

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

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

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

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

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

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

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

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

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

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

xhr.send(data);
import requests

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

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment to use

Response

Current settings for publish metrics

enabledboolean
hostnamestring

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

output_formatstring
metricsarray

Unauthorized

Not Found

Suggest Edits

Set Publish Metrics

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

 

Basic Auth

Header Auth

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

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

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

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

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

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

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

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

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

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

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

xhr.send(data);
import requests

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

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment to use

Body Params

enabled
boolean
hostname
string

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

output_format
string
metrics
array of objects
name
pattern

Response

OK

Unauthorized

Not Found

Suggest Edits

Fetch Available formats

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

 

Basic Auth

Header Auth

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

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

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

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

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

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

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

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

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

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

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

xhr.send(data);
import requests

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

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment to use

Response

List of Available formats and metrics

Unauthorized

Not Found

Suggest Edits

Categories

 
Suggest Edits

List categories

List view categories

 

Basic Auth

Header Auth

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

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

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

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

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

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

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

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

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

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

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

xhr.send(data);
import requests

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

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

Response

List of View Categories and their info

categoriesarray

Unauthorized

Suggest Edits

Create category (Not implemented yet)

Create category (Not implemented yet)

 

Basic Auth

Header Auth

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

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

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

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

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

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

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

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

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

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

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

xhr.send(data);
import requests

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

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

Body Params

id
string
name
string

Category Name

shared
boolean

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

admin
boolean

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

icon
string

(TBD - NOT YET IMPLEMENTED) based 64 encoded SVG

views
array of objects
id
name
shared
admin

Response

TBD

Bad Request

Unauthorized

Conflict

Suggest Edits

Get category details (Not implemented yet)

Get category details (Not implemented yet)

 

Basic Auth

Header Auth

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

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

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

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

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

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

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

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

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

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

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

xhr.send(data);
import requests

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

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

category_id
string
required

View category to use

Response

Category info

idstring
namestring

Category Name

sharedboolean

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

adminboolean

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

iconstring

(TBD - NOT YET IMPLEMENTED) based 64 encoded SVG

viewsarray

Unauthorized

Forbidden

Suggest Edits

Delete category (Not implemented yet)

Delete category (Not implemented yet)

 

Basic Auth

Header Auth

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

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

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

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

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

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

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

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

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

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

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

xhr.send(data);
import requests

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

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

category_id
string
required

View category to use

Response

OK

Unauthorized

Forbidden

Suggest Edits

Add view to selected category

Add view to selected category

 

Basic Auth

Header Auth

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

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

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

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

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

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

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

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

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

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

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

xhr.send(data);
import requests

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

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

category_id
string
required

View category to use

Response

OK

Unauthorized

Forbidden

Not Found

Suggest Edits

List views

List views

 

Basic Auth

Header Auth

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

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

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

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

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

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

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

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

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

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

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

xhr.send(data);
import requests

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

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

Response

List of views including basic info about each view.

viewsarray

Unauthorized

Suggest Edits

Create view

Create view

 

Basic Auth

Header Auth

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

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

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

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

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

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

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

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

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

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

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

xhr.send(data);
import requests

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

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

Body Params

name
string
description
string
shared
boolean
admin
boolean

Indicates that this view is accessible to environment admins only.

default
boolean

TBD - NOT YET IMPLEMENTED

filters
object

Filter properties

 
filters.first_seen
object

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

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

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

filters.first_seen.absolute.to
string

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

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

List of labels

filters.event_type
array of strings

List of event types

filters.event_name
array of strings

(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

Response

OK

Bad Request

Unauthorized

Conflict

Suggest Edits

Get view properties

Get full list of view properties

 

Basic Auth

Header Auth

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

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

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

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

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

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

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

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

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

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

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

xhr.send(data);
import requests

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

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

view_id
string
required

View to use

Response

Full list of view properties

viewsarray

Unauthorized

Forbidden

Not Found

Suggest Edits

Edit view data

Edit view data

 

Basic Auth

Header Auth

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

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

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

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

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

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

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

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

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

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

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

xhr.send(data);
import requests

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

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

env_id
string
required

Environment ID to use (e.g. S1234)

view_id
string
required

View to use

Body Params

name
string
description
string
shared
boolean
admin
boolean

Indicates that this view is accessible to environment admins only.

default
boolean

TBD - NOT YET IMPLEMENTED

filters
object

Filter properties

 
filters.first_seen
object

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

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

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

filters.first_seen.absolute.to
string

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

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

List of labels

filters.event_type
array of strings

List of event types

filters.event_name
array of strings

(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

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/env_id/views/