Python Management API SDK Inline Usage

This page covers the key use cases of the Prisma AIRS Management API Python SDK with synchronous (inline) methods. It enables you to programmatically manage AI security profiles, API keys, DLP profiles, customer applications, custom topics, OAuth tokens, and deployment profiles.

API Keys Management

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

Create New API Key

Create a new API key for your customer application with specified rotation settings.

Synchronous Example:

from airs_api_mgmt import MgmtClient

# Initialize client
client = MgmtClient()

# Create new API key
response = client.api_keys.create_new_api_key(
    api_key_name="my-application-key",
    cust_app="my-customer-app",
    auth_code="your_auth_code",
    created_by="user@example.com",
    cust_env="production",
    cust_cloud_provider="AWS",
    rotation_time_interval=3,
    rotation_time_unit="months",
    revoked=False,
    dp_name="my-deployment-profile",  # Optional
    cust_ai_agent_framework="langchain"  # Optional
)

print(f"API Key ID: {response}")

Parameters:

api_key_name (str, required): Name of the API key
cust_app (str, required): Customer application identifier
auth_code (str, required): Authorization code
created_by (str, required): Email of user creating the key
cust_env (str, required): Environment (e.g., "production", "staging")
cust_cloud_provider (str, required): Cloud provider (e.g., "AWS", "Azure", "GCP")
rotation_time_interval (int, required): Rotation interval value
rotation_time_unit (str, required): Rotation unit ("days", "months", "years")
revoked (bool, optional): Revocation status (default: False)
dp_name (str, optional): Deployment profile name
cust_ai_agent_framework (str, optional): AI agent framework name

Retrieve API Keys (with pagination)

Retrieve all API keys.

Synchronous Example:

from airs_api_mgmt import MgmtClient

client = MgmtClient()

# Retrieve API keys with pagination
api_keys_response = client.api_keys.get_all_api_keys(offset=0, limit=25)

print(f"API Keys Response: {api_keys_response}")

Parameters:

offset (int, optional): Starting position for pagination (default: 0)
limit (int, optional): Maximum number of keys to retrieve (default: 100)

Regenerate API Key

Regenerate an existing API key with new rotation settings.

Synchronous Example:

from airs_api_mgmt import MgmtClient

client = MgmtClient()

# Regenerate API key
regenerate_response = client.api_keys.regenerate_api_key(
    api_key_id="your_api_key_uuid",
    rotation_time_interval=6,
    rotation_time_unit="months",
    updated_by="user@example.com"
)

print(f"New API Key Secret: {regenerate_response}")

Parameters:

api_key_id (str, required): UUID of the API key to regenerate
rotation_time_interval (int, required): New rotation interval value
rotation_time_unit (str, required): New rotation unit ("days", "months", "years")
updated_by (str, optional): Email of user performing the regeneration

Delete API Key

Delete an API key by its name.

Synchronous Example:

from airs_api_mgmt import MgmtClient

client = MgmtClient()

# Delete API key
delete_response = client.api_keys.delete_api_key(
    api_key_name="my-application-key",
    updated_by="user@example.com"
)

print(f"Deletion response: {delete_response}")

Parameters:

api_key_name (str, required): Name of the API key to delete
updated_by (str, required): Email of user performing the deletion

AI Security Profiles Management

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

Create New AI Security Profile

Create a new AI security profile with comprehensive policy configuration.

Synchronous Example:

from airs_api_mgmt import MgmtClient

client = MgmtClient()

# Define AI security profile policy
policy = {
    "dlp-data-profiles": [],
    "ai-security-profiles": [
        {
            "model-type": "default",
            "model-configuration": {
                "latency": {
                    "inline-timeout-action": "block",
                    "max-inline-latency": 20
                },
                "data-protection": {
                    "data-leak-detection": {
                        "member": [
                            {"text": "Sensitive Content", "id": "", "version": "2"}
                        ],
                        "action": "block"
                    }
                },
                "app-protection": {
                    "default-url-category": {"member": ["malicious"]},
                    "url-detected-action": "allow"
                },
                "model-protection": [
                    {"name": "prompt-injection", "action": "allow"},
                    {"name": "jailbreak", "action": "block"}
                ]
            }
        }
    ]
}

