Merge Subpackage Standard Entity Rules API

The subpackage_standardEntityRules API from Merge — 4 operation(s) for subpackage_standardentityrules.

Operations 7

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/standard-entity-rules/ List organization-wide sensitive data rules · List standard entity rules #
Ask an LLM
“What standard entity rules apply across my whole organization?”
“Which data types are being blocked or redacted by default?”
Tell an agent
List my organization's standard entity rules.
Show page {page} of organization entity rules.
GET /api/v1/security/standard-entity-rules/{entity_type}/ Get an organization sensitive data rule · Get standard entity rule #
Ask an LLM
“How is a particular entity type handled org-wide by default?”
“What inbound and outbound action is set for one entity type at the org level?”
Tell an agent
Get the organization rule for entity type {entity_type}.
Show how {entity_type} is treated by default across my org.
PUT /api/v1/security/standard-entity-rules/{entity_type}/ Change an organization sensitive data rule · Update standard entity rule #
Ask an LLM
“How do I make the org redact a type of data coming in?”
“Can I switch an organization entity rule from log to block?”
Tell an agent
Set org rule {entity_type} to active {is_active}, inbound {inbound_action}, outbound {outbound_action}.
Across the organization, apply {inbound_action} inbound and {outbound_action} outbound to {entity_type}, active {is_active}.
GET /api/v1/tool-packs/{tool_pack_id}/standard-entity-rules/ List a tool pack's sensitive data rules · List standard entity rules (Tool Pack) #
Ask an LLM
“Which entity rules are in effect for one tool pack, including inherited defaults?”
“Can I see only the overrides defined on a tool pack?”
Tell an agent
List the entity rules for tool pack {tool_pack_id}.
Show entity rules on tool pack {tool_pack_id} defined at {defined_at}.
GET /api/v1/tool-packs/{tool_pack_id}/standard-entity-rules/{entity_type}/ Get a tool pack's rule for one entity type · Get standard entity rule (Tool Pack) #
Ask an LLM
“How does a specific tool pack treat a given sensitive entity type?”
“Does my tool pack override the org rule for a given data type?”
Tell an agent
Get tool pack {tool_pack_id}'s rule for {entity_type}.
Check whether tool pack {tool_pack_id} overrides {entity_type}.
PUT /api/v1/tool-packs/{tool_pack_id}/standard-entity-rules/{entity_type}/ Override a sensitive data rule for a tool pack · Create or update standard entity rule override (Tool Pack) #
Ask an LLM
“How do I give one tool pack a stricter rule than the organization default?”
“Can I create an entity rule override for a single tool pack?”
Tell an agent
Override {entity_type} on tool pack {tool_pack_id}: active {is_active}, inbound {inbound_action}, outbound {outbound_action}.
For tool pack {tool_pack_id} only, handle {entity_type} with {inbound_action} inbound and {outbound_action} outbound, active {is_active}.
DELETE /api/v1/tool-packs/{tool_pack_id}/standard-entity-rules/{entity_type}/ Remove a tool pack's sensitive data override · Delete standard entity rule override (Tool Pack) #
Ask an LLM
“How do I revert a tool pack to the organization's default entity rule?”
“Can I delete an entity rule override from a tool pack?”
Tell an agent destructive · confirm first
Delete the {entity_type} override on tool pack {tool_pack_id}.
Revert tool pack {tool_pack_id} to org defaults for {entity_type}.

Documentation

Specifications

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/json-schema/hris-api-employee-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/json-structure/hris-api-employee-structure.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/json-schema/ats-api-candidate-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/json-schema/ats-api-application-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/json-structure/ats-api-candidate-structure.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/json-schema/accounting-api-invoice-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/json-structure/accounting-api-invoice-structure.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/json-schema/ticketing-api-ticket-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/json-structure/ticketing-api-ticket-structure.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/json-schema/crm-api-opportunity-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/json-structure/crm-api-opportunity-structure.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/json-schema/file-storage-api-file-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/json-structure/file-storage-api-file-structure.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/json-schema/knowledge-base-api-article-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/json-structure/knowledge-base-api-article-structure.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/json-schema/chat-api-message-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/json-structure/chat-api-message-structure.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/json-schema/agent-handler-tool-pack-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/json-structure/agent-handler-tool-pack-structure.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/json-schema/gateway-response-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/json-structure/gateway-response-structure.json

Other Resources

