Prisma AIRS AI Runtime API Intercept

https://pan.dev/prisma-airs/api/airuntimesecurity
Admin
Prisma AIRS AI Runtime API Intercept provides an Open API specification for managing and interacting...
Tokens:125,194
Snippets:315
Trust Score:8.7
Update:7 months ago
Show doc for...
Tokens:
Raw
### API Request Examples for Sync Scan

Source: https://pan.dev/prisma-airs/api/airuntimesecurity/scan/scan-sync-request

Examples of how to make a synchronous scan request to the Prisma AIRS API using various programming languages. These examples demonstrate the required authentication and request body structure.

```curl
curl -L 'https://service.api.aisecurity.paloaltonetworks.com/v1/scan/sync/request' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'x-pan-token: <x-pan-token>' \
-d '{ \
  "tr_id": "string", \
  "session_id": "string", \
  "ai_profile": { \
    "profile_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", \
    "profile_name": "string" \
  }, \
  "metadata": { \
    "app_name": "string", \
    "app_user": "string", \
    "ai_model": "string", \
    "user_ip": "string", \
    "agent_meta": { \
      "agent_id": "string", \
      "agent_version": "string", \
      "agent_arn": "string" \
    } \
  }, \
  "contents": [ \
    { \
      "prompt": "string", \
      "response": "string", \
      "code_prompt": "string", \
      "code_response": "string", \
      "context": "string", \
      "tool_event": { \
        "metadata": { \
          "ecosystem": "mcp", \
          "method": "tools/list", \
          "server_name": "Internal MCP server", \
          "tool_invoked": "get_file" \
        }, \
        "input": "{\"file_key\":\"abc123\"}", \
        "output": "{\"content\":[{\"type\":\"text\",\"text\":\"Fetched file\"}]}" \
      } \
    } \
  ] \
}'
```

```python
# Python example would go here, demonstrating the same request structure.
```

```go
// Go example would go here, demonstrating the same request structure.
```

```nodejs
// Node.js example would go here, demonstrating the same request structure.
```

```csharp
// C# example would go here, demonstrating the same request structure.
```

```php
// PHP example would go here, demonstrating the same request structure.
```

--------------------------------

### Retrieve Customer Applications (Node.js)

Source: https://pan.dev/prisma-airs/api/airuntimesecurity/management/get-all-customer-apps-by-tsg-id

Node.js example using the 'axios' library to make a GET request for customer applications. It shows how to configure headers and process the response.

```javascript
const axios = require('axios');

const url = 'https://api.sase.paloaltonetworks.com/aisec/v1/mgmt/customerapp/tsg/:tsg_id';
const token = '<token>';

axios.get(url, {
  headers: {
    'Accept': 'application/json',
    'Authorization': `Bearer ${token}`
  }
})
.then(response => {
  console.log(response.data);
})
.catch(error => {
  console.error('Error fetching customer applications:', error.response ? error.response.data : error.message);
});
```

--------------------------------

### Retrieve All DLP Profiles - Go Example

Source: https://pan.dev/prisma-airs/api/airuntimesecurity/management/get-all-dlp-profiles-by-tsg-id

Example of how to retrieve all DLP profiles using Go. This code snippet demonstrates making an HTTP GET request to the API endpoint with appropriate headers for authentication and content type.

```go
// Go example for retrieving DLP profiles would go here.
// This would typically involve using the 'net/http' package.
// req, err := http.NewRequest("GET", "https://api.sase.paloaltonetworks.com/aisec/v1/mgmt/dlpprofiles", nil)
// if err != nil {
//     // handle error
// }
// req.Header.Set("Accept", "application/json")
// req.Header.Set("Authorization", "Bearer <token>")
// client := &http.Client{}
// resp, err := client.Do(req)
// if err != nil {
//     // handle error
// }
// defer resp.Body.Close()
// // process response body
```

--------------------------------

### CURL Request Example for Scan Reports

Source: https://pan.dev/prisma-airs/api/airuntimesecurity/scan/get-threat-scan-reports

Demonstrates how to make a request to the '/v1/scan/reports' endpoint using cURL. It includes setting the 'Accept' header and the 'x-pan-token' for authentication.

```curl
curl -L 'https://service.api.aisecurity.paloaltonetworks.com/v1/scan/reports' \
-H 'Accept: application/json' \
-H 'x-pan-token: <x-pan-token>'
```

--------------------------------

### Create API Key Request Example

Source: https://pan.dev/prisma-airs/api/airuntimesecurity/management/create-new-api-key

Example of a POST request to create a new API key. This includes the endpoint URL, required headers, and a sample JSON request body with all possible parameters.

```json
{
  "dp_name": "string",
  "auth_code": "string",
  "cust_app": "string",
  "cust_env": "string",
  "cust_cloud_provider": "string",
  "cust_ai_agent_framework": "string",
  "revoked": true,
  "created_by": "string",
  "api_key_name": "string",
  "rotation_time_interval": 0,
  "rotation_time_unit": "string"
}
```