# Create new AI security profile
create_response = client.ai_sec_profiles.create_new_ai_profile(
    profile_name="production-security-profile",
    revision=1,
    policy=policy,
    created_by="user@example.com"
)

print(f"Profile ID: {create_response}")

Parameters:

profile_name (str, required): Name of the AI security profile
revision (int, required): Revision number
policy (dict, required): Policy configuration object
profile_id (str, optional): Custom profile UUID
created_by (str, optional): Email of user creating the profile
updated_by (str, optional): Email of user updating the profile
last_modified_ts (datetime, optional): Last modification timestamp

Retrieve AI Security Profiles (with pagination)

Retrieve all AI security profiles with pagination support.

Synchronous Example:

from airs_api_mgmt import MgmtClient

client = MgmtClient()

# Retrieve AI security profiles
profiles_response = client.ai_sec_profiles.get_all_ai_profiles(offset=0, limit=25)

print(f"AI Security Profiles Response: {profiles_response}")

Parameters:

offset (int, optional): Starting position for pagination (default: 0)
limit (int, optional): Maximum number of profiles to retrieve (default: 100)

Update AI Security Profile

Update an existing AI security profile by its ID.

Synchronous Example:

from airs_api_mgmt import MgmtClient

client = MgmtClient()

# Updated policy
updated_policy = {
    "dlp-data-profiles": [],
    "ai-security-profiles": [
        {
            "model-type": "default",
            "model-configuration": {
                "latency": {
                    "inline-timeout-action": "allow",
                    "max-inline-latency": 30
                }
            }
        }
    ]
}

# Update AI security profile
update_response = client.ai_sec_profiles.update_ai_profile(
    profile_id="your_profile_uuid",
    profile_name="production-security-profile-v2",
    revision=2,
    policy=updated_policy,
    updated_by="user@example.com"
)

print(f"Updated Profile: {update_response}")

Parameters:

profile_id (str, required): UUID of the profile to update
profile_name (str, required): Updated profile name
revision (int, required): New revision number
policy (dict, required): Updated policy configuration
created_by (str, optional): Original creator email
updated_by (str, optional): Email of user updating the profile
last_modified_ts (datetime, optional): Last modification timestamp

Delete AI Security Profile

Delete an AI security profile by its ID.

Synchronous Example:

from airs_api_mgmt import MgmtClient

client = MgmtClient()

# Delete AI security profile
delete_response = client.ai_sec_profiles.delete_ai_profile(
    profile_id="your_profile_uuid"
)

print(f"Deletion response: {delete_response}")

Parameters:

profile_id (str, required): UUID of the profile to delete

Force Delete AI Security Profile

Force delete an AI security profile, bypassing validation checks.

Synchronous Example:

from airs_api_mgmt import MgmtClient

client = MgmtClient()

# Force delete AI security profile
force_delete_response = client.ai_sec_profiles.force_delete_ai_profile(
    profile_id="your_profile_uuid",
    updated_by="user@example.com"
)

print(f"Force deletion response: {force_delete_response}")

Parameters:

profile_id (str, required): UUID of the profile to force delete
updated_by (str, required): Email of user performing the deletion

Custom Topics Management

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

Create New Custom Topic

Create a new custom topic for data classification.

Synchronous Example:

from airs_api_mgmt import MgmtClient

client = MgmtClient()

# Create custom topic
create_response = client.custom_topics.create_new_custom_topic(
    topic_name="financial-data",
    description="Detection of financial and banking information",
    examples=[
        "Credit card numbers",
        "Bank account details",
        "Social security numbers",
        "Tax identification numbers"
    ],
    revision=1,
    created_by="user@example.com"
)

print(f"Topic ID: {create_response}")

Parameters:

topic_name (str, required): Name of the custom topic
description (str, required): Detailed explanation of the topic
examples (list[str], required): List of example usages
revision (int, required): Revision number
topic_id (str, optional): Custom topic UUID
created_by (str, optional): Email of user creating the topic
updated_by (str, optional): Email of user updating the topic
last_modified_ts (datetime, optional): Last modification timestamp
created_ts (datetime, optional): Creation timestamp

