Skip to main content
POST
/
analysis
/
azure
/
analyze
curl --request POST \
--url https://{host}/analysis/azure/analyze \
--header 'Content-Type: application/json' \
--data '{
"subscriptionId": "cc377154-9605-4cb0-8b41-1b39e1c4ac0f",
"applicationId": "bd6529bf-85d8-410d-a207-ce963b4dd398",
"secretKey": "REDACTED",
"tenantId": "6c9190a7-bca6-4fcd-b35e-36378aadc695",
"connectionName": "AzureEnvTest",
"webHook": {
"uri": "https://example.test/webhook/results",
"authType": "basic",
"authValue": "user:pass"
}
}'
{
  "href": "Not available",
  "message": "Analysis in progress",
  "status": 200
}

Body

application/json

Supply subscription and credentials. For historical audit, set triggerAdhocAudit=true and optionally set startDayOffset/endDayOffset. Only one subscription is processed per request.

subscriptionId
string
required

Azure Subscription ID.

applicationId
string
required

Azure AD application (client) ID.

secretKey
string
required

Client secret for the application.

tenantId
string
required

Azure AD tenant ID.

serviceAcctJSON
string

Credentials provided as a JSON file, supplied here as a string (implementation-specific).

connectionName
string

Optional display name (<= 32 chars) for this connection. Must be unique within Azure connections.

Maximum length: 32
webHook
object
triggerAdhocAudit
boolean

Trigger a one-time historical audit (requires an existing connection).

startDayOffset
string

Offset from 30 days in the past to set the start of the historical range.

endDayOffset
string

Offset from yesterday to set the end of the historical range.

Response

Accepted / analysis initiated

message
string
required
status
integer
required

HTTP-like status code (200, 400, 401, 404, 500).

href
string

Link to analysis recommendations (if available).