Diagnostics API Client

Name: Diagnostics API Client API
Brand: Diagnostics API Client
Availability: InStock

★ Only Publicly Available OpenAPI DocumentDeveloper ToolsMonitoring Observabilityoauth222 EndpointsREST

For Agents

Run Azure App Service diagnostic detectors and analyses programmatically — list detector categories, fetch detector responses, and execute on-demand site analysis for a web app or deployment slot.

Connect the Diagnostics API Client to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Diagnostics API Client, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Install Jentic One Beta (Self-Hosted)

Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Diagnostics API Client API.

List diagnostic categories available for an Azure App Service site

Retrieve detector responses for a hosting environment to investigate platform issues

Fetch site analysis results for a specific diagnostic category and time range

Execute a named site analysis on demand against a running App Service app

GET STARTED

Start building with Diagnostics API Client API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI document for Diagnostics API Client, keeping it validated and agent-ready.

Jentic publishes the only available OpenAPI specification for Diagnostics API Client, keeping it validated and agent-ready. The Azure Diagnostics API Client provides programmatic access to diagnostic detectors, analyses, and category data for Azure App Service sites and App Service Environments. It exposes 22 endpoints that let you list site diagnostic categories, retrieve detector responses for sites and deployment slots, and execute analyses against a running web app. The API is part of the Microsoft.Web resource provider on management.azure.com and is used to surface the same troubleshooting data as the Azure portal Diagnose and solve problems blade.

Use Cases

Patterns agents use Diagnostics API Client API for, with concrete tasks.

★ Automated App Service Incident Triage

When an Azure App Service site is misbehaving, on-call engineers can use the Diagnostics API to pull the same detector output that the portal Diagnose and solve problems blade shows. By listing detector responses for the site, then executing the relevant detector against the suspected time window, the API surfaces the root-cause category — CPU pressure, memory exhaustion, dependency failures, or platform restarts — without an engineer ever opening the portal. Results return in seconds and can be piped straight into a Slack or PagerDuty incident channel.

List all detector responses for the site mywebapp in resource group prod-rg, then execute the ApplicationCrashes detector and return the top three findings.

Slot-Level Regression Detection

Before swapping a staging deployment slot into production, teams need to confirm that the new build is not introducing regressions. The Diagnostics API exposes detector and analysis endpoints scoped to a specific deployment slot, so an agent can run the same checks against staging that already pass against production and surface any new diagnostic findings. This lets continuous delivery pipelines gate slot swaps on real diagnostic signal rather than just synthetic tests.

Execute the HttpServerErrors detector against the staging slot of mywebapp and compare the result count against the production slot output for the last 30 minutes.

Hosting Environment Health Monitoring

App Service Environment operators run dozens of sites on shared infrastructure and need a single view of platform health. The hosting environment detector endpoints return diagnostic data scoped to the entire ASE rather than a single site, so an agent can pull a daily health summary covering networking, scaling, and front-end availability. This is the same data the Azure platform team uses to investigate ASE-wide incidents.

Retrieve all hosting environment detector responses for the ASE named prod-ase and flag any with severity Error in the past 24 hours.

AI Agent Diagnostic Assistant via Jentic

An AI assistant integrated through Jentic can resolve App Service support tickets without a human pulling logs. Given a customer report like the checkout site is slow, the agent searches Jentic for diagnose azure app service, loads the Diagnostics API operation schema, executes the relevant analysis against the named site, and replies with a plain-English summary of the detector output. Credentials never leave the Jentic vault, and the agent only sees a scoped access token.

Through Jentic, search for diagnose azure app service, load the Diagnostics_ExecuteSiteAnalysis schema, and run it against mywebapp with the analysis name AvailabilityAndPerformance.

Key Endpoints

22 endpoints — jentic publishes the only available openapi specification for diagnostics api client, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics

List diagnostic categories for an App Service site

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/detectors

List detector responses for a site

POST

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/analyses/{analysisName}/execute

Execute a named site analysis

POST

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/detectors/{detectorName}/execute

Execute a named site detector

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/detectors

List detector responses for a deployment slot

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/detectors

List detector responses for an App Service Environment

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics

List diagnostic categories for an App Service site

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/detectors

List detector responses for a site

POST

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/analyses/{analysisName}/execute

Execute a named site analysis

POST

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/detectors/{detectorName}/execute

Execute a named site detector

Why though Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Azure AD client credentials are stored encrypted in the Jentic vault (MAXsystem). The agent receives a short-lived bearer token scoped to management.azure.com — the client secret or certificate never enters the agent context.

Intent-based discovery

Agents search by intent (e.g. 'diagnose azure app service') and Jentic returns the matching Diagnostics operation along with its input schema, so the agent picks the right endpoint without crawling Azure REST docs.

Time to first call

Direct integration with the Azure Diagnostics REST API: 1-2 days for AAD token acquisition, ARM URL construction, and pagination handling. Through Jentic: under 30 minutes — search, load schema, execute.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Complementary

DNS Management Client

Manage Azure DNS zones and record sets that often back the App Service sites being diagnosed

Choose this when the agent needs to inspect or change DNS records pointing at an App Service site, not when investigating in-app failures

Complementary

EventGrid Management Client

Wire Azure resource events (including App Service health events) into downstream consumers

Use when the agent needs to subscribe to App Service events rather than poll detectors directly

Alternative

Disk Resource Provider Client

Manages Azure managed disks rather than App Service diagnostics

Choose this when the workload runs on virtual machines rather than App Service and the agent needs to inspect disk state

FAQs

Specific to using Diagnostics API Client API through Jentic.

Why is there no official OpenAPI spec for Diagnostics API Client?

Microsoft Azure does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Diagnostics API Client via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the Diagnostics API Client use?

The API uses Azure Active Directory OAuth 2.0 (azure_auth). Calls go to https://management.azure.com/ with a bearer access token obtained from Azure AD. Through Jentic, the Azure credential is held in the Jentic vault and the agent receives a scoped access token only — the underlying client secret or certificate never enters the agent context.

Can I execute a site analysis against an Azure App Service deployment slot?

Yes. The endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}/analyses/{analysisName}/execute runs a named analysis against a specific deployment slot, which is useful for validating staging slots before swap.

What are the rate limits for the Diagnostics API Client?

Azure Resource Manager applies subscription-scoped throttling, generally documented as 12,000 reads per hour and 1,200 writes per hour per subscription. The Diagnostics API endpoints are read-heavy (GET) plus a few execute (POST) operations and share that envelope. Inspect x-ms-ratelimit-* response headers for remaining quota.

How do I list detector responses for a site through Jentic?

Run pip install jentic, then search for list azure app service detector responses, load the Diagnostics_ListSiteDetectorResponses schema, and execute it with subscriptionId, resourceGroupName, and siteName. The response is the JSON detector collection straight from the Microsoft.Web provider.

Does this API let me change App Service configuration?

No. The Diagnostics API Client is read-and-execute only — it lists detectors, fetches detector responses, and runs named analyses. To modify App Service settings, scaling, or deployment slots, use the separate Web Apps management API on the Microsoft.Web provider.