How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Palo Alto Networks Custom Attack API

Operations for custom attack configurations and prompts.

Palo Alto Networks Custom Attack API is one of 741 APIs that Palo Alto Networks publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include CustomAttack. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 27 operations across 22 paths, and defines 39 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://api.sase.paloaltonetworks.com/ai-red-teaming/data-plane, https://api.sase.paloaltonetworks.com/ai-red-teaming/mgmt-plane.

27 operations 22 paths 39 schemas 1 DELETE18 GET5 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://{firewall}/api/
Authentication
HTTP Bearer
License
Terms of Service
Resource Areas
1

Authentication & Security 1

Palo Alto Networks Custom Attack API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 27

Across 22 paths, the API surfaces 27 operations — 1 DELETE, 18 GET, 5 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

CustomAttack 27

Operations for custom attack configurations and prompts.

GET
/v1/custom-attacks/report/{job_id}
Get custom attack Report
get_custom_attack_report_v1_custom_attacks_report__job_id__get 1 param → 200422
GET
/v1/custom-attacks/report/{job_id}/prompt-sets
Get prompt sets
get_prompt_sets_v1_custom_attacks_report__job_id__prompt_sets_get 5 params → 200422
GET
/v1/custom-attacks/report/{job_id}/prompt-set/{prompt_set_id}/prompts
Get prompts by set
get_prompts_by_set_v1_custom_attacks_report__job_id__prompt_set__prompt_set_id__prompts_get 5 params → 200422
GET
/v1/custom-attacks/report/{job_id}/prompt/{prompt_id}
Get prompt detail
get_prompt_detail_v1_custom_attacks_report__job_id__prompt__prompt_id__get 2 params → 200422
GET
/v1/custom-attacks/job/{job_id}/list-custom-attacks
List custom attacks
list_custom_attacks_v1_custom_attacks_job__job_id__list_custom_attacks_get 7 params → 200422
GET
/v1/custom-attacks/job/{job_id}/attack/{attack_id}/list-outputs
Get attack outputs
get_attack_outputs_v1_custom_attacks_job__job_id__attack__attack_id__list_outputs_get 2 params → 200422
GET
/v1/custom-attacks/job/{job_id}/property-stats
Get property stats
get_property_stats_v1_custom_attacks_job__job_id__property_stats_get 1 param → 200422
POST
/v1/custom-attack/custom-prompt-set
Create a new custom prompt set
create_prompt_set_v1_custom_attack_custom_prompt_set_post body → 201422
GET
/v1/custom-attack/list-custom-prompt-sets
List custom prompt sets
list_prompt_sets_v1_custom_attack_list_custom_prompt_sets_get 7 params → 200422
GET
/v1/custom-attack/custom-prompt-set/{prompt_set_uuid}
Get prompt set details
get_prompt_set_v1_custom_attack_custom_prompt_set__prompt_set_uuid__get 1 param → 200422
PUT
/v1/custom-attack/custom-prompt-set/{prompt_set_uuid}
Update prompt set
update_prompt_set_v1_custom_attack_custom_prompt_set__prompt_set_uuid__put 1 param body → 200422
PUT
/v1/custom-attack/custom-prompt-set/{prompt_set_uuid}/archive
Archive or unarchive a prompt set
archive_prompt_set_v1_custom_attack_custom_prompt_set__prompt_set_uuid__archive_put 1 param body → 200422
POST
/v1/custom-attack/custom-prompt-set/custom-prompt
Create prompt in a prompt set
create_prompt_v1_custom_attack_custom_prompt_set_custom_prompt_post body → 201422
GET
/v1/custom-attack/custom-prompt-set/{prompt_set_uuid}/list-custom-prompts
List prompts in a prompt set
list_prompts_in_set_v1_custom_attack_custom_prompt_set__prompt_set_uuid__list_custom_prompts_get 6 params → 200422
GET
/v1/custom-attack/custom-prompt-set/{prompt_set_uuid}/custom-prompt/{prompt_uuid}
Get prompt details
get_prompt_v1_custom_attack_custom_prompt_set__prompt_set_uuid__custom_prompt__prompt_uuid__get 2 params → 200422
PUT
/v1/custom-attack/custom-prompt-set/{prompt_set_uuid}/custom-prompt/{prompt_uuid}
Update prompt
update_prompt_v1_custom_attack_custom_prompt_set__prompt_set_uuid__custom_prompt__prompt_uuid__put 2 params body → 200422
DELETE
/v1/custom-attack/custom-prompt-set/{prompt_set_uuid}/custom-prompt/{prompt_uuid}
Delete prompt
delete_prompt_v1_custom_attack_custom_prompt_set__prompt_set_uuid__custom_prompt__prompt_uuid__delete 2 params → 204422
GET
/v1/custom-attack/property-names
Get property names
get_property_names_v1_custom_attack_property_names_get → 200401
POST
/v1/custom-attack/property-names
Create property name
create_property_name_v1_custom_attack_property_names_post body → 201422
GET
/v1/custom-attack/property-values/{property_name}
Get property name
get_property_values_v1_custom_attack_property_values__property_name__get 1 param → 200422
POST
/v1/custom-attack/property-values
Create property value
create_property_value_v1_custom_attack_property_values_post body → 200422
GET
/v1/custom-attack/property-values
Get values for multiple property names
get_property_values_multiple_v1_custom_attack_property_values_get 1 param → 200422
POST
/v1/custom-attack/upload-custom-prompts-csv
Upload custom prompts
upload_prompts_csv_v1_custom_attack_upload_custom_prompts_csv_post 1 param body → 201422
GET
/v1/custom-attack/download-template/{prompt_set_uuid}
Download template for a prompt set
download_template_v1_custom_attack_download_template__prompt_set_uuid__get 1 param → 200422
GET
/v1/custom-attack/active-custom-prompt-sets
List active custom prompt sets
list_active_prompt_sets_v1_custom_attack_active_custom_prompt_sets_get → 200401
GET
/v1/custom-attack/custom-prompt-set/{prompt_set_uuid}/reference
Resolve prompt set reference
resolve_prompt_set_reference_v1_custom_attack_custom_prompt_set__prompt_set_uuid__reference_get 1 param → 200422
GET
/v1/custom-attack/custom-prompt-set/{prompt_set_uuid}/version-info
Get prompt set version information
get_prompt_set_version_info_v1_custom_attack_custom_prompt_set__prompt_set_uuid__version_info_get 2 params → 200422

