Ana içeriğe geç

AI Prompt-Guard Presets API

Endpoints

Authentication

All endpoints require authentication using a Personal API Access Token.

Permissions

  • Admin Only - All endpoints require admin privileges (sysAdmin user or a user with the ADMIN role). Presets are a platform-level catalog; a project-scoped AI_DEVELOPMENT token is not sufficient.

Project-Scoped Surface

Besides the admin/global endpoints above (/apiops/settings/ai-prompt-guard-presets/...), the same prompt-guard preset family is also exposed under a project-scoped path, so a project's own AI_DEVELOPMENT token can read the effective preset catalog and manage its own custom presets without needing platform ADMIN privileges:

GET /apiops/projects/{projectName}/ai-prompt-guard-presets/
GET /apiops/projects/{projectName}/ai-prompt-guard-presets/{presetName}/
POST /apiops/projects/{projectName}/ai-prompt-guard-presets/{presetName}/
PUT /apiops/projects/{projectName}/ai-prompt-guard-presets/{presetName}/
DELETE /apiops/projects/{projectName}/ai-prompt-guard-presets/{presetName}/

Same 5-endpoint shape, request/response bodies and field surface as the admin endpoints documented on this page — only the base path, scope resolution and permission differ:

Admin surface (/apiops/settings/...)Project surface (/apiops/projects/{projectName}/...)
Scope resolutionOptional ?projectId= query parameter (default admin/global scope){projectName} path segment, resolved to the caller's own project — never a query parameter
PermissionSystem admin (sysAdmin user or ADMIN role)AI_DEVELOPMENT + VIEW (read) / MANAGE (write) in the project
Read visibilityPresets in the resolved scope onlyUnion of built-in presets ∪ admin-shared custom presets ∪ this project's own custom presets
Write visibilityAny non-built-in preset in the resolved scopeOnly presets this project owns. A name that only resolves to a built-in or admin-shared preset is treated as not existing for this project: POST creates a new project-owned preset (and fails on the name collision), while PUT/DELETE report the preset as not found
Built-in presetsRead-onlyRead-only

The admin ?projectId= surface is unchanged by this addition and stays fully backward compatible; its permission requirement is not widened.