--------------------------------

### Get OAuth 2.0 Token (Go)

Source: https://pan.dev/prisma-airs/api/airuntimesecurity/management/get-apigee-oauth-token

Go program to fetch an OAuth 2.0 access token. This code snippet demonstrates how to make an HTTP POST request to the SASE API endpoint using the `net/http` package. It sets the necessary headers and constructs the JSON request body containing client credentials. The response is then printed.

```go
package main

import (
	"bytes"
	"encoding/json"
	"fmt"
	"net/http"
)

func main() {
	url := "https://api.sase.paloaltonetworks.com/aisec/v1/mgmt/oauth/client_credential/accesstoken"

	requestBody, err := json.Marshal(map[string]string{
		"client_id": "string",
		"customer_app": "string",
	})
	if err != nil {
		fmt.Println(err)
		return
	}

	req, err := http.NewRequest("POST", url, bytes.NewBuffer(requestBody))
	if err != nil {
		fmt.Println(err)
		return
	}

	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("Accept", "application/json")
	rereq.Header.Set("Authorization", "Bearer <token>")

	client := &http.Client{}
	res, err := client.Do(req)
	if err != nil {
		fmt.Println(err)
		return
	}
	defer res.Body.Close()

	var result map[string]interface{}
	if err := json.NewDecoder(res.Body).Decode(&result); err != nil {
		fmt.Println(err)
		return
	}

	fmt.Printf("%+v\n", result)
}
```

--------------------------------

### Retrieve All DLP Profiles - C# Example

Source: https://pan.dev/prisma-airs/api/airuntimesecurity/management/get-all-dlp-profiles-by-tsg-id

Example of how to retrieve all DLP profiles using C#. This code snippet demonstrates using 'HttpClient' to send a GET request to the API endpoint with the necessary authorization header.

```csharp
// C# example for retrieving DLP profiles would go here.
// This would typically involve using System.Net.Http.HttpClient.
// using (var client = new HttpClient())
// {
//     client.DefaultRequestHeaders.Add("Accept", "application/json");
//     client.DefaultRequestHeaders.Add("Authorization", "Bearer <token>");
//     var response = await client.GetAsync("https://api.sase.paloaltonetworks.com/aisec/v1/mgmt/dlpprofiles");
//     response.EnsureSuccessStatusCode();
//     var responseBody = await response.Content.ReadAsStringAsync();
//     // Process responseBody
// }
```

--------------------------------

### Retrieve All DLP Profiles - PHP Example

Source: https://pan.dev/prisma-airs/api/airuntimesecurity/management/get-all-dlp-profiles-by-tsg-id

Example of how to retrieve all DLP profiles using PHP. This code snippet illustrates making an HTTP GET request using cURL or file_get_contents, including setting the authorization header.

```php
// PHP example for retrieving DLP profiles would go here.
// This would typically involve using cURL.
// $token = '<token>';
// $url = 'https://api.sase.paloaltonetworks.com/aisec/v1/mgmt/dlpprofiles';
// $headers = [
//     'Accept: application/json',
//     'Authorization: Bearer ' . $token
// ];
// $ch = curl_init();
// curl_setopt($ch, CURLOPT_URL, $url);
// curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
// curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
// $response = curl_exec($ch);
// if (curl_errno($ch)) {
//     echo 'Error:' . curl_error($ch);
// }
// curl_close($ch);
// echo $response;
```

--------------------------------

### Create Custom Topic

Source: https://pan.dev/prisma-airs/api/airuntimesecurity/management/custom-topic

Creates a new custom topic by posting its details.

```APIDOC
## POST /custom-topics

### Description
Posts a new Custom Topic.

### Method
POST

### Endpoint
/custom-topics

### Parameters
#### Request Body
- **name** (string) - Required - The name of the custom topic.
- **description** (string) - Optional - A description for the custom topic.

### Request Example
```json
{
  "name": "Example Topic",
  "description": "This is a sample custom topic."
}
```

### Response
#### Success Response (201)
- **id** (string) - The unique identifier of the created custom topic.
- **name** (string) - The name of the custom topic.
- **description** (string) - The description of the custom topic.

#### Response Example
```json
{
  "id": "topic-12345",
  "name": "Example Topic",
  "description": "This is a sample custom topic."
}
```
```

--------------------------------

### Retrieve Customer Application Details (Node.js)

Source: https://pan.dev/prisma-airs/api/airuntimesecurity/management/get-customer-app

This Node.js example demonstrates fetching customer application details using the 'axios' library. It sets up the request with the correct URL, headers, and query parameters for the API call.

```javascript
const axios = require('axios');

const url = 'https://api.sase.paloaltonetworks.com/aisec/v1/mgmt/customerapp';
const token = '<token>';
const appName = 'your_app_name';

axios.get(url, {
  headers: {
    'Accept': 'application/json',
    'Authorization': `Bearer ${token}`
  },
  params: {
    'app_name': appName
  }
})
.then(response => {
  console.log(response.data);
})
.catch(error => {
  console.error('Error fetching data:', error.response ? error.response.data : error.message);
});
```

