Skip to content

Search K

Main Navigation App

Appearance

Sidebar Navigation

Get started with AI Security

Get started with AI Guardrails

Get started with AI Red Team

Get started with self-hosting

AI Security Platform

Manage users and roles

Permissions, roles, and tokens

Create a provider

SaaS outbound IP addresses

Create a project

Streaming support

OpenAI compatibility

AI Guardrails

Prompts and scans in AI Security

Add response scans

View token usage

Agentic fingerprints

Turn on PII detection

Guardrail PII - France

Guardrail PII - Japanese

Guardrail PII - Korean

Guardrail PII - Spain

Guardrail PII - Saudi Arabia

Guardrail PII - United Arab Emirates

AI Guardrails at the API

Send a prompt to a specific provider

Send a prompt to a specific project

Send a guardrail request to a specific project

Scan streaming

Remove a guardrail from a project

Create a custom guardrail

Work with guardrail versions

Get prompt logs

Get audit logs

Understand prompt history logs

AI Red Team

Manage campaigns

Review a report

Run the all attacks campaign

Manage refusal phrases

Explain the refusal catalog

Attack packs by month

AI Remediate

Remediate AI risks

Remediate findings end to end

Self-hosted deployments

Deploy on Red Hat OpenShift

Deploy on Google Cloud Platform

Install with Helm

Integrations

Anthropic SDK

Anthropic Claude Code CLI

Google Gemini SDK

Google Gemini CLI

OpenAI SDK

OpenAI Codex CLI

Common issues

No token provided

Invalid token

Insufficient permissions

About the API

About the AI Security API

First steps with AI Security API

Error handling

API reference

Welcome

Anthropic

POST Post

Admin

POST Create org settings backup.

POST Import org settings.

Agent-Sessions

GET Get

GET Get

Audit

GET Get audit events.

GET Get event.

Auth

GET Get roles.

POST Create role.

GET Get the default role.

GET Get role.

DELETE Delete role.

PATCH Update role.

DELETE Remove permissions.

PATCH Add permissions.

Branding

GET Get branding.

PATCH Update branding.

GET Get favicon.

POST Upload favicon.

DELETE Reset favicon.

GET Get logo.

POST Upload logo.

DELETE Reset logo.

Campaign-Runs

GET Get campaign runs.

POST Run campaign.

GET Get campaign run.

DELETE Delete a campaign run.

PATCH Update campaign run.

GET Get

PATCH Patch

GET Get campaign run results.

POST Post

Campaign-Schedules

GET Get campaign schedules.

POST Run campaigns on a schedule.

GET Get scheduled campaign run.

DELETE Delete a campaign run schedule.

PATCH Update a scheduled campaign run.

Campaigns

GET Get campaigns.

POST Create campaign.

GET Get campaign.

DELETE Delete a campaign.

PATCH Update campaign.

Chats

GET Get chats.

POST Create chat.

GET Get chat by access ID.

GET Get chat.

DELETE Delete chat.

PATCH Update chat.

Datasets

GET Get

POST Post

GET Get

GET Get

GET Get

GET Get

Files

POST Upload a file.

GET Get a file's metadata by the file ID.

Generations

POST Post

License

GET Get license status.

PATCH Update license.

Org

GET Get organization.

POST Create organization.

PATCH Update organization.

GET Get org preferences.

PATCH Update org preferences.

Project

GET Get default project.

Projects

GET Get projects.

POST Create project.

GET Get project by ID or name.

DELETE Delete project.

PATCH Update project.

POST Add users to project.

DELETE Remove user from project.

PATCH Update project user.

POST Add provider to project.

DELETE Remove provider from project.

POST Add scanner_package to project.

DELETE Remove guardrail package from project.

GET Get project guardrails.

POST Add guardrail to project.

DELETE Remove guardrail from project.

Prompts

GET Get prompts.

POST Send prompt.

GET Get prompt templates.

POST Create prompt template.

GET Get prompt template.

