Palo Alto Networks Target API
Operations for managing scan targets (create, update, delete, list).
Operations for managing scan targets (create, update, delete, list).
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/palo-alto-networks-target-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Prisma AIRS Red Teaming Management Target API
description: Red Teaming Management API - Configure and manage security groups and rules for AI/ML model scanning. © 2025 Palo Alto Networks, Inc
version: 0.7.67
termsOfService: https://www.paloaltonetworks.com/content/dam/pan/en_US/assets/pdf/legal/palo-alto-networks-end-user-license-agreement-eula.pdf
license:
name: MIT
url: https://opensource.org/license/mit
contact:
email: support@paloaltonetworks.com
name: Palo Alto Networks Technical Support
url: https://support.paloaltonetworks.com
servers:
- url: https://api.sase.paloaltonetworks.com/ai-red-teaming/mgmt-plane
security:
- bearerAuth: []
tags:
- name: Target
description: Operations for managing scan targets (create, update, delete, list).
paths:
/v1/target:
post:
tags:
- Target
summary: Create target
description: Create a new scan target.
operationId: create_target_v1_target_post
parameters:
- name: validate
in: query
required: false
schema:
type: boolean
description: Whether to validate target configuration
examples:
- true
title: Validate
description: Whether to validate target configuration
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TargetCreateRequestSchema'
responses:
201:
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/TargetResponseSchema'
422:
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
get:
tags:
- Target
summary: List targets
description: List all scan targets with pagination and filtering support.
operationId: list_targets_v1_target_get
parameters:
- name: skip
in: query
required: false
schema:
type: integer
minimum: 0
description: Number of records to skip
default: 0
title: Skip
description: Number of records to skip
- name: limit
in: query
required: false
schema:
type: integer
maximum: 100
minimum: 1
description: Maximum records to return
default: 10
title: Limit
description: Maximum records to return
- name: target_type
in: query
required: false
schema:
anyOf:
- $ref: '#/components/schemas/TargetType'
- type: 'null'
description: Filter by target type
title: Target Type
description: Filter by target type
- name: status
in: query
required: false
schema:
anyOf:
- $ref: '#/components/schemas/TargetStatusFilter'
- type: 'null'
description: Filter by target status or profiling status
title: Status
description: Filter by target status or profiling status
- name: search
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: Search target by name
title: Search
description: Search target by name
- name: adapter_uuid
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
description: Filter targets by the custom adapter they use
title: Adapter Uuid
description: Filter targets by the custom adapter they use
responses:
200:
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/TargetListSchema'
422:
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/target/{target_uuid}:
get:
tags:
- Target
summary: Get target details
description: Retrieve a specific target by UUID with complete configuration details and masked connection parameters.
operationId: get_target_v1_target__target_uuid__get
parameters:
- name: target_uuid
in: path
required: true
schema:
type: string
format: uuid
title: Target Uuid
responses:
200:
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/TargetRedactSchema'
422:
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
put:
tags:
- Target
summary: Update target
description: Update an existing target with new configuration and optional validation control.
operationId: update_target_v1_target__target_uuid__put
parameters:
- name: target_uuid
in: path
required: true
schema:
type: string
format: uuid
title: Target Uuid
- name: validate
in: query
required: false
schema:
type: boolean
description: Whether to validate target configuration
default: true
title: Validate
description: Whether to validate target configuration
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TargetUpdateRequestSchema'
responses:
200:
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/TargetSchema'
422:
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- Target
summary: Delete target
description: Permanently delete a target and its encrypted configuration data.
operationId: delete_target_v1_target__target_uuid__delete
parameters:
- name: target_uuid
in: path
required: true
schema:
type: string
format: uuid
title: Target Uuid
responses:
204:
description: Successful Response
422:
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/target/{target_uuid}/profile:
post:
tags:
- Target
summary: Start target profiling
description: Manually trigger target profiling. Target must be active with industry and use_case.
operationId: start_profiling_v1_target__target_uuid__profile_post
parameters:
- name: target_uuid
in: path
required: true
schema:
type: string
format: uuid
title: Target Uuid
responses:
200:
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/StartProfilingResponseSchema'
422:
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
put:
tags:
- Target
summary: Update target profile
description: Update target background and additional context fields without connection validation.
operationId: update_target_profile_v1_target__target_uuid__profile_put
parameters:
- name: target_uuid
in: path
required: true
schema:
type: string
format: uuid
title: Target Uuid
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TargetContextUpdateSchema'
responses:
200:
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/TargetSchema'
422:
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
get:
tags:
- Target
summary: Get profiling results
description: Get profiling results including merged user and profiler data.
operationId: get_profiling_results_v1_target__target_uuid__profile_get
parameters:
- name: target_uuid
in: path
required: true
schema:
type: string
format: uuid
title: Target Uuid
responses:
200:
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/TargetProfileResponse'
422:
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/target/probe:
post:
tags:
- Target
summary: Run profiling probes on target
description: Send profiling questions to a target using provided connection parameters. Returns TargetResponseSchema with target_background and additional_context populated from probe responses.
operationId: run_target_probes_v1_target_probe_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TargetProbeRequest'
required: true
responses:
200:
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/TargetResponseSchema'
422:
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/target/validate-auth:
post:
tags:
- Target
summary: Validate authentication configuration
description: Validate OAuth2 credentials by fetching a test token. For HEADERS and BASIC_AUTH, validates field presence only.
operationId: validate_auth_v1_target_validate_auth_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TargetAuthValidationRequestSchema'
required: true
responses:
200:
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/TargetAuthValidationResponseSchema'
422:
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/target/ms-copilot-studio/auth-url:
post:
tags:
- Target
summary: Generate Copilot Studio auth URL
description: Generate MS Copilot Studio OAuth authorization URL.
operationId: generate_ms_copilot_studio_auth_url_v1_target_ms_copilot_studio_auth_url_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MSCopilotStudioAuthUrlRequestSchema'
required: true
responses:
200:
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/MSCopilotStudioAuthUrlResponseSchema'
422:
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/target/ms-copilot-studio/token:
post:
tags:
- Target
summary: Exchange Copilot Studio auth code
description: Exchange auth code for tokens via MSAL, store token cache in GSM.
operationId: exchange_ms_copilot_studio_token_v1_target_ms_copilot_studio_token_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MSCopilotStudioTokenRequestSchema'
required: true
responses:
200:
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/MSCopilotStudioTokenResponseSchema'
422:
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/target/ms-copilot-studio/token/{token_json_uuid}:
delete:
tags:
- Target
summary: Delete MS Copilot Studio token records
description: Delete both auth flow and token cache GSM records (cancel cleanup).
operationId: delete_ms_copilot_studio_token_v1_target_ms_copilot_studio_token__token_json_uuid__delete
parameters:
- name: token_json_uuid
in: path
required: true
schema:
type: string
format: uuid
title: Token Json Uuid
responses:
204:
description: Successful Response
422:
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
TargetBackground:
properties:
industry:
anyOf:
- type: string
- type: 'null'
title: Industry
description: Target's industry (e.g., Healthcare, Finance)
use_case:
anyOf:
- type: string
- type: 'null'
title: Use Case
description: Primary use case (e.g., Customer Support, Code Assistant)
competitors:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Competitors
description: Known competitor products
agentic_profiling_enabled:
type: boolean
title: Agentic Profiling Enabled
description: Whether agentic profiling is enabled for this target
default: true
type: object
title: TargetBackground
description: 'Target background - used in create/update API requests and stored in DB/GCS.
Required fields for activation:
- industry (string, required)
- use_case (string, required)
Optional field:
- competitors (list of strings)
'
NativeConnectionParamsBase-Output:
properties:
target_connection_config:
anyOf:
- $ref: '#/components/schemas/OpenAIConnectionParams'
- $ref: '#/components/schemas/HuggingfaceConnectionParams'
- $ref: '#/components/schemas/DatabricksConnectionParams'
- $ref: '#/components/schemas/BedrockAccessConnectionParams'
- $ref: '#/components/schemas/MSCopilotStudioConnectionParams'
- type: 'null'
title: Target Connection Config
description: Provider-specific connection config
multi_turn_config:
anyOf:
- oneOf:
- $ref: '#/components/schemas/MultiTurnStatefulConfig'
- $ref: '#/components/schemas/MultiTurnStatelessConfig'
discriminator:
propertyName: type
mapping:
stateful: '#/components/schemas/MultiTurnStatefulConfig'
stateless: '#/components/schemas/MultiTurnStatelessConfig'
- type: 'null'
title: Multi Turn Config
description: Multi-turn config for stateful or stateless target
multi_turn_supported:
type: boolean
title: Multi Turn Supported
description: Whether a native target that drives multi-turn internally supports it. Currently consumed only by custom target adapters, which have no multi_turn_config to infer it from; gates the multi-turn validation probe.
default: false
type: object
title: NativeConnectionParamsBase
description: 'Base connection parameters for native/SDK-based targets (no HTTP endpoint).
Used for no-code agent platforms like Microsoft Copilot Studio where
interaction is via a provider''s client library, not HTTP REST/streaming.
# TODO: Consider refactoring RestConnectionParamsBase and StreamingConnectionParamsBase
# to share a common base with this class (e.g., extract target_connection_config and
# multi_turn_config into a shared parent).
'
OpenAIConnectionRedactParams:
properties:
api_key:
type: string
format: password
title: Api Key
description: OpenAI API key for authentication
writeOnly: true
examples:
- sk-abxx
model_name:
type: string
title: Model Name
description: OpenAI model name for API requests
examples:
- gpt-4.1-nano
type: object
required:
- api_key
- model_name
title: OpenAIConnectionRedactParams
description: Connection parameters specific to OpenAI targets
OpenAIConnectionParams:
properties:
api_key:
type: string
title: Api Key
description: OpenAI API key for authentication
examples:
- sk-abxx
model_name:
type: string
title: Model Name
description: OpenAI model name for API requests
examples:
- gpt-4.1-nano
type: object
required:
- api_key
- model_name
title: OpenAIConnectionParams
description: Connection parameters specific to OpenAI targets
TargetType:
type: string
enum:
- APPLICATION
- AGENT
- MODEL
title: TargetType
description: Target Types Available
BasicAuthLocation:
type: string
enum:
- HEADER
- PAYLOAD
title: BasicAuthLocation
description: Where Basic Auth credentials are sent.
TargetStatus:
type: string
enum:
- DRAFT
- VALIDATING
- VALIDATED
- ACTIVE
- INACTIVE
- FAILED
- PENDING_AUTH
title: TargetStatus
description: Status enumeration for scan targets.
AiGeneratedItems:
properties:
languages_supported:
anyOf:
- $ref: '#/components/schemas/AiGeneratedLanguageListFieldInfo'
- type: 'null'
tools_accessible:
anyOf:
- $ref: '#/components/schemas/AiGeneratedListFieldInfo'
- type: 'null'
banned_keywords:
anyOf:
- $ref: '#/components/schemas/AiGeneratedListFieldInfo'
- type: 'null'
competitors:
anyOf:
- $ref: '#/components/schemas/AiGeneratedListFieldInfo'
- type: 'null'
base_model:
anyOf:
- $ref: '#/components/schemas/AiGeneratedStringFieldInfo'
- type: 'null'
core_architecture:
anyOf:
- $ref: '#/components/schemas/AiGeneratedStringFieldInfo'
- type: 'null'
system_prompt:
anyOf:
- $ref: '#/components/schemas/AiGeneratedStringFieldInfo'
- type: 'null'
type: object
title: AiGeneratedItems
description: Per-field AI tracking with item-level tags and counts.
WebSocketConnectionParamsBase-Input:
properties:
api_endpoint:
anyOf:
- type: string
- type: 'null'
title: Api Endpoint
description: API endpoint URL
examples:
- https://api.openai.com/v1/responses
request_headers:
additionalProperties: true
type: object
title: Request Headers
description: Request headers
default: {}
examples:
- Authorization: Bearer sk-xxx
Content-Type: application/json
request_json:
additionalProperties: true
type: object
title: Request Json
description: Request JSON
default: {}
examples:
- input:
- content:
- text: '{INPUT}'
type: input_text
role: user
model: gpt-4.1-nano
response_json:
additionalProperties: true
type: object
title: Response Json
description: Response JSON
default: {}
examples:
- content: '{RESPONSE}'
response_key:
type: string
title: Response Key
description: Response key
default: null
examples:
- content
target_connection_config:
anyOf:
- $ref: '#/components/schemas/OpenAIConnectionParams'
- $ref: '#/components/schemas/HuggingfaceConnectionParams'
- $ref: '#/components/schemas/DatabricksConnectionParams'
- $ref: '#/components/schemas/BedrockAccessConnectionParams'
- $ref: '#/components/schemas/MSCopilotStudioConnectionParams'
- type: 'null'
title: Target Connection Config
description: Target Connection config of type openai/huggingface ..
curl:
anyOf:
- type: string
- type: 'null'
title: Curl
description: Generated cURL command ready to use (redacted for security)
examples:
- 'curl "https://api.openai.com/v1/chat/completions" -H "Content-Type: application/json" -H "Authorization: Bearer ***" -d ''{"model":"gpt-4","messages":[{"role":"user","content":"{INPUT}"}]}'''
multi_turn_config:
anyOf:
- oneOf:
- $ref: '#/components/schemas/MultiTurnStatefulConfig'
- $ref: '#/components/schemas/MultiTurnStatelessConfig'
discriminator:
propertyName: type
mapping:
stateful: '#/components/schemas/MultiTurnStatefulConfig'
stateless: '#/components/schemas/MultiTurnStatelessConfig'
- type: 'null'
title: Multi Turn Config
description: Multi turn config for stateful or stateless target
examples:
- 'assistant_role: assistant'
ws_response_timeout:
type: number
title: Ws Response Timeout
description: Timeout in seconds for waiting for a WebSocket response message
default: 110.0
examples:
- 60.0
- 110.0
type: object
title: WebSocketConnectionParamsBase
description: Connection parameters for WebSocket targets.
StreamingConnectionParamsRedactBase:
properties:
api_endpoint:
anyOf:
- type: string
- type: 'null'
title: Api Endpoint
description: API endpoint URL
examples:
- https://api.openai.com/v1/responses
request_headers:
additionalProperties: true
type: object
title: Request Headers
description: Request headers
default: {}
examples:
- Authorization: Bearer sk-xxx
Content-Type: application/json
request_json:
additionalProperties: true
type: object
title: Request Json
description: Request JSON
default: {}
examples:
- input:
- content:
- text: '{INPUT}'
type: input_text
role: user
model: gpt-4.1-nano
response_json:
additionalProperties: true
type: object
title: Response Json
description: Response JSON
default: {}
examples:
- content: '{RESPONSE}'
response_key:
type: string
title: Response Key
description: Response key
default: null
examples:
- content
target_connection_config:
anyOf:
- $ref: '#/components/schemas/OpenAIConnectionRedactParams'
- $ref: '#/components/schemas/HuggingfaceConnectionRedactParams'
- $ref: '#/components/schemas/DatabricksConnectionRedactParams'
- $ref: '#/components/schemas/BedrockAccessConnectionRedactParams'
- $ref: '#/components/schemas/MSCopilotStudioConnectionRedactParams'
- type: 'null'
title: Target Connection Config
description: Target Connection config of type openai/huggingface ..
curl:
anyOf:
- type: string
- type: 'null'
title: Curl
description: Generated cURL command ready to use (redacted for security)
examples:
- 'curl "https://api.openai.com/v1/chat/completions" -H "Content-Type: application/json" -H "Authorization: Bearer ***" -d ''{"model":"gpt-4","messages":[{"role":"user","content":"{INPUT}"}]}'''
multi_turn_config:
anyOf:
- oneOf:
- $ref: '#/components/schemas/MultiTurnStatefulConfig'
- $ref: '#/components/schemas/MultiTurnStatelessConfig'
discriminator:
propertyName: type
mapping:
stateful: '#/components/schemas/MultiTurnStatefulConfig'
stateless: '#/components/schemas/MultiTurnStatelessConfig'
- type: 'null'
title: Multi Turn Config
description: Multi turn config for stateful or stateless target
examples:
- 'assistant_role: assistant'
response_stop_key:
type: string
title: Response Stop Key
response_stop_value:
type: string
title: Response Stop Value
type: object
required:
- response_stop_key
- response_stop_value
title: StreamingConnectionParamsRedactBase
TargetRedactSchema:
properties:
connection_params:
anyOf:
- oneOf:
- $ref: '#/components/schemas/NativeConnectionParamsRedactBase'
- $ref: '#/components/schemas/WebSocketConnectionParamsRedactBase'
- $ref: '#/components/schemas/StreamingConnectionParamsRedactBase'
- $ref: '#/components/schemas/RestConnectionParamsRedactBase'
- type: 'null'
title: Connection Params
description: API connection parameters (sensitive data masked for security)
auth_config:
anyOf:
- $ref: '#/components/schemas/HeadersAuthConfigRedact'
- $ref: '#/components/schemas/BasicAuthAuthConfigRedact'
- $ref: '#/components/schemas/OAuth2AuthConfigRedact'
- type: 'null'
title: Auth Config
description: Authentication configuration (sensitive data masked for security)
network_broker_channel_uuid:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Network Broker Channel Uuid
description: Network broker channel UUID for routing requests. Required when api_endpoint_type is NETWORK_BROKER.
examples:
- 550e8400-e29b-41d4-a716-446655440000
uuid:
type: string
format: uuid
title: Uuid
tsg_id:
type: string
title: Tsg Id
name:
type: string
title: Name
description: Target name
examples:
- GPT 4.1 Nano
description:
anyOf:
- type: string
- type: 'null'
title: Description
description: Optional target description
default: null
examples:
- AI model for testing
target_type:
anyOf:
- $ref: '#/components/schemas/TargetType'
- type: 'null'
description: Type of target
connection_type:
anyOf:
- $ref: '#/components/schemas/TargetConnectionType'
- type: 'null'
description: Connection type/provider for the target
examples:
- CUSTOM
- OPENAI
- BEDROCK
api_endpoint_type:
anyOf:
- $ref: '#/components/schemas/ApiEndpointType'
- type: 'null'
description: Accessibility type of the API endpoint
examples:
- PUBLIC
- PRIVATE
- NETWORK_BROKER
response_mode:
anyOf:
- $ref: '#/components/schemas/ResponseMode'
- type: 'null'
description: Response mode for API interactions
examples:
- REST
- STREAMING
- WEBSOCKET
auth_type:
anyOf:
- $ref: '#/components/schemas/red_team_shared__schemas__auth_config__AuthType'
- type: 'null'
description: Authentication method for target API access
examples:
- HEADERS
- BASIC_AUTH
- OAUTH2
session_supported:
type: boolean
title: Session Supported
description: Whether target supports session for multi-turn conversations
default: false
extra_info:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Extra Info
description: Additional configuration or metadata for the target
default: {}
examples:
- custom_key: custom_value
adapter_uuid:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Adapter Uuid
description: Custom adapter this target uses. Required when connection_type is CUSTOM_TARGET_ADAPTER; must be null for every other connection type.
status:
$ref: '#/components/schemas/TargetStatus'
description: Target status
active:
type: boolean
title: Active
description: Whether target is active
validated:
type: boolean
title: Validated
description: Whether target is validated
version:
anyOf:
- type: integer
- type: 'null'
title: Version
description: Configuration version reference for encrypted config
secret_version:
anyOf:
- type: string
- type: 'null'
title: Secret Version
description: Secret Manager version for connection_params. When present, sensitive connection data is stored in Secret Manager. When None, connection_params are stored in GCS (legacy).
created_by_user_id:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Created By User Id
description: User ID of target creator
updated_by_user_id:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Updated By User Id
description: User ID of last target updater
created_at:
type: string
format: date-time
title: Created At
description: Creation timestamp
updated_at:
type: string
format: date-time
title: Updated At
description: Last update timestamp
profiling_status:
anyOf:
- $ref: '#/components/schemas/ProfilingStatus'
- type: 'null'
description: Status of the profiling workflow
canonical_id:
anyOf:
- type: string
- type: 'null'
title: Canonical Id
description: Partner-supplied stable identifier. Null for targets without partner integration metadata (most targets).
target_metadata:
$ref: '#/components/schemas/TargetMetadata'
description: Target metadata and configuration options
# --- truncated at 32 KB (135 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/openapi/palo-alto-networks-target-api-openapi.yml