--------------------------------

### Retrieve All DLP Profiles - Python Example

Source: https://pan.dev/prisma-airs/api/airuntimesecurity/management/get-all-dlp-profiles-by-tsg-id

Example of how to retrieve all DLP profiles using Python. This code snippet utilizes the 'requests' library to make a GET request to the API endpoint, including the required authorization token.

```python
# Python example for retrieving DLP profiles would go here.
# This would typically involve using the 'requests' library.
# import requests
# headers = {
#     'Accept': 'application/json',
#     'Authorization': 'Bearer <token>'
# }
# response = requests.get('https://api.sase.paloaltonetworks.com/aisec/v1/mgmt/dlpprofiles', headers=headers)
# print(response.json())
```

--------------------------------

### Create Air Runtime Security Profile (curl)

Source: https://pan.dev/prisma-airs/api/airuntimesecurity/management/create-new-ai-profile

Example of creating an Air Runtime Security profile using curl. This command sends a POST request to the Prisma SASE API endpoint for profile management, including authorization with a Bearer token and a JSON payload defining the profile configuration.

```curl
curl -L -X POST 'https://pan.dev/v1/mgmt/profile' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <token>'
```

--------------------------------

### Retrieve All DLP Profiles - Node.js Example

Source: https://pan.dev/prisma-airs/api/airuntimesecurity/management/get-all-dlp-profiles-by-tsg-id

Example of how to retrieve all DLP profiles using Node.js. This code snippet shows how to make an HTTP GET request using a library like 'axios' or the built-in 'https' module, including authorization headers.

```javascript
// Node.js example for retrieving DLP profiles would go here.
// This would typically involve using 'axios' or the 'https' module.
// const axios = require('axios');
// const token = '<token>';
// axios.get('https://api.sase.paloaltonetworks.com/aisec/v1/mgmt/dlpprofiles', {
//   headers: {
//     'Accept': 'application/json',
//     'Authorization': `Bearer ${token}`
//   }
// })
// .then(response => {
//   console.log(response.data);
// })
// .catch(error => {
//   console.error(error);
// });
```

--------------------------------

### Update Custom Topic Details - Node.js Example

Source: https://pan.dev/prisma-airs/api/airuntimesecurity/management/update-topic-by-topic-id

This Node.js example demonstrates how to update custom topic metadata using the `axios` library. It defines the API endpoint, headers including the Bearer token, and the JSON body. This code snippet is suitable for use in a Node.js environment and requires `axios` to be installed.

```nodejs
const axios = require('axios');

const url = 'https://api.sase.paloaltonetworks.com/aisec/v1/mgmt/topic/uuid/:topic_id';
const token = '<token>'; // Replace with your actual token

const data = {
  "topic_id": "string",
  "topic_name": "string",
  "revision": 0,
  "active": true,
  "description": "string",
  "examples": [
    "string"
  ],
  "created_by": "string",
  "updated_by": "string",
  "last_modified_ts": "2024-07-29T15:51:28.071Z",
  "created_ts": "2024-07-29T15:51:28.071Z"
};

axios.put(url, data, {
  headers: {
    'Content-Type': 'application/json',
    'Accept': 'application/json',
    'Authorization': `Bearer ${token}`
  }
})
  .then(response => {
    console.log('Status Code:', response.status);
    console.log('Response Data:', response.data);
  })
  .catch(error => {
    console.error('Error updating topic:', error.response ? error.response.data : error.message);
  });
```

--------------------------------

### Custom Topics

Source: https://pan.dev/prisma-airs/api/airuntimesecurity/prismaairsmanagementapi

Endpoints for creating and managing custom threat detection topics to tailor security monitoring to specific needs.

```APIDOC
## Custom Topics Endpoints

This category includes endpoints for managing custom topics.

### POST /api/v1/custom-topics

#### Description
Creates a new custom topic.

### GET /api/v1/custom-topics

#### Description
Retrieves a list of custom topics.

### GET /api/v1/custom-topics/{topic_id}

#### Description
Retrieves details for a specific custom topic.

### PUT /api/v1/custom-topics/{topic_id}

#### Description
Updates an existing custom topic.

### DELETE /api/v1/custom-topics/{topic_id}

#### Description
Deletes a specific custom topic.
```

--------------------------------

### Get OAuth 2.0 Token (Node.js)

Source: https://pan.dev/prisma-airs/api/airuntimesecurity/management/get-apigee-oauth-token

Node.js example for obtaining an OAuth 2.0 access token. This code uses the built-in `https` module to make a POST request to the SASE API. It sets the request headers, including authorization, and sends the client credentials in the JSON payload. The response is then processed.

