Preview an organization allowlist policy's blast radius

POST /api/v1/organizations/{id}/policies/preview
Bearer auth

Returns the projects whose effective allowlist would become empty if the given organization allowlist policy is saved, so an admin is warned before tightening a tool or model allowlist to a disjoint set. Non-allowlist or disabled policies have no blast radius.

Path parameters

  • id string Required

    Organization ID

application/json

Body Required

Proposed org policy

  • enabled boolean

    Whether the proposed policy would be enforced. Defaults to true when omitted, matching policy creation.

  • string_list array[string]
  • type string

    Values are MAX_TOOL_CALLS_PER_EXECUTION, MAX_LLM_CALLS_PER_EXECUTION, MAX_EXECUTION_DURATION_MS, MAX_TOKENS_PER_EXECUTION, MAX_TOKENS_PER_SESSION, AUTHORIZED_TOOLS, or AUTHORIZED_MODELS.

Responses

  • 406

    Unsupported or malformed API version, an operation unavailable in the selected published contract, or an unacceptable representation (including unsupported media-type parameters or excluded SSE). Existing authentication, authorization, and rate-limit failures take precedence.

    Hide response attributes Show response attributes object
    • badRequestDetail object

      Optional validation details defined by the standard error schema; API negotiation errors do not emit this field.

      Hide badRequestDetail attribute Show badRequestDetail attribute object
      • fields array[object]

        Fields with validation failures.

        Hide fields attributes Show fields attributes object

        A field and its validation failure.

        • description string Required

          Human-readable validation failure.

        • field string Required

          Name or path of the invalid request field.

    • detail string Required

      Human-readable error details.

    • error integer Required

      HTTP status code.

    • errorCode string Required

      Machine-readable error code.

    • parameters array[string]

      Request parameter names associated with the error; omitted when none apply.

    • reason string Required

      HTTP status reason phrase.

    Hide response attributes Show response attributes object
    • badRequestDetail object

      Optional validation details defined by the standard error schema; API negotiation errors do not emit this field.

      Hide badRequestDetail attribute Show badRequestDetail attribute object
      • fields array[object]

        Fields with validation failures.

        Hide fields attributes Show fields attributes object

        A field and its validation failure.

        • description string Required

          Human-readable validation failure.

        • field string Required

          Name or path of the invalid request field.

    • detail string Required

      Human-readable error details.

    • error integer Required

      HTTP status code.

    • errorCode string Required

      Machine-readable error code.

    • parameters array[string]

      Request parameter names associated with the error; omitted when none apply.

    • reason string Required

      HTTP status reason phrase.
  • 200

    OK

    Hide response attribute Show response attribute object
    • affected_projects array[object]
      Hide affected_projects attributes Show affected_projects attributes object
      • current_allowlist array[string]
      • project_id string
      • project_name string
    Hide response attribute Show response attribute object
    • affected_projects array[object]
      Hide affected_projects attributes Show affected_projects attributes object
      • current_allowlist array[string]
      • project_id string
      • project_name string
  • 400

    Bad Request

    Hide response attributes Show response attributes object
    • code string
    • error string
    • success boolean
    Hide response attributes Show response attributes object
    • code string
    • error string
    • success boolean
  • 403

    Forbidden

    Hide response attributes Show response attributes object
    • code string
    • error string
    • success boolean
    Hide response attributes Show response attributes object
    • code string
    • error string
    • success boolean
  • 500

    Internal Server Error

    Hide response attributes Show response attributes object
    • code string
    • error string
    • success boolean
    Hide response attributes Show response attributes object
    • code string
    • error string
    • success boolean
POST /api/v1/organizations/{id}/policies/preview 
curl \
 --request POST 'https://agentengine.mongodb.com/api/v1/organizations/{id}/policies/preview' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{
  "enabled": true,
  "string_list": [
    "string"
  ],
  "type": "MAX_TOOL_CALLS_PER_EXECUTION"
}'
Request examples 
{
  "enabled": true,
  "string_list": [
    "string"
  ],
  "type": "MAX_TOOL_CALLS_PER_EXECUTION"
}
Response examples (406) 
{
  "detail": "This operation is not available in API version 2026-09-20-preview.",
  "error": 406,
  "errorCode": "OPERATION_NOT_IN_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
{
  "detail": "This operation supports text/event-stream, which the Accept header excludes. Remove unsupported media-type parameters or accept this type with a positive q value.",
  "error": 406,
  "errorCode": "UNACCEPTABLE_MEDIA_TYPE",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
{
  "detail": "The requested API version is not supported. Supported versions: 2026-09-20-preview.",
  "error": 406,
  "errorCode": "UNSUPPORTED_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
Response examples (406) 
{
  "detail": "This operation is not available in API version 2026-09-20-preview.",
  "error": 406,
  "errorCode": "OPERATION_NOT_IN_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
Response examples (200) 
{
  "affected_projects": [
    {
      "current_allowlist": [
        "string"
      ],
      "project_id": "string",
      "project_name": "string"
    }
  ]
}
Response examples (200) 
{
  "affected_projects": [
    {
      "current_allowlist": [
        "string"
      ],
      "project_id": "string",
      "project_name": "string"
    }
  ]
}
Response examples (400) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Response examples (400) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Response examples (403) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Response examples (403) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Response examples (500) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Response examples (500) 
{
  "code": "string",
  "error": "string",
  "success": true
}