Set up App and API Protection for Python on macOS

This product is not supported for your selected Datadog site. ().

Overview

App and API Protection leverages the Datadog Python library to monitor and secure your Python service. The library integrates seamlessly with your existing application without requiring code changes.

For detailed compatibility information, including supported Python versions, frameworks, and deployment environments, see Python Compatibility Requirements.

This guide explains how to set up App and API Protection (AAP) for Python applications. The setup involves:

  1. Installing the Datadog Agent
  2. Enabling App and API Protection monitoring
  3. Running your Python application with the Datadog Agent
  4. Verifying the setup

Prerequisites

  • macOS operating system
  • Python application
  • Homebrew (recommended for Agent installation)
  • Administrator privileges for some configuration steps
  • Your Datadog API key
  • Datadog Python tracing library (see version requirements)

1. Installing the Datadog Agent

Install the Datadog Agent by following the setup instructions for macOS.

2. Enabling App and API Protection monitoring

Automatically enabling App and API Protection through Remote Configuration

You can enable remote configuration on your services dashboard. Simply check the box for the service you want to enable App and API Protection for under "Activate on your APM services".

Manually enabling App and API Protection monitoring

Install the Datadog Python tracing library:

pip install ddtrace

Configure and run your service with Datadog:

Set the required environment variables and start your Python application:

export DD_APPSEC_ENABLED=true
export DD_SERVICE=<YOUR_SERVICE_NAME>
export DD_ENV=<YOUR_ENVIRONMENT>

ddtrace-run python app.py

To disable APM tracing while keeping App and API Protection enabled, you must set the APM tracing variable to false.

Set the required environment variables and start your Python application:

export DD_APPSEC_ENABLED=true
export DD_APM_TRACING_ENABLED=false
export DD_SERVICE=<YOUR_SERVICE_NAME>
export DD_ENV=<YOUR_ENVIRONMENT>

ddtrace-run python app.py

3. Run your application

Start your Python application with the configured settings.

4. Verify setup

To verify that App and API Protection is working correctly:

  1. Send some traffic to your application.
  2. Check for security signals and vulnerabilities in the Application Signals Explorer in Datadog.

Troubleshooting

If you encounter issues while setting up App and API Protection for your Python application, see the Python App and API Protection troubleshooting guide.

Further Reading

Additional helpful documentation, links, and articles:

How App and API Protection WorksDOCUMENTATION more more OOTB App and API Protection RulesDOCUMENTATION more more Troubleshooting App and API ProtectionDOCUMENTATION more more