```javascript
const https = require('https');

const options = {
  hostname: 'api.sase.paloaltonetworks.com',
  port: 443,
  path: '/aisec/v1/mgmt/oauth/client_credential/accesstoken',
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Accept': 'application/json',
    'Authorization': 'Bearer <token>'
  }
};

const postData = JSON.stringify({
  client_id: 'string',
  customer_app: 'string'
});

const req = https.request(options, (res) => {
  console.log('statusCode:', res.statusCode);
  console.log('headers:', res.headers);

  let data = '';
  res.on('data', (chunk) => {
    data += chunk;
  });

  res.on('end', () => {
    console.log(JSON.parse(data));
  });
});

req.on('error', (e) => {
  console.error(e);
});

req.write(postData);
req.end();
```

--------------------------------

### Submit Async Scan Request using x-pan-token

Source: https://pan.dev/prisma-airs/api/airuntimesecurity/scan/scan-async-request

This snippet demonstrates how to make an asynchronous scan request to the Prisma AIRS AI Runtime API using the 'x-pan-token' for authentication. It includes examples for various programming languages and shows the required request body format.

```curl
curl -L 'https://service.api.aisecurity.paloaltonetworks.com/v1/scan/async/request' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'x-pan-token: <x-pan-token>' \
-d '[
  {
    "req_id": 0,
    "scan_req": {
      "tr_id": "string",
      "session_id": "string",
      "ai_profile": {
        "profile_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "profile_name": "string"
      },
      "metadata": {
        "app_name": "string",
        "app_user": "string",
        "ai_model": "string",
        "user_ip": "string",
        "agent_meta": {
          "agent_id": "string",
          "agent_version": "string",
          "agent_arn": "string"
        }
      },
      "contents": [
        {
          "prompt": "string",
          "response": "string",
          "code_prompt": "string",
          "code_response": "string",
          "context": "string",
          "tool_event": {
            "metadata": {
              "ecosystem": "mcp",
              "method": "tools/list",
              "server_name": "Internal MCP server",
              "tool_invoked": "get_file"
            },
            "input": "{\"file_key\":\"abc123\"}",
            "output": "{\"content\":[{\"type\":\"text\",\"text\":\"Fetched file\"}] }"
          }
        }
      ]
    }
  }
]'
```

```python
import requests
import json

url = "https://service.api.aisecurity.paloaltonetworks.com/v1/scan/async/request"
headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "x-pan-token": "<x-pan-token>"
}

data = [
  {
    "req_id": 0,
    "scan_req": {
      "tr_id": "string",
      "session_id": "string",
      "ai_profile": {
        "profile_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "profile_name": "string"
      },
      "metadata": {
        "app_name": "string",
        "app_user": "string",
        "ai_model": "string",
        "user_ip": "string",
        "agent_meta": {
          "agent_id": "string",
          "agent_version": "string",
          "agent_arn": "string"
        }
      },
      "contents": [
        {
          "prompt": "string",
          "response": "string",
          "code_prompt": "string",
          "code_response": "string",
          "context": "string",
          "tool_event": {
            "metadata": {
              "ecosystem": "mcp",
              "method": "tools/list",
              "server_name": "Internal MCP server",
              "tool_invoked": "get_file"
            },
            "input": json.dumps({"file_key":"abc123"}),
            "output": json.dumps({"content":[{"type":"text","text":"Fetched file"}]})
          }
        }
      ]
    }
  }
]

response = requests.post(url, headers=headers, data=json.dumps(data))
print(response.json())
```

```go
package main

import (
	"bytes"
	"encoding/json"
	"fmt"
	"net/http"
)

func main() {
	url := "https://service.api.aisecurity.paloaltonetworks.com/v1/scan/async/request"

	requestBody := []map[string]interface{}{
		{
			"req_id": 0,
			"scan_req": map[string]interface{}{
				"tr_id": "string",
				"session_id": "string",
				"ai_profile": map[string]string{
					"profile_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
					"profile_name": "string"
				},
				"metadata": map[string]interface{}{
					"app_name": "string",
					"app_user": "string",
					"ai_model": "string",
					"user_ip": "string",
					"agent_meta": map[string]string{
						"agent_id": "string",
						"agent_version": "string",
						"agent_arn": "string"
					}
				},
				"contents": []map[string]interface{}{
					{
						"prompt": "string",
						"response": "string",
						"code_prompt": "string",
						"code_response": "string",
						"context": "string",
						"tool_event": map[string]interface{}{
							"metadata": map[string]string{
								"ecosystem": "mcp",
								"method": "tools/list",
								"server_name": "Internal MCP server",
								"tool_invoked": "get_file"
							},
							"input": "{\"file_key\":\"abc123\"}",
							"output": "{\"content\":[{\"type\":\"text\",\"text\":\"Fetched file\"}]}"
						}
					}
				}
			}
		}
	}

	requestBodyBytes, err := json.Marshal(requestBody)
	if err != nil {
		fmt.Println("Error marshaling JSON:", err)
		return
	}

	req, err := http.NewRequest("POST", url, bytes.NewBuffer(requestBodyBytes))
	if err != nil {
		fmt.Println("Error creating request:", err)
		return
	}

	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("x-pan-token", "<x-pan-token>")

	client := &http.Client{}
	resp, err := client.Do(req)
	if err != nil {
		fmt.Println("Error sending request:", err)
		return
	}

	defer resp.Body.Close()

	var result map[string]interface{}
	err = json.NewDecoder(resp.Body).Decode(&result)
	if err != nil {
		fmt.Println("Error decoding response:", err)
		return
	}

	fmt.Println(result)
}

```

```nodejs
const axios = require('axios');

const url = 'https://service.api.aisecurity.paloaltonetworks.com/v1/scan/async/request';
const panToken = '<x-pan-token>';

const requestBody = [
  {
    "req_id": 0,
    "scan_req": {
      "tr_id": "string",
      "session_id": "string",
      "ai_profile": {
        "profile_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "profile_name": "string"
      },
      "metadata": {
        "app_name": "string",
        "app_user": "string",
        "ai_model": "string",
        "user_ip": "string",
        "agent_meta": {
          "agent_id": "string",
          "agent_version": "string",
          "agent_arn": "string"
        }
      },
      "contents": [
        {
          "prompt": "string",
          "response": "string",
          "code_prompt": "string",
          "code_response": "string",
          "context": "string",
          "tool_event": {
            "metadata": {
              "ecosystem": "mcp",
              "method": "tools/list",
              "server_name": "Internal MCP server",
              "tool_invoked": "get_file"
            },
            "input": JSON.stringify({"file_key":"abc123"}),
            "output": JSON.stringify({"content":[{"type":"text","text":"Fetched file"}]})
          }
        }
      ]
    }
  }
];

axios.post(url, requestBody, {
  headers: {
    'Content-Type': 'application/json',
    'Accept': 'application/json',
    'x-pan-token': panToken
  }
})
.then(response => {
  console.log(response.data);
})
.catch(error => {
  console.error('Error making request:', error);
});

```

```csharp
using System;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;
using System.Collections.Generic;

public class PrismaAirRequest
{
    public static async Task Main(string[] args)
    {
        var url = "https://service.api.aisecurity.paloaltonetworks.com/v1/scan/async/request";
        var panToken = "<x-pan-token>";

        var requestBody = new List<Dictionary<string, object>>
        {
            new Dictionary<string, object>
            {
                {"req_id", 0},
                {"scan_req", new Dictionary<string, object>
                {
                    {"tr_id", "string"},
                    {"session_id", "string"},
                    {"ai_profile", new Dictionary<string, string>
                    {
                        {"profile_id", "3fa85f64-5717-4562-b3fc-2c963f66afa6"},
                        {"profile_name", "string"}
                    }},
                    {"metadata", new Dictionary<string, object>
                    {
                        {"app_name", "string"},
                        {"app_user", "string"},
                        {"ai_model", "string"},
                        {"user_ip", "string"},
                        {"agent_meta", new Dictionary<string, string>
                        {
                            {"agent_id", "string"},
                            {"agent_version", "string"},
                            {"agent_arn", "string"}
                        }}
                    }},
                    {"contents", new List<Dictionary<string, object>>
                    {
                        new Dictionary<string, object>
                        {
                            {"prompt", "string"},
                            {"response", "string"},
                            {"code_prompt", "string"},
                            {"code_response", "string"},
                            {"context", "string"},
                            {"tool_event", new Dictionary<string, object>
                            {
                                {"metadata", new Dictionary<string, string>
                                {
                                    {"ecosystem", "mcp"},
                                    {"method", "tools/list"},
                                    {"server_name", "Internal MCP server"},
                                    {"tool_invoked", "get_file"}
                                }},
                                {"input", "{\"file_key\":\"abc123\"}"},
                                {"output", "{\"content\":[{\"type\":\"text\",\"text\":\"Fetched file\"}]}"}
                            }}
                        }
                    }}
                }}
            }
        }
        };

        using (var httpClient = new HttpClient())
        {
            httpClient.DefaultRequestHeaders.Add("Content-Type", "application/json");
            httpClient.DefaultRequestHeaders.Add("Accept", "application/json");
            httpClient.DefaultRequestHeaders.Add("x-pan-token", panToken);

            var jsonContent = new StringContent(Newtonsoft.Json.JsonConvert.SerializeObject(requestBody), Encoding.UTF8, "application/json");

            try
            {
                var response = await httpClient.PostAsync(url, jsonContent);
                response.EnsureSuccessStatusCode(); // Throw if HTTP status is not 2xx

                var responseBody = await response.Content.ReadAsStringAsync();
                Console.WriteLine(responseBody);
            }
            catch (HttpRequestException e)
            {
                Console.WriteLine($"Request error: {e.Message}");
            }
        }
    }
}

```

```php
<?php

$url = 'https://service.api.aisecurity.paloaltonetworks.com/v1/scan/async/request';
$panToken = '<x-pan-token>';

$requestBody = [
  [
    "req_id" => 0,
    "scan_req" => [
      "tr_id" => "string",
      "session_id" => "string",
      "ai_profile" => [
        "profile_id" => "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "profile_name" => "string"
      ],
      "metadata" => [
        "app_name" => "string",
        "app_user" => "string",
        "ai_model" => "string",
        "user_ip" => "string",
        "agent_meta" => [
          "agent_id" => "string",
          "agent_version" => "string",
          "agent_arn" => "string"
        ]
      ],
      "contents" => [
        [
          "prompt" => "string",
          "response" => "string",
          "code_prompt" => "string",
          "code_response" => "string",
          "context" => "string",
          "tool_event" => [
            "metadata" => [
              "ecosystem" => "mcp",
              "method" => "tools/list",
              "server_name" => "Internal MCP server",
              "tool_invoked" => "get_file"
            ],
            "input" => json_encode(["file_key"=>"abc123"]),
            "output" => json_encode(["content"=>[["type"=>"text","text"=>"Fetched file"]]])
          ]
        ]
      ]
    ]
  ]
];

$ch = curl_init($url);

curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($requestBody));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Content-Type: application/json',
    'Accept: application/json',
    'x-pan-token: ' . $panToken
]);

$response = curl_exec($ch);

if (curl_errno($ch)) {
    echo 'Curl error: ' . curl_error($ch);
}

curl_close($ch);

echo $response;

?>

```

--------------------------------

### Update Custom Topic Details - Python Example

Source: https://pan.dev/prisma-airs/api/airuntimesecurity/management/update-topic-by-topic-id

This Python snippet shows how to update custom topic metadata using the `requests` library. It constructs the API endpoint URL, sets the appropriate headers including the Bearer token, and defines the JSON payload for the update. This example assumes you have the `requests` library installed.

```python
import requests

url = "https://api.sase.paloaltonetworks.com/aisec/v1/mgmt/topic/uuid/:topic_id"
headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": "Bearer <token>"
}
payload = {
    "topic_id": "string",
    "topic_name": "string",
    "revision": 0,
    "active": True,
    "description": "string",
    "examples": [
        "string"
    ],
    "created_by": "string",
    "updated_by": "string",
    "last_modified_ts": "2024-07-29T15:51:28.071Z",
    "created_ts": "2024-07-29T15:51:28.071Z"
}

response = requests.put(url, headers=headers, json=payload)

print(response.status_code)
print(response.json())
```

--------------------------------

### Retrieve Customer Application Details (Go)

Source: https://pan.dev/prisma-airs/api/airuntimesecurity/management/get-customer-app

This Go code snippet illustrates how to make an API call to retrieve customer application details. It uses the net/http package to create a GET request with appropriate headers and query parameters.

```go
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {
	url := "https://api.sase.paloaltonetworks.com/aisec/v1/mgmt/customerapp?app_name=your_app_name"

	client := &http.Client{}

	req, err := http.NewRequest("GET", url, nil)
	if err != nil {
		fmt.Println("Error creating request:", err)
		return
	}

	req.Header.Add("Accept", "application/json")
	req.Header.Add("Authorization", "Bearer <token>")

	resp, err := client.Do(req)
	if err != nil {
		fmt.Println("Error sending request:", err)
		return
	}

	defer resp.Body.Close()

	body, err := ioutil.ReadAll(resp.Body)
	if err != nil {
		fmt.Println("Error reading response body:", err)
		return
	}

	fmt.Println("Status Code:", resp.StatusCode)
	fmt.Println("Response Body:", string(body))
}
```

--------------------------------

### Get OAuth 2.0 Token (CURL)

Source: https://pan.dev/prisma-airs/api/airuntimesecurity/management/get-apigee-oauth-token

Example of how to retrieve an OAuth 2.0 access token using cURL. This command sends a POST request to the specified API endpoint with JSON content type and includes the client ID and customer application name in the request body. It also demonstrates how to include an Authorization header.

```curl
curl -L 'https://api.sase.paloaltonetworks.com/aisec/v1/mgmt/oauth/client_credential/accesstoken' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <token>' \
-d '{
  "client_id": "string",
  "customer_app": "string"
}'
```

--------------------------------

### Asynchronous Inline Scan with Python SDK

Source: https://pan.dev/prisma-airs/api/airuntimesecurity/pythonsdkusage

Demonstrates an asynchronous scan using the Prisma AIRS Python SDK, allowing for multiple scans to be queued simultaneously. This example shows sending two different prompts for different threat detections. Ensure relevant detections are enabled in the API security profile. Scans may take approximately 10 seconds to complete.

