Merge

Merge Subpackage Custom Regex Rules API

The subpackage_customRegexRules API from Merge — 4 operation(s) for subpackage_customregexrules.

Documentation GitHub OpenAPI

Operations 10

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /api/v1/security/custom-regex-rules/ List organization custom regex rules · List custom regex rules #

Ask an LLM

“Which custom regex detection rules has my organization defined for Agent Handler?”

“Can I page through all the org-level pattern rules that block or redact data?”

Tell an agent

List all organization-wide custom regex rules.

Show page {page} of my org regex rules.

POST /api/v1/security/custom-regex-rules/ Create an organization custom regex rule · Create custom regex rule #

Ask an LLM

“Can I add my own regex to detect sensitive data in tool calls across the whole organization?”

“What actions can an org-level regex rule take on inbound or outbound matches?”

Tell an agent

Create an org regex rule named {name} matching {regex}.

Add organization rule {name} for pattern {regex} that does {outbound_action} on outbound matches.

GET /api/v1/security/custom-regex-rules/{rule_id}/ Get an organization custom regex rule · Get custom regex rule #

Ask an LLM

“What pattern and actions are configured on one of my org-level regex rules?”

“Can I look up a single organization detection rule by its ID?”

Tell an agent

Get org custom regex rule {rule_id}.

Show the settings of organization pattern rule {rule_id}.

DELETE /api/v1/security/custom-regex-rules/{rule_id}/ Delete an organization custom regex rule · Delete custom regex rule #

Ask an LLM

“Can I remove an organization-wide regex rule I no longer need?”

“Is deleting an org-level detection rule done by its rule ID?”

Tell an agent destructive · confirm first

Delete org custom regex rule {rule_id}.

Remove organization pattern rule {rule_id} permanently.

PATCH /api/v1/security/custom-regex-rules/{rule_id}/ Update an organization custom regex rule · Update custom regex rule #

Ask an LLM

“Can I change the pattern of an org-level regex rule after creating it?”

“Is it possible to disable an organization detection rule without deleting it?”

Tell an agent

Change the pattern of org rule {rule_id} to {regex}.

Set org regex rule {rule_id} active status to {is_active}.

GET /api/v1/tool-packs/{tool_pack_id}/custom-regex-rules/ List a tool pack's custom regex rules · List custom regex rules (Tool Pack) #

Ask an LLM

“Which regex rules apply to a particular tool pack, including inherited org defaults?”

“Can I see only the rules defined on the tool pack itself rather than inherited ones?”

Tell an agent

List custom regex rules for tool pack {tool_pack_id}.

Show regex rules on tool pack {tool_pack_id} defined at {defined_at} level.

POST /api/v1/tool-packs/{tool_pack_id}/custom-regex-rules/ Create a tool pack regex rule or override · Create custom regex rule (Tool Pack) #

Ask an LLM

“Can I override an organization regex rule for just one tool pack?”

“How do I add a detection pattern that applies only to a single tool pack?”

Tell an agent

Create rule {name} with pattern {regex} on tool pack {tool_pack_id}.

Override org rule {name} for tool pack {tool_pack_id} with inbound action {inbound_action}.

GET /api/v1/tool-packs/{tool_pack_id}/custom-regex-rules/{rule_id}/ Get a tool pack's custom regex rule · Get custom regex rule (Tool Pack) #

Ask an LLM

“What does a specific regex rule look like inside one tool pack?”

“Can I fetch a tool-pack-level rule override by its ID?”

Tell an agent

Get regex rule {rule_id} in tool pack {tool_pack_id}.

Show tool pack {tool_pack_id}'s rule {rule_id} settings.

DELETE /api/v1/tool-packs/{tool_pack_id}/custom-regex-rules/{rule_id}/ Delete a tool pack regex rule or override · Delete custom regex rule (Tool Pack) #

Ask an LLM

“If I delete a tool pack's override, does it revert to the organization default rule?”

