Skip to content

Search K

Main Navigation App More information

Appearance

Sidebar Navigation

Get started

Deploy to the Cloud

About the AI Security API

Prompts and scans in AI Security

Permissions, roles, and tokens in AI Security

First steps with AI Security API

Getting started with AI Guardrails

Getting started with AI Red Team

OpenAI compatibility

Using AI Security API

Creating a provider

AI Guardrails

Sending a prompt to a specific provider

Sending a prompt to a specific project

Sending a scan request to a specific project

Removing a scanner from a project

Creating a custom scanner

Working with scanner versions

Getting prompt logs

Getting audit logs

AI Red Team

Running the All Attacks campaign

Managing campaigns

Integrations

OpenAI

Anthropic

Cohere

Groq

Hugging Face

IBM Watson

Onboarding

NAT gateway IP addresses for allowlists

Understand the prompt history logs in AI Security

Troubleshooting

Status and error codes

Error handling

The None response

Common issues

No token provided

Invalid token

Insufficient permissions

API reference

Welcome

Anthropic

POST Post

Admin

POST Create org settings backup.

POST Import org settings.

Agent-Sessions

GET Get

App

GET Get app metrics.

Audit

GET Get audit events.

Auth

GET Get roles.

POST Create 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.

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

Endpoint

GET Get the default endpoint for the group/chatbot specified or global settings if neither is given.

Endpoints

GET Get endpoints matching the given filter criteria.

POST Create a new endpoint.

GET Get endpoint by its ID or name.

PATCH Update endpoint.

GET Get the guardrails and their configuration that will be used when sending prompts to a given endpoint.

Files

POST Upload a file.

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

Generations

POST Post

Groups

GET Get groups matching the given filter criteria.

POST Create group.

GET Get group by its ID.

DELETE Delete group.

PATCH Update group's name.

POST Add users to a group.

DELETE Remove a user from a group. Only a group admin can remove a user from a group.

PATCH Update a user's admin status in a group.

License

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.

Scanner-Packages

GET Get guardrail packages.

POST Create guardrail package.

GET Get guardrail package.

DELETE Delete guardrail package.

PATCH Update guardrail package.

PATCH Update scanner 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.

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.

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.

Release notes

Jan 29, 2026 - SaaS - v9.133.3.3

Feb 18, 2026 - SaaS - v9.159.5

Mar 3, 2026 - SaaS - v9.164.4

Mar 30, 2026 - SaaS - v9.164.4

Apr 16, 2026 - SaaS - v10.10.4

Terms of use

Update license.

PATCH

/backend/v1/license

Update the license for the system.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Request Body

application/json

JSON

"string"

Responses

Successful Response

Content-Type

application/json

JSON

"string"

PATCH

/backend/v1/license

Playground

Server

Authorization

HTTPBearer

Body

Samples

Powered by VitePress OpenAPI

Updated at:

© 2026 F5, Inc. All Rights Reserved