```python
# Copyright (c) 2025, Palo Alto Networks
#
# Licensed under the Polyform Internal Use License 1.0.0 (the "License");
# you may not use this file except in compliance with the License.
#
# You may obtain a copy of the License at:
#
# https://polyformproject.org/licenses/internal-use/1.0.0
# (or)
# https://github.com/polyformproject/polyform-licenses/blob/76a278c4/PolyForm-Internal-Use-1.0.0.md
#
# As far as the law allows, the software comes as is, without any warranty
# or condition, and the licensor will not be liable to you for any damages
# arising out of these terms or the use or nature of the software, under
# any kind of legal claim.

"""
Traditional Python Batch (Asynchronous/Multiple) Scan Example

API Reference: https://pan.dev/prisma-airs/api/scan-async-request/
"""

import os
from pprint import pprint

import aisecurity
from aisecurity.generated_openapi_client.models.ai_profile import AiProfile
from aisecurity.generated_openapi_client.models.async_scan_object import AsyncScanObject
from aisecurity.generated_openapi_client.models.scan_request import ScanRequest
from aisecurity.generated_openapi_client.models.scan_request_contents_inner import (
    ScanRequestContentsInner,
)

# IMPORTANT: For traditional (non-asyncio), import Scanner from aisecurity.scan.inline.scanner
from aisecurity.scan.inline.scanner import Scanner

AI_PROFILE_NAME = "ai-sec-security"
API_KEY = os.getenv("PANW_AI_SEC_API_KEY")

# Initialize the SDK with your API Key
aisecurity.init(api_key=API_KEY)

# Configure an AI Profile
ai_profile = AiProfile(profile_name=AI_PROFILE_NAME)

# Create a Scanner
scanner = Scanner()

req_ids = 0

```

--------------------------------

### Get OAuth 2.0 Token (PHP)

Source: https://pan.dev/prisma-airs/api/airuntimesecurity/management/get-apigee-oauth-token

PHP script to obtain an OAuth 2.0 access token. This example uses cURL functions to send a POST request to the SASE API. It sets the necessary headers, including content type, accept, and authorization, and sends the client credentials in the JSON request body. The response is then outputted.

```php
<?php

$url = 'https://api.sase.paloaltonetworks.com/aisec/v1/mgmt/oauth/client_credential/accesstoken';
$data = json_encode([
    'client_id' => 'string',
    'customer_app' => 'string'
]);

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Content-Type: application/json',
    'Accept: application/json',
    'Authorization: Bearer <token>'
]);

$response = curl_exec($ch);

if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
} else {
    echo $response;
}

curl_close($ch);

?>
```

--------------------------------

### Authentication

Source: https://pan.dev/prisma-airs/api/airuntimesecurity/scan/get-threat-scan-reports

Details on how to authenticate API requests using the x-pan-token header.

```APIDOC
## Authentication

### Authorization Header

- **Name**: `x-pan-token`
- **Type**: `apiKey`
- **Description**: API key token generated during onboarding in Strata Cloud Manager.
- **In**: `header`
```

--------------------------------

### Initialize Airtime Security Scanner (Python)

Source: https://pan.dev/prisma-airs/api/airuntimesecurity/pythonsdkusage

Initializes the aisecurity library and creates an instance of the Scanner class. This is a prerequisite for performing threat scans and retrieving reports. Ensure the aisecurity library is installed.

```python
import aisecurity
from aisecurity.scan.inline.scanner import Scanner

aisecurity.init()

scanner = Scanner()
```

--------------------------------

### Retrieve API Keys by TSG ID (Node.js)

Source: https://pan.dev/prisma-airs/api/airuntimesecurity/management/get-all-api-keys-by-tsg-id

Node.js example using the 'axios' library to make a GET request for API keys. It includes setting the Authorization header and query parameters for pagination.

```javascript
const axios = require('axios');

const url = 'https://api.sase.paloaltonetworks.com/aisec/v1/mgmt/apikeys/tsg/:tsg_id';
const token = '<token>';

axios.get(url, {
  headers: {
    'Accept': 'application/json',
    'Authorization': `Bearer ${token}`
  },
  params: {
    offset: 0, // Replace with your desired offset
    limit: 10  // Replace with your desired limit
  }
})
  .then(response => {
    console.log(response.data);
  })
  .catch(error => {
    console.error(`Error: ${error.response.status}`);
    console.error(error.response.data);
  });
```

--------------------------------

### Retrieve Custom Topics by TSG ID (Node.js)

Source: https://pan.dev/prisma-airs/api/airuntimesecurity/management/get-all-custom-topics-by-tsg-id

Node.js example using the 'axios' library to make a GET request to retrieve custom topics. It includes setting the 'Authorization' and 'Accept' headers. The code demonstrates handling the response and potential errors.

```javascript
const axios = require('axios');

const apiUrl = 'https://api.sase.paloaltonetworks.com/aisec/v1/mgmt/topics/tsg/:tsg_id';
const token = '<token>';

axios.get(apiUrl, {
  headers: {
    'Accept': 'application/json',
    'Authorization': `Bearer ${token}`
  }
})
.then(response => {
  console.log(response.data);
})
.catch(error => {
  console.error(`Error: ${error.response.status} - ${error.response.data}`);
});
```