Schemas 39

The contract defines 39 schemas that model the data the API accepts and returns. The most detailed are CustomPromptSetResponseSchema (16 properties), CustomPromptResponseSchema (14 properties), PromptDetailResponse (12 properties), CustomPromptSetListItemSchema (12 properties). Each schema is shown below with its type and property counts.

ValidationError
object
3 properties 3 required
StatusQueryParam
string
PropertyValueStatistic
object
Statistics for a specific property value.
4 properties 4 required
PropertyStatistic
object
Property statistics for prompt sets and job-level aggregation.
2 properties 2 required
PropertyAssignment
object
Property assignment for custom attacks.
2 properties 2 required
PaginationSchema
object
1 property
CustomAttacksListResponse
object
Enhanced list response for custom attacks.
4 properties 4 required
PromptSetsReportResponse
object
Response for prompt sets with filtering.
3 properties 2 required
PromptSetSummary
object
Prompt set summary with statistics.
9 properties 7 required
HTTPValidationError
object
1 property
CustomAttackOutputResponseSchema
object
API response schema — excludes English translation fields.
10 properties 6 required
PromptDetailResponse
object
Detailed prompt response.
12 properties 2 required
CustomAttackReportResponse
object
Main custom attack report response.
8 properties 6 required
CustomPromptResponseSchema
object
Schema for custom prompt responses.
14 properties 8 required
PromptSetStatsSchema
object
Schema for prompt set statistics.
5 properties 3 required
CustomPromptSetListSchema
object
Schema for custom prompt set list responses.
2 properties 1 required
PropertyValueCreateRequestSchema
object
Schema for creating a new property value.
2 properties 2 required
Body_upload_prompts_csv_v1_custom_attack_upload_custom_prompts_csv_post
object
1 property 1 required
CustomPromptSetReferenceSchema
object
Reference schema for custom prompt sets used by data plane. Contains minimal information needed for data plane to fetch configurations from GCS using the GCS-f…
9 properties 7 required
PropertyAssignmentSchema
object
Schema for property name-value assignments.
2 properties 2 required
CustomPromptSetCreateRequestSchema
object
Schema for creating a new custom prompt set.
4 properties 1 required
CustomPromptSetListItemSchema
object
Schema for custom prompt set items in list responses.
12 properties 7 required
CustomPromptCreateRequestSchema
object
Schema for creating a new custom prompt.
4 properties 2 required
CustomPromptSetResponseSchema
object
Schema for custom prompt set responses.
16 properties 7 required
PropertyDefinitionSchema
object
Schema for property definitions in a prompt set.
2 properties 2 required
PropertyValuesMultipleResponseSchema
object
Schema for property values for multiple property names.
1 property
CustomPromptUpdateRequestSchema
object
Schema for updating a custom prompt.
3 properties
CustomPromptSetArchiveRequestSchema
object
Schema for archiving/unarchiving prompt sets.
1 property 1 required
CustomPromptListSchema
object
Schema for custom prompt list responses.
2 properties 1 required
SupportedLanguage
string
BaseResponseSchema
object
Standard response schema for simple operations like create, update, delete.
2 properties 2 required
CustomPromptSetUpdateRequestSchema
object
Schema for updating a custom prompt set.
4 properties
LanguageOptionSchema
object
Language representation with code and display name.
2 properties 2 required
PropertyNamesListResponseSchema
object
Schema for property names list responses.
1 property
PropertyValuesResponseSchema
object
Schema for property values for a specific property name.
2 properties 1 required
PropertyNameCreateRequestSchema
object
Schema for creating a new property name.
1 property 1 required
CustomPromptSetListActiveSchema
object
Schema for listing active custom prompt sets available for use. Used by data plane to discover available prompt sets for job creation.
1 property
CustomPromptListItemSchema
object
Schema for custom prompt items in list responses.
9 properties 7 required
CustomPromptSetVersionInfoSchema
object
Version information for a custom prompt set snapshot. Provides metadata about a specific version without full configuration data.
6 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

palo-alto-networks-customattack-api-openapi.yml Raw ↑

Other APIs Palo Alto Networks publishes across the network.

PAN-OS XML API
PAN-OS OpenConfig API
Panorama API
AutoFocus API (Deprecated)
Prisma SASE Service Status API
Cross-Platform Service Status API
SASE Authentication Service API
Expedition API (Deprecated)
VM-Series Licensing API
Palo Alto Networks 5G Deregistered Trend API
Palo Alto Networks 5G Network Interconnects and Bandwidth API
Palo Alto Networks 5G Registered Trend API
Where this information came from

This is an independent, third-party profile of Palo Alto Networks Custom Attack API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.