Retrieve All Custom Topics (with pagination)

Retrieve all custom topics with pagination support.

Synchronous Example:

from airs_api_mgmt import MgmtClient

client = MgmtClient()

# Retrieve all custom topics
topics_response = client.custom_topics.get_all_custom_topics(
    offset=0,
    limit=50
)

print(f"Custom Topics Response: {topics_response}")

Parameters:

offset (int, optional): Starting position for pagination (default: 0)
limit (int, optional): Maximum number of topics to retrieve (default: 100)

Modify Custom Topic Details

Modify an existing custom topic with updated details.

Synchronous Example:

from airs_api_mgmt import MgmtClient

client = MgmtClient()

# Modify custom topic
modify_response = client.custom_topics.modify_custom_topic_details(
    topic_id="your_topic_uuid",
    topic_name="financial-data-updated",
    description="Updated detection of financial and personal information",
    examples=[
        "Credit card numbers",
        "Bank account details",
        "Social security numbers",
        "Tax identification numbers",
        "IBAN numbers"
    ],
    revision=2,
    updated_by="user@example.com"
)

print(f"Modified Topic: {modify_response}")

Parameters:

topic_id (str, required): UUID of the topic to modify
topic_name (str, required): Updated topic name
description (str, required): Updated description
examples (list[str], required): Updated list of examples
revision (int, required): New revision number
created_by (str, optional): Original creator email
updated_by (str, optional): Email of user modifying the topic
last_modified_ts (datetime, optional): Last modification timestamp
created_ts (datetime, optional): Creation timestamp

Delete Custom Topic

Delete a custom topic by its ID.

Synchronous Example:

from airs_api_mgmt import MgmtClient

client = MgmtClient()

# Delete custom topic
delete_response = client.custom_topics.delete_custom_topic(
    topic_id="your_topic_uuid"
)

print(f"Deletion response: {delete_response}")

Parameters:

topic_id (str, required): UUID of the topic to delete

Force Delete Custom Topic

Force delete a custom topic, bypassing validation checks.

Synchronous Example:

from airs_api_mgmt import MgmtClient

client = MgmtClient()

# Force delete custom topic
force_delete_response = client.custom_topics.force_delete_custom_topic(
    topic_id="your_topic_uuid",
    updated_by="user@example.com"
)

print(f"Force deletion response: {force_delete_response}")

Parameters:

topic_id (str, required): UUID of the topic to force delete
updated_by (str, required): Email of user performing the deletion

Customer Applications Management

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

Retrieve All Customer Applications (with pagination)

Retrieve all customer applications with pagination support.

Synchronous Example:

from airs_api_mgmt import MgmtClient

client = MgmtClient()

# Retrieve all customer applications
apps_response = client.customer_apps.get_all_customer_apps(
    offset=0,
    limit=25
)

print(f"Customer Applications Response: {apps_response}")

Parameters:

offset (int, optional): Starting position for pagination (default: 0)
limit (int, optional): Maximum number of apps to retrieve (default: 100)

Update Customer Application

Update a customer application with new settings.

Synchronous Example:

from airs_api_mgmt import MgmtClient

client = MgmtClient()

# Update customer application
update_response = client.customer_apps.update_customer_app(
    customer_app_id="your_app_uuid",
    app_name="my-updated-application",
    cloud_provider="AWS",
    environment="production",
    model_name="gpt-4",  # Optional
    status="completed",  # Optional
    updated_by="user@example.com",  # Optional
    ai_agent_framework="langchain"  # Optional
)

print(f"Updated App: {update_response}")

Parameters:

customer_app_id (str, required): UUID of the customer application
app_name (str, required): Updated application name
cloud_provider (str, required): Cloud provider ("AWS", "Azure", "GCP")
environment (str, required): Environment ("production", "staging", "development")
model_name (str, optional): AI model name
status (str, optional): Application status ("completed", "pending")
updated_by (str, optional): Email of user updating the app
ai_agent_framework (str, optional): AI agent framework name

Delete Customer Application

Delete a customer application by its name.

Synchronous Example:

from airs_api_mgmt import MgmtClient

client = MgmtClient()