🔗
Website
https://www.merge.dev/categories/hr-payroll-api
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/json-ld/merge-hris-api-context.jsonld
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/examples/hris-api-employee-example.json
🔗
Website
https://www.merge.dev/categories/ats-recruiting-api
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/json-ld/merge-ats-api-context.jsonld
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/examples/ats-api-candidate-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/examples/ats-api-application-example.json
🔗
Website
https://www.merge.dev/categories/accounting-api
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/json-ld/merge-accounting-api-context.jsonld
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/examples/accounting-api-invoice-example.json
🔗
Website
https://www.merge.dev/categories/ticketing-api
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/json-ld/merge-ticketing-api-context.jsonld
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/examples/ticketing-api-ticket-example.json
🔗
Website
https://www.merge.dev/categories/crm-api
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/json-ld/merge-crm-api-context.jsonld
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/examples/crm-api-opportunity-example.json
🔗
Website
https://www.merge.dev/categories/file-storage-api
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/json-ld/merge-file-storage-api-context.jsonld
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/examples/file-storage-api-file-example.json
🔗
Website
https://www.merge.dev/categories/knowledge-base
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/json-ld/merge-knowledge-base-api-context.jsonld
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/examples/knowledge-base-api-article-example.json
🔗
Website
https://www.merge.dev/categories/chat
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/json-ld/merge-chat-api-context.jsonld
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/examples/chat-api-message-example.json
🔗
Website
https://www.merge.dev/merge-agent-handler
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/json-ld/merge-agent-handler-context.jsonld
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/examples/agent-handler-tool-pack-example.json
🔗
Support
https://help.ah.merge.dev/
🔗
Website
https://www.merge.dev/gateway
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/json-ld/merge-gateway-context.jsonld
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/examples/gateway-response-example.json

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-standardentityrules-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

merge-subpackage-standardentityrules-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Agent Handler Subpackage Standard Entity Rules API
  version: 1.0.0
servers:
- url: https://ah-api.merge.dev
tags:
- name: subpackage_standardEntityRules
paths:
  /api/v1/security/standard-entity-rules/:
    get:
      operationId: list-standard-entity-rules
      summary: List standard entity rules
      description: Returns all standard entity rules for the organization.
      tags:
      - subpackage_standardEntityRules
      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/PaginatedStandardEntityRuleResponseList'
  /api/v1/security/standard-entity-rules/{entity_type}/:
    get:
      operationId: get-standard-entity-rule
      summary: Get standard entity rule
      description: Retrieve a single standard entity rule by entity type.
      tags:
      - subpackage_standardEntityRules
      parameters:
      - name: entity_type
        in: path
        required: true
        schema:
          type: string
      - 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/StandardEntityRuleResponse'
    put:
      operationId: update-standard-entity-rule
      summary: Update standard entity rule
      description: Update a standard entity rule. All writable fields (is_active, inbound_action, outbound_action) are required.
      tags:
      - subpackage_standardEntityRules
      parameters:
      - name: entity_type
        in: path
        required: true
        schema:
          type: string
      - 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/StandardEntityRuleResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StandardEntityRulePutInput'
  /api/v1/tool-packs/{tool_pack_id}/standard-entity-rules/:
    get:
      operationId: list-standard-entity-rules-tool-pack
      summary: List standard entity rules (Tool Pack)
      description: Returns standard entity rules for a tool pack, including organization defaults. Tool-pack-level rules take precedence where both exist.
      tags:
      - subpackage_standardEntityRules
      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/PaginatedPublicCombinedSecurityRuleList'
  /api/v1/tool-packs/{tool_pack_id}/standard-entity-rules/{entity_type}/:
    get:
      operationId: get-standard-entity-rule-tool-pack
      summary: Get standard entity rule (Tool Pack)
      description: Retrieve a single standard entity rule for a tool pack by entity type.
      tags:
      - subpackage_standardEntityRules
      parameters:
      - name: entity_type
        in: path
        required: true
        schema:
          type: string
      - 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/PublicCombinedSecurityRule'
    put:
      operationId: upsert-standard-entity-rule-override-tool-pack
      summary: Create or update standard entity rule override (Tool Pack)
      description: Create or update a standard entity rule override for a tool pack. All fields required.
      tags:
      - subpackage_standardEntityRules
      parameters:
      - name: entity_type
        in: path
        required: true
        schema:
          type: string
      - 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/PublicCombinedSecurityRule'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StandardEntityOverridePutInput'
    delete:
      operationId: delete-standard-entity-rule-override-tool-pack
      summary: Delete standard entity rule override (Tool Pack)
      description: Delete a standard entity rule override, reverting to organization defaults.
      tags:
      - subpackage_standardEntityRules
      parameters:
      - name: entity_type
        in: path
        required: true
        schema:
          type: string
      - 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
