Overops Code Redaction API
Fetch and manipulate code filters to include / exclude 3rd party and utility classes from OverOps analysis and data capture.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/overops-code-redaction-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
version: v1
title: Services Alerts Code Redaction API
contact:
email: hello@overops.com
description: "Main OverOps API.\nThe REST API layer enables OverOps admins and users to perform and automate all actions\nprovided by the OverOps UI available at https://app.overops.com (or On-premises equivalent URL) via a platform independent programmatic interface.\nA wrapper Java client API library that leverages these APIs for convenience by\nJava and Scala developers is available at https://github.com/takipi/api-client and on Maven Central.\n\nAll calls must be authenticated using one of the following methods:\n 1. Using `x-api-key` header (To generate the token, go to `Settings` --> `Account Settings` in the OverOps App). This is the recommended method.\n 2. Using Basic auth with `username:password` combo.\n"
servers:
- url: https://api.overops.com/api/v1
security:
- basicAuth: []
- ApiKeyAuth: []
tags:
- name: Code Redaction
description: Fetch and manipulate code filters to include / exclude 3rd party and utility classes from OverOps analysis and data capture.
paths:
/services/{env_id}/settings/code-redaction:
get:
tags:
- Code Redaction
summary: List all environment code redaction settings
description: List all environment code exclusions and inclusions
parameters:
- in: path
name: env_id
description: Environment ID to use (e.g. S1234)
required: true
schema:
type: string
responses:
'200':
description: List of included and excluded classes and packages
content:
'*/*':
schema:
type: object
properties:
exclude:
type: object
properties:
classes:
type: array
items:
$ref: '#/components/schemas/ClassName'
packages:
type: array
items:
$ref: '#/components/schemas/PackageName'
include:
type: object
properties:
classes:
type: array
items:
$ref: '#/components/schemas/ClassName'
packages:
type: array
items:
$ref: '#/components/schemas/PackageName'
'401':
$ref: '#/components/responses/UnauthorizedError'
/services/{env_id}/settings/code-redaction/exclude:
get:
tags:
- Code Redaction
summary: List all code exclusions
description: List all code exclusions
parameters:
- in: path
name: env_id
description: Environment ID to use (e.g. S1234)
required: true
schema:
type: string
responses:
'200':
description: List of excluded classes and packages
content:
'*/*':
schema:
type: object
properties:
classes:
type: array
items:
$ref: '#/components/schemas/ClassName'
packages:
type: array
items:
$ref: '#/components/schemas/PackageName'
'401':
$ref: '#/components/responses/UnauthorizedError'
post:
tags:
- Code Redaction
summary: Add a bulk of code exclusions
description: Add a bulk of code exclusions
parameters:
- in: path
name: env_id
description: Environment ID to use (e.g. S1234)
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
classes:
type: array
items:
$ref: '#/components/schemas/ClassName'
packages:
type: array
items:
$ref: '#/components/schemas/PackageName'
description: code exclusions
required: true
responses:
'200':
$ref: '#/components/responses/OK'
'401':
$ref: '#/components/responses/UnauthorizedError'
/services/{env_id}/settings/code-redaction/exclude/classes:
get:
tags:
- Code Redaction
summary: List all excluded classes
description: List all excluded classes
parameters:
- in: path
name: env_id
description: Environment ID to use (e.g. S1234)
required: true
schema:
type: string
responses:
'200':
description: List of excluded classes
content:
'*/*':
schema:
type: object
properties:
classes:
type: array
items:
$ref: '#/components/schemas/ClassName'
'401':
$ref: '#/components/responses/UnauthorizedError'
/services/{env_id}/settings/code-redaction/exclude/classes/{class_name}:
get:
tags:
- Code Redaction
summary: Retrieve an excluded class
description: Retrieve an excluded class
parameters:
- in: path
name: env_id
description: Environment ID to use (e.g. S1234)
required: true
schema:
type: string
- in: path
name: class_name
required: true
description: Fully qualified Java class name
schema:
type: string
responses:
'200':
description: An excluded class
content:
'*/*':
schema:
type: object
properties:
name:
$ref: '#/components/schemas/ClassName'
'401':
$ref: '#/components/responses/UnauthorizedError'
'404':
$ref: '#/components/responses/NotFoundError'
put:
tags:
- Code Redaction
summary: Add a class to the exclusion list
description: Add a class to the exclusion list. The body class name must match the resource identifier
parameters:
- in: path
name: env_id
description: Environment ID to use (e.g. S1234)
required: true
schema:
type: string
- in: path
name: class_name
required: true
description: Fully qualified Java class name
schema:
type: string
requestBody:
$ref: '#/components/requestBodies/Class'
responses:
'200':
$ref: '#/components/responses/OK'
'400':
$ref: '#/components/responses/BadRequestError'
'401':
$ref: '#/components/responses/UnauthorizedError'
delete:
tags:
- Code Redaction
summary: Remove a class from exclusion
description: Remove a class from the exclusion list
parameters:
- in: path
name: env_id
description: Environment ID to use (e.g. S1234)
required: true
schema:
type: string
- in: path
name: class_name
required: true
description: Fully qualified Java class name
schema:
type: string
responses:
'200':
$ref: '#/components/responses/OK'
'401':
$ref: '#/components/responses/UnauthorizedError'
'404':
$ref: '#/components/responses/NotFoundError'
/services/{env_id}/settings/code-redaction/exclude/packages:
get:
tags:
- Code Redaction
summary: List all excluded packages
description: List all excluded packages
parameters:
- in: path
name: env_id
description: Environment ID to use (e.g. S1234)
required: true
schema:
type: string
responses:
'200':
description: List of excluded packages
content:
'*/*':
schema:
type: object
properties:
packages:
type: array
items:
$ref: '#/components/schemas/PackageName'
'401':
$ref: '#/components/responses/UnauthorizedError'
/services/{env_id}/settings/code-redaction/exclude/packages/{package_name}:
get:
tags:
- Code Redaction
summary: Retrieve an excluded package
description: Retrieve an excluded package
parameters:
- in: path
name: env_id
description: Environment ID to use (e.g. S1234)
required: true
schema:
type: string
- in: path
name: package_name
required: true
description: Fully qualified Java package name
schema:
type: string
responses:
'200':
description: An excluded package
content:
'*/*':
schema:
type: object
properties:
name:
$ref: '#/components/schemas/PackageName'
'401':
$ref: '#/components/responses/UnauthorizedError'
'404':
$ref: '#/components/responses/NotFoundError'
put:
tags:
- Code Redaction
summary: Add a package to the exclusion list
description: Add a package to the exclusion list. The body package name must match the resource identifier
parameters:
- in: path
name: env_id
description: Environment ID to use (e.g. S1234)
required: true
schema:
type: string
- in: path
name: package_name
required: true
description: Fully qualified Java package name
schema:
type: string
requestBody:
$ref: '#/components/requestBodies/Package'
responses:
'200':
$ref: '#/components/responses/OK'
'400':
$ref: '#/components/responses/BadRequestError'
'401':
$ref: '#/components/responses/UnauthorizedError'
delete:
tags:
- Code Redaction
summary: Remove a package from the exclusion list
description: Remove a package from the exclusion list
parameters:
- in: path
name: env_id
description: Environment ID to use (e.g. S1234)
required: true
schema:
type: string
- in: path
name: package_name
required: true
description: Fully qualified Java package name
schema:
type: string
responses:
'200':
$ref: '#/components/responses/OK'
'401':
$ref: '#/components/responses/UnauthorizedError'
'404':
$ref: '#/components/responses/NotFoundError'
/services/{env_id}/settings/code-redaction/include:
get:
tags:
- Code Redaction
summary: List all code inclusions
description: List all code inclusions
parameters:
- in: path
name: env_id
description: Environment ID to use (e.g. S1234)
required: true
schema:
type: string
responses:
'200':
description: List of included classes and packages
content:
'*/*':
schema:
type: object
properties:
classes:
type: array
items:
$ref: '#/components/schemas/ClassName'
packages:
type: array
items:
$ref: '#/components/schemas/PackageName'
'401':
$ref: '#/components/responses/UnauthorizedError'
post:
tags:
- Code Redaction
summary: Add a bulk of code inclusions
description: Add a bulk of code inclusions
parameters:
- in: path
name: env_id
description: Environment ID to use (e.g. S1234)
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
classes:
type: array
items:
$ref: '#/components/schemas/ClassName'
packages:
type: array
items:
$ref: '#/components/schemas/PackageName'
description: code inclusions
required: true
responses:
'200':
$ref: '#/components/responses/OK'
'401':
$ref: '#/components/responses/UnauthorizedError'
/services/{env_id}/settings/code-redaction/include/classes:
get:
tags:
- Code Redaction
summary: List all included classes
description: List all included classes
parameters:
- in: path
name: env_id
description: Environment ID to use (e.g. S1234)
required: true
schema:
type: string
responses:
'200':
description: List of included classes
content:
'*/*':
schema:
type: object
properties:
classes:
type: array
items:
$ref: '#/components/schemas/ClassName'
'401':
$ref: '#/components/responses/UnauthorizedError'
/services/{env_id}/settings/code-redaction/include/classes/{class_name}:
get:
tags:
- Code Redaction
summary: Retrieve an included class
description: Retrieve an included class
parameters:
- in: path
name: env_id
description: Environment ID to use (e.g. S1234)
required: true
schema:
type: string
- in: path
name: class_name
required: true
description: Fully qualified Java class name
schema:
type: string
responses:
'200':
description: An included class
content:
'*/*':
schema:
type: object
properties:
name:
$ref: '#/components/schemas/ClassName'
'401':
$ref: '#/components/responses/UnauthorizedError'
'404':
$ref: '#/components/responses/NotFoundError'
put:
tags:
- Code Redaction
summary: Add a class to the inclusion list
description: Add a class to the inclusion list. The body class name must match the resource identifier
parameters:
- in: path
name: env_id
description: Environment ID to use (e.g. S1234)
required: true
schema:
type: string
- in: path
name: class_name
required: true
description: Fully qualified Java class name
schema:
type: string
requestBody:
$ref: '#/components/requestBodies/Class'
responses:
'200':
$ref: '#/components/responses/OK'
'400':
$ref: '#/components/responses/BadRequestError'
'401':
$ref: '#/components/responses/UnauthorizedError'
delete:
tags:
- Code Redaction
summary: Remove a class from the inclusion list
description: Remove a class from the inclusion list
parameters:
- in: path
name: env_id
description: Environment ID to use (e.g. S1234)
required: true
schema:
type: string
- in: path
name: class_name
required: true
description: Fully qualified Java class name
schema:
type: string
responses:
'200':
$ref: '#/components/responses/OK'
'401':
$ref: '#/components/responses/UnauthorizedError'
'404':
$ref: '#/components/responses/NotFoundError'
/services/{env_id}/settings/code-redaction/include/packages:
get:
tags:
- Code Redaction
summary: List all included packages
description: List all included packages
parameters:
- in: path
name: env_id
description: Environment ID to use (e.g. S1234)
required: true
schema:
type: string
responses:
'200':
description: List of included packages
content:
'*/*':
schema:
properties:
packages:
type: array
items:
$ref: '#/components/schemas/PackageName'
'401':
$ref: '#/components/responses/UnauthorizedError'
/services/{env_id}/settings/code-redaction/include/packages/{package_name}:
get:
tags:
- Code Redaction
summary: Retrieve an included package
description: Retrieve an included package
parameters:
- in: path
name: env_id
description: Environment ID to use (e.g. S1234)
required: true
schema:
type: string
- in: path
name: package_name
required: true
description: Fully qualified Java package name
schema:
type: string
responses:
'200':
description: An included package
'401':
$ref: '#/components/responses/UnauthorizedError'
'404':
$ref: '#/components/responses/NotFoundError'
put:
tags:
- Code Redaction
summary: Add a package to the inclusion list
description: Add a package to the inclusion list. The body package name must match the resource identifier
parameters:
- in: path
name: env_id
description: Environment ID to use (e.g. S1234)
required: true
schema:
type: string
- in: path
name: package_name
required: true
description: Fully qualified Java package name
schema:
type: string
requestBody:
$ref: '#/components/requestBodies/Package2'
responses:
'200':
$ref: '#/components/responses/OK'
'400':
$ref: '#/components/responses/BadRequestError'
'401':
$ref: '#/components/responses/UnauthorizedError'
delete:
tags:
- Code Redaction
summary: Remove a package from the inclusion list
description: Remove a package from the inclusion list
parameters:
- in: path
name: env_id
description: Environment ID to use (e.g. S1234)
required: true
schema:
type: string
- in: path
name: package_name
required: true
description: Fully qualified Java package name
schema:
type: string
responses:
'200':
$ref: '#/components/responses/OK'
'401':
$ref: '#/components/responses/UnauthorizedError'
'404':
$ref: '#/components/responses/NotFoundError'
components:
schemas:
PackageName:
type: string
example: com.company.package.name
ClassName:
type: string
example: com.company.ClassName
requestBodies:
Package:
content:
application/json:
schema:
type: object
properties:
name:
$ref: '#/components/schemas/PackageName'
Class:
content:
application/json:
schema:
type: object
properties:
name:
$ref: '#/components/schemas/ClassName'
Package2:
content:
application/json:
schema:
properties:
name:
$ref: '#/components/schemas/PackageName'
responses:
BadRequestError:
description: Bad Request
UnauthorizedError:
description: Unauthorized
OK:
description: OK
NotFoundError:
description: Not Found
securitySchemes:
basicAuth:
type: http
scheme: basic
ApiKeyAuth:
type: apiKey
in: header
name: X-API-KEY