Skip to content

Commit 284140e

Browse files
authored
Merge pull request #1055 from sarette/docs-8876-scan-api-hotfix
Docs 8876 scan api hotfix
2 parents 320d48a + c24f8e1 commit 284140e

2 files changed

Lines changed: 62 additions & 8 deletions

File tree

openapi-specs/prisma-airs/scan/ScanService_Oct2025.yaml

Lines changed: 54 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -385,10 +385,21 @@ components:
385385
description: AI security profile name used for scanning
386386
category:
387387
type: string
388-
description: Category of the scanned content verdicts such as "malicious" or "benign"
388+
description: Category of the scanned content verdicts such as "malicious", "benign", "error" or "timeout"
389389
action:
390390
type: string
391391
description: The action is set to "block" or "allow" based on AI security profile used for scanning
392+
timeout:
393+
type: boolean
394+
description: Indicates whether any detection service timed out during scanning
395+
error:
396+
type: boolean
397+
description: Indicates whether any detection service encountered an error during scanning
398+
errors:
399+
type: array
400+
description: List of detection service errors or timeouts
401+
items:
402+
$ref: "#/components/schemas/ContentErrors"
392403
prompt_detected:
393404
$ref: "#/components/schemas/PromptDetected"
394405
response_detected:
@@ -416,6 +427,48 @@ components:
416427
- scan_id
417428
- category
418429
- action
430+
- timeout
431+
- error
432+
- errors
433+
434+
ContentErrors:
435+
type: object
436+
description: Errors information for prompt and response detection services
437+
properties:
438+
content_type:
439+
$ref: "#/components/schemas/ContentErrorType"
440+
feature:
441+
$ref: "#/components/schemas/DetectionServiceName"
442+
status:
443+
$ref: "#/components/schemas/ErrorStatus"
444+
445+
ContentErrorType:
446+
type: string
447+
description: Type of content that encountered an error
448+
enum:
449+
- prompt
450+
- response
451+
452+
ErrorStatus:
453+
type: string
454+
description: Status indicating error or timeout
455+
enum:
456+
- error
457+
- timeout
458+
459+
DetectionServiceName:
460+
type: string
461+
description: Name of detection service
462+
enum:
463+
- dlp
464+
- injection
465+
- url_cats
466+
- toxic_content
467+
- malicious_code
468+
- agent
469+
- topic_violation
470+
- db_security
471+
- ungrounded
419472

420473
PromptDetected:
421474
type: object

products/prisma-airs/api/airuntimesecurity/airuntimesecurityapi.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
---
22
id: airuntimesecurityapi
3-
title: "Prisma AIRS AI Runtime API Intercept"
4-
sidebar_label: "Prisma AIRS AI Runtime API Intercept"
3+
title: "Prisma AIRS AI Runtime API"
4+
sidebar_label: "Prisma AIRS AI Runtime API"
55
keywords:
66
- AIRS
77
- Reference
88
- Cloud
99
- API
1010
---
1111

12-
**Prisma AIRS AI Runtime API intercept** is a threat detection service designed to secure AI applications. It helps discover and protect applications using REST APIs by embedding Security-as-Code directly into your source code.
12+
**Prisma AIRS AI Runtime API** is a threat detection service designed to secure AI applications. It helps discover and protect applications using REST APIs by embedding Security-as-Code directly into your source code.
1313

1414
The API intercept consists of two main API categories:
1515

@@ -23,7 +23,7 @@ Both scan and management APIs support two authentication types:
2323
- **API key-based**: Use the `x-pan-token` header: `-H 'x-pan-token: <x-pan-token>'`.
2424
- **OAuth 2.0-based token (RBAC)**: Use the `Authorization` header with a bearer token: `-H 'Authorization: Bearer <token>'`.
2525

26-
For licensing, onboarding, activation, and to obtain the API authentication key and profile name, refer to the [Prisma AIRS AI Runtime API intecept](https://docs.paloaltonetworks.com/ai-runtime-security/activation-and-onboarding/ai-runtime-security-api-intercept-overview) administration documentation.
26+
For licensing, onboarding, activation, and to obtain the API authentication key and profile name, refer to the [Prisma AIRS AI Runtime API](https://docs.paloaltonetworks.com/ai-runtime-security/activation-and-onboarding/ai-runtime-security-api-intercept-overview) administration documentation.
2727

2828
## Scan API Endpoints
2929

@@ -32,11 +32,12 @@ The following are the API endpoints based on the regions you selected while crea
3232
- US: https://service.api.aisecurity.paloaltonetworks.com
3333
- EU (Germany): https://service-de.api.aisecurity.paloaltonetworks.com
3434
- IN: https://service-in.api.aisecurity.paloaltonetworks.com
35+
- SG: https://service-sg.api.aisecurity.paloaltonetworks.com
3536

3637
## Prerequisites
3738

3839
1. Create and associate a [deployment profile](https://docs.paloaltonetworks.com/ai-runtime-security/activation-and-onboarding/ai-runtime-security-api-intercept-overview/ai-deployment-profile-airs-api-intercept) for Prisma AIRS AI Runtime API intercept in your Customer Support Portal.
39-
2. [Onboard Prisma AIRS AI Runtime API intercept](https://docs.paloaltonetworks.com/ai-runtime-security/activation-and-onboarding/ai-runtime-security-api-intercept-overview/onboard-api-runtime-security-api-intercept-in-scm) in Strata Cloud Manager.
40+
2. [Onboard Prisma AIRS AI Runtime API](https://docs.paloaltonetworks.com/ai-runtime-security/activation-and-onboarding/ai-runtime-security-api-intercept-overview/onboard-api-runtime-security-api-intercept-in-scm) in Strata Cloud Manager.
4041
3. [Manage applications, API keys, security profiles, and custom topics](https://docs.paloaltonetworks.com/ai-runtime-security/administration/prevent-network-security-threats/airs-apirs-manage-api-keys-profile-apps) in Strata Cloud Manager.
4142

4243
## Requirements for API Usage
@@ -50,7 +51,7 @@ Specify this profile name or the profile ID in the API request payload in the `a
5051
You can manage API keys and AI security profiles in Strata Cloud Manager.
5152

5253
1. Log in to [Strata Cloud Manager](http://stratacloudmanager.paloaltonetworks.com/).
53-
2. Navigate to **Insights > Prisma AIRS > Prisma AIRS AI Runtime: API Intercept**.
54+
2. Navigate to **AI Security > API Applications**.
5455
3. In the top right corner, click:
5556

5657
- **Manage > API Keys** to copy, regenerate, or rotate the API key token.
@@ -66,7 +67,7 @@ For complete details, refer to adminstration guide for the section on how to "ma
6667
- 2 MB maximum payload size per synchronous scan request - Limited to a maximum of 100 URLs per request.
6768
- 5 MB maximum payload size per asynchronous scan request - Limited to a maximum of 100 URLs per request.
6869
- Asynchronous requests are limited to a maximum of 25 batched requests.
69-
- The following limitations apply to contextual grounding:
70+
- The following limitations apply to the contextual grounding detector:
7071

7172
- **Context**: supports a maximum of 100,000 characters
7273
- **Prompt**: supports a maximum of 10,000 characters

0 commit comments

Comments
 (0)