--------------------------------

### Not Found Response (404)

Source: https://pan.dev/prisma-airs/api/airuntimesecurity/scan/scan-async-request

Returned when the requested resource cannot be found. The response includes an error object with a message specifying that the resource was not found.

```json
{
  "error": {
    "message": "Resource is not found"
  }
}
```

--------------------------------

### Create API Key Request in Go

Source: https://pan.dev/prisma-airs/api/airuntimesecurity/management/create-new-api-key

Go program demonstrating how to create a new API key via a POST request. It utilizes the 'net/http' package to construct and send the request with appropriate headers and JSON body.

```go
package main

import (
	"bytes"
	"encoding/json"
	"fmt"
	"net/http"
)

func main() {
	url := "https://api.sase.paloaltonetworks.com/aisec/v1/mgmt/apikey"

	payload := map[string]interface{}{
		"dp_name":                 "string",
		"auth_code":             "string",
		"cust_app":              "string",
		"cust_env":              "string",
		"cust_cloud_provider":   "string",
		"cust_ai_agent_framework": "string",
		"revoked":               true,
		"created_by":            "string",
		"api_key_name":          "string",
		"rotation_time_interval": 0,
		"rotation_time_unit":    "string",
	}

	jsonPayload, _ := json.Marshal(payload)

	req, err := http.NewRequest("POST", url, bytes.NewBuffer(jsonPayload))
	if err != nil {
		fmt.Println("Error creating request:", err)
		return
	}

	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("Accept", "application/json")
	rereq.Header.Set("Authorization", "Bearer <token>")

	client := &http.Client{}
	resp, err := client.Do(req)
	if err != nil {
		fmt.Println("Error sending request:", err)
		return
	}
defer resp.Body.Close()

	var result map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&result)
	fmt.Println(result)
}
```

--------------------------------

### GET /v1/scan/results

Source: https://pan.dev/prisma-airs/api/airuntimesecurity/usecases

Retrieves the results of an asynchronous scan. This endpoint is used to get the detailed outcome of a scan initiated via the `/v1/scan/async/request` endpoint.

```APIDOC
## GET /v1/scan/results

### Description
Retrieves the results of an asynchronous scan. This endpoint is used to get the detailed outcome of a scan initiated via the `/v1/scan/async/request` endpoint.

### Method
GET

### Endpoint
`/v1/scan/results`

### Parameters
#### Query Parameters
- **scan_id** (string) - Required - The ID of the scan for which to retrieve results.

### Response
#### Success Response (200)
- **req_id** (integer) - Unique identifier for the request within the scan.
- **result** (object) - The detailed result of the scan for the specific request.
  - **action** (string) - The action taken (e.g., 'allow', 'block').
  - **category** (string) - The category assigned (e.g., 'malicious', 'benign').
  - **completed_at** (string) - Timestamp when the scan was completed.
  - **profile_id** (string) - The ID of the AI profile used.
  - **profile_name** (string) - The name of the AI profile used.
  - **prompt_detected** (object) - Details about detected elements in the prompt (empty if none).
  - **report_id** (string) - The ID of the scan report.
  - **response_detected** (object) - Details about detected elements in the response.
    - **ungrounded** (boolean) - Indicates if the response was detected as ungrounded.
  - **scan_id** (string) - The ID of the scan.
  - **tr_id** (string) - The transaction ID.
- **scan_id** (string) - The ID of the scan.
- **status** (string) - The status of the scan for this request (e.g., 'complete').

#### Response Example
```json
[
  {
    "req_id": 2,
    "result": {
      "action": "block",
      "category": "malicious",
      "completed_at": "2025-05-08T12:36:59Z",
      "profile_id": "00000000-0000-0000-0000-000000000000",
      "profile_name": "contextual-grounding-profile",
      "prompt_detected": {},
      "report_id": "R00000000-0000-0000-0000-000000000000",
      "response_detected": {
        "ungrounded": true
      },
      "scan_id": "00000000-0000-0000-0000-000000000000",
      "tr_id": "2082"
    },
    "scan_id": "00000000-0000-0000-0000-000000000000",
    "status": "complete"
  },
  {
    "req_id": 1,
    "result": {
      "action": "allow",
      "category": "benign",
      "completed_at": "2025-05-08T12:36:59Z",
      "profile_id": "00000000-0000-0000-0000-000000000000",
      "profile_name": "contextual-grounding-profile",
      "prompt_detected": {},
      "report_id": "R00000000-0000-0000-0000-000000000000",
      "response_detected": {
        "ungrounded": false
      },
      "scan_id": "00000000-0000-0000-0000-000000000000",
      "tr_id": "2882"
    },
    "scan_id": "00000000-0000-0000-0000-000000000000",
    "status": "complete"
  }
]
```
```
Tokens:
Raw