---
updatedAt: 2025-05-19T23:57:22.000Z
agentTools:
  projectIndex: https://doc.overops.com/llms.txt
---

# List all data redactions

List all data redactions

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "version": "v1",
    "title": "Services 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"
  },
  "security": [
    {
      "basicAuth": []
    },
    {
      "ApiKeyAuth": []
    }
  ],
  "tags": [
    {
      "name": "Data Redaction",
      "description": "Fetch and manipulate data redaction of PII with target environments."
    }
  ],
  "paths": {
    "/services/{env_id}/settings/data-redaction": {
      "get": {
        "tags": [
          "Data Redaction"
        ],
        "summary": "List all data redactions",
        "description": "List all data redactions",
        "parameters": [
          {
            "in": "path",
            "name": "env_id",
            "description": "Environment ID to use (e.g. S1234)",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "List of data redaction",
            "content": {
              "*/*": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "enabled": {
                      "type": "boolean",
                      "example": true
                    },
                    "packages": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "name": {
                            "type": "string",
                            "example": "com.example"
                          }
                        }
                      }
                    },
                    "patterns": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/Pattern"
                      }
                    },
                    "identifiers": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "name": {
                            "type": "string",
                            "example": "password"
                          }
                        }
                      }
                    },
                    "classes": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "name": {
                            "type": "string",
                            "example": "IPv4"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/UnauthorizedError"
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://api.overops.com/api/v1"
    }
  ],
  "components": {
    "responses": {
      "UnauthorizedError": {
        "description": "Unauthorized"
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      },
      "ApiKeyAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "X-API-KEY"
      }
    },
    "schemas": {
      "Pattern": {
        "description": "A data redaction pattern used to define PII RegEx",
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "example": "Visa"
          },
          "category": {
            "type": "string",
            "example": "Credit Card"
          },
          "regex": {
            "type": "string",
            "example": "\\b4\\d{3}([\\-\\ ]?)(?:\\d{4}\\1){2}\\d(?:\\d{3})?\\b"
          },
          "is_active": {
            "type": "boolean",
            "example": true
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```