Kudu API Reference¶

Quick reference for Kudu (SCM) endpoints used to diagnose and operate Azure App Service apps.

Overview¶

flowchart TD
    A[Kudu API] --> B[Environment]
    A --> C[Processes]
    A --> D[File System]
    A --> E[Deployments]
    A --> F[Command API]

Base URL and Authentication¶

Kudu endpoint format:

https://$APP_NAME.scm.azurewebsites.net

Use deployment credentials (publishing profile/user-level deployment credentials) with Basic authentication.

KUDU_BASE="https://$APP_NAME.scm.azurewebsites.net"
AUTH_USER="<deployment-user>"
AUTH_PASS="<deployment-password>"

Common Endpoints¶

All paths below are relative to $KUDU_BASE/api/.

Process and Environment Queries¶

List processes¶

For Linux custom containers, this shows SCM-container processes, not the main app container process list.

curl -s -u "$AUTH_USER:$AUTH_PASS" \
  "$KUDU_BASE/api/processes"

Inspect a process¶

curl -s -u "$AUTH_USER:$AUTH_PASS" \
  "$KUDU_BASE/api/processes/<pid>"

Dump process¶

curl -s -X POST -u "$AUTH_USER:$AUTH_PASS" \
  "$KUDU_BASE/api/processes/<pid>/dump"

Read environment¶

curl -s -u "$AUTH_USER:$AUTH_PASS" \
  "$KUDU_BASE/api/environment"

File System and Logs¶

Browse persistent storage¶

For Linux custom containers, treat this as SCM/shared storage inspection, not a full view into the app container filesystem.

curl -s -u "$AUTH_USER:$AUTH_PASS" \
  "$KUDU_BASE/api/vfs/home/"

Browse logs¶

curl -s -u "$AUTH_USER:$AUTH_PASS" \
  "$KUDU_BASE/api/vfs/LogFiles/"

Download log file¶

curl -L -u "$AUTH_USER:$AUTH_PASS" \
  "$KUDU_BASE/api/vfs/LogFiles/application/app.log" \
  --output app.log

Deployment Diagnostics¶

List deployments¶

curl -s -u "$AUTH_USER:$AUTH_PASS" \
  "$KUDU_BASE/api/deployments"

Latest deployment¶

curl -s -u "$AUTH_USER:$AUTH_PASS" \
  "$KUDU_BASE/api/deployments/latest"

Deployment logs¶

curl -s -u "$AUTH_USER:$AUTH_PASS" \
  "$KUDU_BASE/api/deployments/<deployment-id>/log"

Command API¶

Run command in app root¶

curl -s -u "$AUTH_USER:$AUTH_PASS" \
  -H "Content-Type: application/json" \
  -d '{"command":"ls -la","dir":"/home/site/wwwroot"}' \
  "$KUDU_BASE/api/command"

Frequently Used Paths¶

Run It in the Portal¶

Portal view: Web App Overview blade (Kudu entry point in left nav)¶

Use this Overview blade to confirm the app identity before switching to the Kudu endpoints in this reference. The visible Default domain shows the app hostname, so the matching SCM hostname for this app is app-test-20251107.scm.azurewebsites.net, and the Properties tab confirms this is a Linux Python - 3.11 code app on asp-test-20251107 (P0v3: 1). The left nav also shows the collapsed Development Tools area associated with Kudu-based diagnostics, and the Deployment Center Last deployment field is a quick portal cross-check when you compare portal state with deployment-history API results. Use this blade as the confirmation point for app, plan, OS, and deployment state before moving into SCM-specific investigation.

See Also¶

• Troubleshooting Reference
• CLI Cheatsheet

Sources¶

• Kudu in Azure App Service (Microsoft Learn)
• App Service Diagnostics Overview (Microsoft Learn)

Language-Specific Details¶

Kudu endpoint usage is platform-level and shared across stacks. For runtime-specific checks (for example, stack-specific startup artifacts), see:

• Azure App Service Node.js Guide — Reference
• Azure App Service Python Guide — Reference