components:
  schemas:
    PublicCombinedSecurityRule:
      type: object
      properties:
        entity_type:
          type: string
        region:
          type: string
        description:
          type: string
        detection_method:
          type: string
        is_active:
          type: boolean
        outbound_action:
          type: string
        defined_at:
          type: string
        org_is_active:
          type: boolean
        org_outbound_action:
          type: string
      required:
      - entity_type
      - description
      - detection_method
      - is_active
      - outbound_action
      - defined_at
      description: Standard entity rule with effective configuration for a tool pack.
      title: PublicCombinedSecurityRule
    StandardEntityRuleResponseOutboundAction:
      type: string
      enum:
      - BLOCK
      - REDACT
      - LOG
      - NONE
      description: '* `BLOCK` - BLOCK

        * `REDACT` - REDACT

        * `LOG` - LOG

        * `NONE` - NONE'
      title: StandardEntityRuleResponseOutboundAction
    PaginatedPublicCombinedSecurityRuleList:
      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/PublicCombinedSecurityRule'
      required:
      - count
      - results
      title: PaginatedPublicCombinedSecurityRuleList
    StandardEntityRulePutInputInboundAction:
      type: string
      enum:
      - BLOCK
      - REDACT
      - LOG
      - NONE
      description: '* `BLOCK` - BLOCK

        * `REDACT` - REDACT

        * `LOG` - LOG

        * `NONE` - NONE'
      title: StandardEntityRulePutInputInboundAction
    PaginatedStandardEntityRuleResponseList:
      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/StandardEntityRuleResponse'
      required:
      - count
      - results
      title: PaginatedStandardEntityRuleResponseList
    StandardEntityRulePutInput:
      type: object
      properties:
        is_active:
          type: boolean
        inbound_action:
          $ref: '#/components/schemas/StandardEntityRulePutInputInboundAction'
          description: '* `BLOCK` - BLOCK

            * `REDACT` - REDACT

            * `LOG` - LOG

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

            * `REDACT` - REDACT

            * `LOG` - LOG

            * `NONE` - NONE'
      required:
      - is_active
      - inbound_action
      - outbound_action
      description: Input serializer for PUT /standard-entity-rules/<entity_type>/. All fields required.
      title: StandardEntityRulePutInput
    StandardEntityOverridePutInput:
      type: object
      properties:
        is_active:
          type: boolean
        inbound_action:
          $ref: '#/components/schemas/StandardEntityOverridePutInputInboundAction'
          description: '* `BLOCK` - BLOCK

            * `REDACT` - REDACT

            * `LOG` - LOG

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

            * `REDACT` - REDACT

            * `LOG` - LOG

            * `NONE` - NONE'
      required:
      - is_active
      - inbound_action
      - outbound_action
      description: Input serializer for PUT /tool-packs/<id>/standard-entity-rules/<entity_type>/.
      title: StandardEntityOverridePutInput
    StandardEntityOverridePutInputInboundAction:
      type: string
      enum:
      - BLOCK
      - REDACT
      - LOG
      - NONE
      description: '* `BLOCK` - BLOCK

        * `REDACT` - REDACT

        * `LOG` - LOG

        * `NONE` - NONE'
      title: StandardEntityOverridePutInputInboundAction
    StandardEntityRuleResponse:
      type: object
      properties:
        entity_type:
          type: string
        region:
          type: string
        description:
          type: string
        detection_method:
          type: string
        is_active:
          type: boolean
        outbound_action:
          oneOf:
          - $ref: '#/components/schemas/StandardEntityRuleResponseOutboundAction'
          - type: 'null'
          description: '* `BLOCK` - BLOCK

            * `REDACT` - REDACT

            * `LOG` - LOG

            * `NONE` - NONE'
        defined_at:
          type: string
      required:
      - entity_type
      - region
      - description
      - detection_method
      - is_active
      - outbound_action
      - defined_at
      description: Standard entity rule for an organization.
      title: StandardEntityRuleResponse
    StandardEntityRulePutInputOutboundAction:
      type: string
      enum:
      - BLOCK
      - REDACT
      - LOG
      - NONE
      description: '* `BLOCK` - BLOCK

        * `REDACT` - REDACT

        * `LOG` - LOG

        * `NONE` - NONE'
      title: StandardEntityRulePutInputOutboundAction
    StandardEntityOverridePutInputOutboundAction:
      type: string
      enum:
      - BLOCK
      - REDACT
      - LOG
      - NONE
      description: '* `BLOCK` - BLOCK

        * `REDACT` - REDACT

        * `LOG` - LOG

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