DELETE Delete a prompt template.

PATCH Update prompt template.

GET Get prompt.

PATCH Update prompt.

Providers

GET Get providers.

POST Create provider.

GET Get available system providers.

GET Get system provider.

POST Test provider.

GET Get provider.

DELETE Delete provider.

PATCH Update provider.

PATCH Update provider availability.

Refusal-Catalogs

POST Set refusal catalog.

GET Get the latest refusal catalog.

GET Get refusal catalog by id.

Scanner-Packages

GET Get guardrail packages.

POST Create guardrail package.

GET Get guardrail package.

DELETE Delete guardrail package.

PATCH Update guardrail package.

PATCH Update guardrail package availability.

Scanners

GET Get guardrails.

POST Create guardrail.

POST Export the given guardrails and guardrail packages in a zip file.

POST Import guardrails.

GET Get guardrail.

DELETE Delete guardrail.

PATCH Update guardrail.

PATCH Update guardrail availability.

GET Get metadata for all existing versions of a guardrail.

PATCH Update a guardrail version.

Scans

GET Get scans.

POST Scan data.

POST Process a raw request/response body from a third party API and inject the result in the returned body.

GET Get scan.

PATCH Update scan preservation.

Secrets

GET Get secrets.

POST Create secret.

GET Get secret.

DELETE Delete secret.

PATCH Update secret.

Tokens

GET Get API tokens.

POST Create API token.

POST Bulk delete API tokens.

DELETE Delete API token.

Users

GET Get users.

POST Create user.

GET Get authenticated user.

POST Set user's password.

GET Get user.

DELETE Delete user.

PATCH Update user.

DELETE Reset multi-factor authentication.

POST Assign role to user.

DELETE Retract role from user.

POST Re-sends users verification email.

POST Generate verification token.

Google

POST Google gemini generateContent API gateway.

Openai

POST Chat Completions.

POST Chat Completions.

POST OpenAI responses API gateway.

POST OpenAI responses API gateway.

References

Available roles

Glossary

Release notes

SaaS

Oct 14, 2026 - SaaS - v10.139.2

Sep 30, 2026 - SaaS - v10.122.0

Sep 10, 2026 - SaaS - v10.110.0.2

Aug 26, 2026 - SaaS - v10.98.4

Aug 19, 2026 - SaaS - v10.96.2

July 28, 2026 - SaaS - v10.81.3

July 9, 2026 - SaaS - v10.63.0

June 17, 2026 - SaaS - v10.42.6

May 21, 2026 - SaaS - v10.31.0

Apr 16, 2026 - SaaS - v10.10.4

Mar 30, 2026 - SaaS - v9.164.4

Mar 3, 2026 - SaaS - v9.164.4

Feb 18, 2026 - SaaS - v9.159.5

Jan 29, 2026 - SaaS - v9.133.3.3

On premises

Oct 8, 2026 - OnPrem - v10.122.0.7

Sept 23, 2026 - OnPrem - v10.110.0.3

Sept 8, 2026 - OnPrem - v10.102.0.7

July 21, 2026 - OnPrem - v10.63.0.3

July 13, 2026 - OnPrem - v10.42.6.4

May 1, 2026 - OnPrem - v10.13.2.1

CAI deployment application

Aug 21, 2026 - CAI deployment application - v3.6.0

Operator

Oct 8, 2026 - Operator - Helm 1.11.0 / Catalog 0.15.0

Aug 26, 2026 - Operator - Helm 1.8.0 / Catalog 0.12.0

Glossary

Update the AI Security license

Terms of use

Get favicon.

GET

/backend/v1/branding/favicon

Return the favicon as raw bytes.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Responses

Successful Response

Content-Type

image/png

JSON

"string"

GET

/backend/v1/branding/favicon

Playground

Server

Authorization

HTTPBearer

Samples

Powered by VitePress OpenAPI

Updated at:

© 2026 F5, Inc. All Rights Reserved Privacy notice