# Delete customer application
delete_response = client.customer_apps.delete_customer_app(
    app_name="my-application",
    updated_by="user@example.com"
)

print(f"Deletion response: {delete_response}")

Parameters:

app_name (str, required): Name of the application to delete
updated_by (str, required): Email of user performing the deletion

DLP Profiles Management

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

Retrieve All DLP Profiles

Retrieve all DLP (Data Loss Prevention) profiles.

Synchronous Example:

from airs_api_mgmt import MgmtClient

client = MgmtClient()

# Retrieve all DLP profiles
dlp_profiles = client.dlp_profiles.get_all_dlp_profiles()

print(f"DLP Profiles: {dlp_profiles}")

Parameters: None

Deployment Profiles Management

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

Retrieve All Deployment Profiles

Retrieve all deployment profiles.

Synchronous Example:

from airs_api_mgmt import MgmtClient

client = MgmtClient()

# Retrieve all deployment profiles
deployment_profiles = client.deployment_profiles.get_all_deployment_profiles()

print(f"Deployment Profiles: {deployment_profiles}")

Parameters:

unactivated (bool, optional): Get only unactivated deployment profiles (default: None)

Retrieve Unactivated Deployment Profiles

Retrieve only unactivated deployment profiles (includes available and previously activated profiles without associated apps or API keys).

Synchronous Example:

from airs_api_mgmt import MgmtClient

client = MgmtClient()

# Retrieve only unactivated deployment profiles
unactivated_profiles = client.deployment_profiles.get_all_deployment_profiles(
    unactivated=True
)

print(f"Unactivated Deployment Profiles: {unactivated_profiles}")

Parameters:

unactivated (bool, required): Set to True to retrieve only unactivated profiles

OAuth Token Management

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

Generate OAuth2 Token

Generate an OAuth2 access token for an Apigee application.

Synchronous Example:

from airs_api_mgmt import MgmtClient

client = MgmtClient()

# Generate OAuth2 token for an Apigee application
oauth_response = client.oauth.get_oauth_token(
    client_id="your_apigee_client_id",
    customer_app="my-customer-app",
    token_ttl_interval=24,
    token_ttl_unit="hours"
)

print(f"OAuth Token: {oauth_response}")

Parameters:

client_id (str, required): Client ID for the OAuth application
customer_app (str, required): Customer application name
token_ttl_interval (int, required): Time-to-live interval for the token
token_ttl_unit (str, required): Time unit ("seconds", "minutes", "hours", "days")

API Keys Management​

Create New API Key​

Retrieve API Keys (with pagination)​

Regenerate API Key​

Delete API Key​

AI Security Profiles Management​

Create New AI Security Profile​

Retrieve AI Security Profiles (with pagination)​

Update AI Security Profile​

Delete AI Security Profile​

Force Delete AI Security Profile​

Custom Topics Management​

Create New Custom Topic​

Retrieve All Custom Topics (with pagination)​

Modify Custom Topic Details​

Delete Custom Topic​

Force Delete Custom Topic​

Customer Applications Management​

Retrieve All Customer Applications (with pagination)​

Update Customer Application​

Delete Customer Application​

DLP Profiles Management​

Retrieve All DLP Profiles​

Deployment Profiles Management​

Retrieve All Deployment Profiles​

Retrieve Unactivated Deployment Profiles​

OAuth Token Management​

Generate OAuth2 Token​

API Keys Management

Create New API Key

Retrieve API Keys (with pagination)

Regenerate API Key

Delete API Key

AI Security Profiles Management

Create New AI Security Profile

Retrieve AI Security Profiles (with pagination)

Update AI Security Profile

Delete AI Security Profile

Force Delete AI Security Profile

Custom Topics Management

Create New Custom Topic

Retrieve All Custom Topics (with pagination)

Modify Custom Topic Details

Delete Custom Topic

Force Delete Custom Topic

Customer Applications Management

Retrieve All Customer Applications (with pagination)

Update Customer Application

Delete Customer Application

DLP Profiles Management

Retrieve All DLP Profiles

Deployment Profiles Management

Retrieve All Deployment Profiles

Retrieve Unactivated Deployment Profiles

OAuth Token Management

Generate OAuth2 Token