Get Guardrail

GET

https://api-gateway.merge.dev/v1/guardrails/:project_id

GET

/v1/guardrails/:project_id

curl https://api-gateway.merge.dev/v1/guardrails/project_id \
     -H "Authorization: Bearer <token>"

{
  "controls": {
    "effective": {
      "allowed_regions": [
        "NA"
      ],
      "allowed_vendors": [
        "anthropic",
        "bedrock"
      ],
      "ignored_regions": [],
      "ignored_vendors": [],
      "vendor_routing_preference": [
        "bedrock"
      ],
      "zero_data_retention": true
    },
    "override": {
      "regions": {
        "allowed_regions": [
          "NA"
        ],
        "ignored_regions": []
      },
      "vendors": {
        "allowed_vendors": [
          "anthropic",
          "bedrock"
        ],
        "ignored_vendors": [],
        "vendor_routing_preference": [
          "bedrock"
        ]
      },
      "zero_data_retention": true
    },
    "scope": "project",
    "scope_id": "8b6f2d4a-1c3e-4b5a-9f7d-2e0c6a8b4d91",
    "sources": {
      "regions": "project",
      "vendors": "project",
      "zero_data_retention": "project"
    }
  },
  "dlp_settings": {
    "entities": [
      {
        "category": "global",
        "entity_type": "EMAIL_ADDRESS",
        "is_seeded": true,
        "overridden": true,
        "display_name": "EMAIL_ADDRESS",
        "effective_action": "block",
        "org_action": "redact"
      },
      {
        "category": "global",
        "entity_type": "DATE_TIME",
        "is_seeded": true,
        "overridden": true,
        "display_name": "DATE_TIME",
        "effective_action": null,
        "org_action": "log"
      },
      {
        "category": "global",
        "entity_type": "CREDIT_CARD",
        "is_seeded": true,
        "overridden": false,
        "display_name": "CREDIT_CARD",
        "effective_action": "redact",
        "org_action": "redact"
      }
    ],
    "override": {
      "DATE_TIME": {
        "enabled": false
      },
      "EMAIL_ADDRESS": {
        "action": "block",
        "enabled": true
      }
    }
  },
  "pi_settings": {
    "effective": {
      "pi_allowlist_patterns": [
        "(?i)ignore the previous ticket"
      ],
      "pi_block_threshold": 0.7,
      "pi_fail_closed": false,
      "pi_indirect_mode": "alert",
      "pi_input_action": "block",
      "pi_log_full_text_on_block": false,
      "pi_mode": "alert",
      "pi_output_action": "redact",
      "pi_pass_threshold": 0.3,
      "pi_safer_vendor_route": null,
      "pi_tier2a_block_threshold": 0.6,
      "pi_tier2b_block_threshold": 0.45
    },
    "inherited_fields": [
      "pi_indirect_mode",
      "pi_input_action",
      "pi_output_action",
      "pi_pass_threshold",
      "pi_tier2a_block_threshold",
      "pi_tier2b_block_threshold",
      "pi_fail_closed",
      "pi_log_full_text_on_block",
      "pi_allowlist_patterns",
      "pi_safer_vendor_route"
    ],
    "override": {
      "pi_block_threshold": 0.7,
      "pi_mode": "alert"
    }
  },
  "project_id": "8b6f2d4a-1c3e-4b5a-9f7d-2e0c6a8b4d91",
  "project_name": "support-bot"
}

Get one project’s guardrails.

Needs view_security_rules or manage_security_rules, and view_org_settings or manage_org_settings.

Authentication

AuthorizationBearer

A management key (mgmt_...), sent as Authorization: Bearer <key>. Reading /v1/routing-policies also accepts the organization’s gateway API keys; writing there needs a management key.

Path parameters

project_idstringRequiredformat: "uuid"

The project’s id.

Response

The project's guardrails

controlsobject

The project’s vendor, region and zero-data-retention controls.

dlp_settingsobject

The project's DLP settings.

pi_settingsobject

The project's prompt injection settings.

project_idstringRead-onlyformat: "uuid"

The project's id.

project_namestring

The project's name.

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error