“Can I permanently remove a regex rule that exists only on one tool pack?”

Tell an agent destructive · confirm first

Delete regex rule {rule_id} from tool pack {tool_pack_id}.

Revert tool pack {tool_pack_id} rule {rule_id} to the org default.

PATCH /api/v1/tool-packs/{tool_pack_id}/custom-regex-rules/{rule_id}/ Update a tool pack's custom regex rule · Update custom regex rule (Tool Pack) #

Ask an LLM

“Can I change the confidence score of a regex rule for one tool pack only?”

“Which parts of a tool pack rule can I edit after it's created?”

Tell an agent

Set the score of rule {rule_id} in tool pack {tool_pack_id} to {score}.

Update tool pack {tool_pack_id} rule {rule_id} context keywords to {context_keywords}.

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.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/merge:merge-subpackage-customregexrules-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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Agent Handler Subpackage Custom Regex Rules API
  version: 1.0.0
servers:
- url: https://ah-api.merge.dev
tags:
- name: subpackage_customRegexRules
paths:
  /api/v1/security/custom-regex-rules/:
    get:
      operationId: list-custom-regex-rules
      summary: List custom regex rules
      description: Returns all custom regex rules for the organization.
      tags:
      - subpackage_customRegexRules
      parameters:
      - name: page
        in: query
        description: A page number within the paginated result set.
        required: false
        schema:
          type: integer
      - name: page_size
        in: query
        description: Number of results to return per page.
        required: false
        schema:
          type: integer
      - name: Authorization
        in: header
        description: Token-based authentication with required prefix "Bearer"
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedCustomRegexRuleResponseList'
    post:
      operationId: create-custom-regex-rule
      summary: Create custom regex rule
      description: Create a new custom regex rule for the organization.
      tags:
      - subpackage_customRegexRules
      parameters:
      - name: Authorization
        in: header
        description: Token-based authentication with required prefix "Bearer"
        required: true
        schema:
          type: string
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomRegexRuleResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomRegexRuleCreateInput'
  /api/v1/security/custom-regex-rules/{rule_id}/:
    get:
      operationId: get-custom-regex-rule
      summary: Get custom regex rule
      description: Retrieve a single custom regex rule by ID.
      tags:
      - subpackage_customRegexRules
      parameters:
      - name: rule_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: Authorization
        in: header
        description: Token-based authentication with required prefix "Bearer"
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomRegexRuleResponse'
    delete:
      operationId: delete-custom-regex-rule
      summary: Delete custom regex rule
      description: Delete a custom regex rule.
      tags:
      - subpackage_customRegexRules
      parameters:
      - name: rule_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: Authorization
        in: header
        description: Token-based authentication with required prefix "Bearer"
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
    patch:
      operationId: update-custom-regex-rule
      summary: Update custom regex rule
      description: Update a custom regex rule. Name cannot be changed after creation.
      tags:
      - subpackage_customRegexRules
      parameters:
      - name: rule_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: Authorization
        in: header
        description: Token-based authentication with required prefix "Bearer"
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomRegexRuleResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedCustomRegexRuleUpdateInput'
  /api/v1/tool-packs/{tool_pack_id}/custom-regex-rules/:
    get:
      operationId: list-custom-regex-rules-tool-pack
      summary: List custom regex rules (Tool Pack)
      description: Returns custom regex rules for a tool pack, including organization defaults. Tool-pack-level rules take precedence where both exist.
      tags:
      - subpackage_customRegexRules
      parameters:
      - name: tool_pack_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: defined_at
        in: query
        description: 'Filter by where the rule is defined. Values: ORGANIZATION, TOOL_PACK.'
        required: false
        schema:
          type: string
      - name: page
        in: query
        description: A page number within the paginated result set.
        required: false
        schema:
          type: integer
      - name: page_size
        in: query
        description: Number of results to return per page.
        required: false
        schema:
          type: integer
      - name: Authorization
        in: header
        description: Token-based authentication with required prefix "Bearer"
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedPublicCombinedCustomRegexRuleList'
    post:
      operationId: create-custom-regex-rule-tool-pack
      summary: Create custom regex rule (Tool Pack)
      description: Create a custom regex rule for a tool pack. If name matches an org rule, creates an override.
      tags:
      - subpackage_customRegexRules
      parameters:
      - name: tool_pack_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: Authorization
        in: header
        description: Token-based authentication with required prefix "Bearer"
        required: true
        schema:
          type: string
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicCombinedCustomRegexRule'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomRegexOverrideCreateInput'
  /api/v1/tool-packs/{tool_pack_id}/custom-regex-rules/{rule_id}/:
    get:
      operationId: get-custom-regex-rule-tool-pack
      summary: Get custom regex rule (Tool Pack)
      description: Retrieve a single custom regex rule for a tool pack by ID.
      tags:
      - subpackage_customRegexRules
      parameters:
      - name: rule_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: tool_pack_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: Authorization
        in: header
        description: Token-based authentication with required prefix "Bearer"
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicCombinedCustomRegexRule'
    delete:
      operationId: delete-custom-regex-rule-tool-pack
      summary: Delete custom regex rule (Tool Pack)
      description: Delete a custom regex rule override (reverts to org default) or permanently delete a tool-pack-only rule.
      tags:
      - subpackage_customRegexRules
      parameters:
      - name: rule_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: tool_pack_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: Authorization
        in: header
        description: Token-based authentication with required prefix "Bearer"
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
    patch:
      operationId: update-custom-regex-rule-tool-pack
      summary: Update custom regex rule (Tool Pack)
      description: Update a custom regex rule for a tool pack. Name cannot be changed after creation.
      tags:
      - subpackage_customRegexRules
      parameters:
      - name: rule_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: tool_pack_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: Authorization
        in: header
        description: Token-based authentication with required prefix "Bearer"
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicCombinedCustomRegexRule'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedToolPackCustomRegexOverride'
components:
  schemas:
    CustomRegexOverrideCreateInput:
      type: object
      properties:
        name:
          type: string
        regex:
          type: string
        score:
          type: number
          format: double
        context_keywords:
          description: Any type
        is_active:
          type: boolean
        inbound_action:
          $ref: '#/components/schemas/CustomRegexOverrideCreateInputInboundAction'
          description: '* `BLOCK` - BLOCK

            * `REDACT` - REDACT

            * `LOG` - LOG

            * `NONE` - NONE'
        outbound_action:
          $ref: '#/components/schemas/CustomRegexOverrideCreateInputOutboundAction'
          description: '* `BLOCK` - BLOCK

            * `REDACT` - REDACT

            * `LOG` - LOG

            * `NONE` - NONE'
      required:
      - name
      - regex
      - score
      - context_keywords
      - is_active
      - inbound_action
      - outbound_action
      description: Input serializer for POST /tool-packs/<id>/custom-regex-rules/.
      title: CustomRegexOverrideCreateInput
    CustomRegexRuleCreateInput:
      type: object
      properties:
        name:
          type: string
        regex:
          type: string
        score:
          type: number
          format: double
          default: 0.5
        inbound_action:
          $ref: '#/components/schemas/CustomRegexRuleCreateInputInboundAction'
          description: '* `BLOCK` - BLOCK

            * `REDACT` - REDACT

            * `LOG` - LOG

            * `NONE` - NONE'
        outbound_action:
          $ref: '#/components/schemas/CustomRegexRuleCreateInputOutboundAction'
          description: '* `BLOCK` - BLOCK

            * `REDACT` - REDACT

            * `LOG` - LOG

            * `NONE` - NONE'
        context_keywords:
          type: array
          items:
            type: string
      required:
      - name
      - regex
      description: 'Shared field validators for create and update input serializers.


        The presidio validate_* functions raise RequestValidationError (a DRF APIException),

        which bypasses the serializer''s field error mapping. We catch and re-raise as

        serializers.ValidationError so errors are attributed to the correct field.'
      title: CustomRegexRuleCreateInput
    PatchedToolPackCustomRegexOverride:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        is_active:
          type: boolean
        regex:
          type: string
        score:
          type: number
          format: double
        context_keywords:
          description: Any type
        inbound_action:
          $ref: '#/components/schemas/PatchedToolPackCustomRegexOverrideInboundAction'
          description: '* `BLOCK` - BLOCK

            * `REDACT` - REDACT

            * `LOG` - LOG

            * `NONE` - NONE'
        outbound_action:
          $ref: '#/components/schemas/PatchedToolPackCustomRegexOverrideOutboundAction'
          description: '* `BLOCK` - BLOCK

            * `REDACT` - REDACT

            * `LOG` - LOG

            * `NONE` - NONE'
        created_at:
          type: string
          format: date-time
        modified_at:
          type: string
          format: date-time
      description: Rejects requests that explicitly set defined_at to ORGANIZATION in tool pack endpoints.
      title: PatchedToolPackCustomRegexOverride
    PaginatedPublicCombinedCustomRegexRuleList:
      type: object
      properties:
        count:
          type: integer
        next:
          type:
          - string
          - 'null'
          format: uri
        previous:
          type:
          - string
          - 'null'
          format: uri
        results:
          type: array
          items:
            $ref: '#/components/schemas/PublicCombinedCustomRegexRule'
      required:
      - count
      - results
      title: PaginatedPublicCombinedCustomRegexRuleList
    CustomRegexRuleResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        regex:
          type: string
        score:
          type: number
          format: double
        context_keywords:
          type: array
          items:
            type: string
        is_active:
          type: boolean
        created_at:
          type: string
          format: date-time
        modified_at:
          type: string
          format: date-time
        outbound_action:
          oneOf:
          - $ref: '#/components/schemas/CustomRegexRuleResponseOutboundAction'
          - type: 'null'
          description: '* `BLOCK` - BLOCK

            * `REDACT` - REDACT

            * `LOG` - LOG

            * `NONE` - NONE'
        defined_at:
          type: string
      required:
      - id
      - name
      - regex
      - score
      - context_keywords
      - is_active
      - created_at
      - modified_at
      - outbound_action
      - defined_at
      description: Custom regex rule for an organization.
      title: CustomRegexRuleResponse
    CustomRegexOverrideCreateInputInboundAction:
      type: string
      enum:
      - BLOCK
      - REDACT
      - LOG
      - NONE
      description: '* `BLOCK` - BLOCK

        * `REDACT` - REDACT

        * `LOG` - LOG

        * `NONE` - NONE'
      title: CustomRegexOverrideCreateInputInboundAction
    PatchedToolPackCustomRegexOverrideOutboundAction:
      type: string
      enum:
      - BLOCK
      - REDACT
      - LOG
      - NONE
      description: '* `BLOCK` - BLOCK

        * `REDACT` - REDACT

        * `LOG` - LOG

        * `NONE` - NONE'
      title: PatchedToolPackCustomRegexOverrideOutboundAction
    CustomRegexRuleCreateInputInboundAction:
      type: string
      enum:
      - BLOCK
      - REDACT
      - LOG
      - NONE
      default: REDACT
      description: '* `BLOCK` - BLOCK

        * `REDACT` - REDACT

        * `LOG` - LOG

        * `NONE` - NONE'
      title: CustomRegexRuleCreateInputInboundAction
    PublicCombinedCustomRegexRule:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        regex:
          type: string
        score:
          type: number
          format: double
        context_keywords:
          description: Any type
        is_active:
          type: boolean
        outbound_action:
          type: string
        defined_at:
          type: string
      required:
      - id
      - name
      - regex
      - score
      - context_keywords
      - is_active
      - outbound_action
      - defined_at
      description: Custom regex rule with effective configuration for a tool pack.
      title: PublicCombinedCustomRegexRule
    CustomRegexRuleCreateInputOutboundAction:
      type: string
      enum:
      - BLOCK
      - REDACT
      - LOG
      - NONE
      default: REDACT
      description: '* `BLOCK` - BLOCK

        * `REDACT` - REDACT

        * `LOG` - LOG

        * `NONE` - NONE'
      title: CustomRegexRuleCreateInputOutboundAction
    PatchedCustomRegexRuleUpdateInput:
      type: object
      properties:
        name:
          type: string
        regex:
          type: string
        score:
          type: number
          format: double
        inbound_action:
          $ref: '#/components/schemas/PatchedCustomRegexRuleUpdateInputInboundAction'
          description: '* `BLOCK` - BLOCK

            * `REDACT` - REDACT

            * `LOG` - LOG

            * `NONE` - NONE'
        outbound_action:
          $ref: '#/components/schemas/PatchedCustomRegexRuleUpdateInputOutboundAction'
          description: '* `BLOCK` - BLOCK

            * `REDACT` - REDACT

            * `LOG` - LOG

            * `NONE` - NONE'
        context_keywords:
          type: array
          items:
            type: string
        is_active:
          type: boolean
      description: 'Shared field validators for create and update input serializers.


        The presidio validate_* functions raise RequestValidationError (a DRF APIException),

        which bypasses the serializer''s field error mapping. We catch and re-raise as

        serializers.ValidationError so errors are attributed to the correct field.'
      title: PatchedCustomRegexRuleUpdateInput
    PatchedToolPackCustomRegexOverrideInboundAction:
      type: string
      enum:
      - BLOCK
      - REDACT
      - LOG
      - NONE
      description: '* `BLOCK` - BLOCK

        * `REDACT` - REDACT

        * `LOG` - LOG

        * `NONE` - NONE'
      title: PatchedToolPackCustomRegexOverrideInboundAction
    PatchedCustomRegexRuleUpdateInputInboundAction:
      type: string
      enum:
      - BLOCK
      - REDACT
      - LOG
      - NONE
      description: '* `BLOCK` - BLOCK

        * `REDACT` - REDACT

        * `LOG` - LOG

        * `NONE` - NONE'
      title: PatchedCustomRegexRuleUpdateInputInboundAction
    CustomRegexRuleResponseOutboundAction:
      type: string
      enum:
      - BLOCK
      - REDACT
      - LOG
      - NONE
      description: '* `BLOCK` - BLOCK

        * `REDACT` - REDACT

        * `LOG` - LOG

        * `NONE` - NONE'
      title: CustomRegexRuleResponseOutboundAction
    PaginatedCustomRegexRuleResponseList:
      type: object
      properties:
        count:
          type: integer
        next:
          type:
          - string
          - 'null'
          format: uri
        previous:
          type:
          - string
          - 'null'
          format: uri
        results:
          type: array
          items:
            $ref: '#/components/schemas/CustomRegexRuleResponse'
      required:
      - count
      - results
      title: PaginatedCustomRegexRuleResponseList
    CustomRegexOverrideCreateInputOutboundAction:
      type: string
      enum:
      - BLOCK
      - REDACT
      - LOG
      - NONE
      description: '* `BLOCK` - BLOCK

        * `REDACT` - REDACT

        * `LOG` - LOG

        * `NONE` - NONE'
      title: CustomRegexOverrideCreateInputOutboundAction
    PatchedCustomRegexRuleUpdateInputOutboundAction:
      type: string
      enum:
      - BLOCK
      - REDACT
      - LOG
      - NONE
      description: '* `BLOCK` - BLOCK

        * `REDACT` - REDACT

        * `LOG` - LOG

        * `NONE` - NONE'
      title: PatchedCustomRegexRuleUpdateInputOutboundAction
  securitySchemes:
    tokenAuth:
      type: http
      scheme: bearer
      description: Token-based authentication with required prefix "Bearer"

Merge Subpackage Custom Regex Rules API

Operations 10

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification