Actions

Poll the status of asynchronous actions that mutating broker endpoints return (e.g., edit, set applet config, lifecycle).

Poll the status of an asynchronous broker action

get

Return the current status of an action previously enqueued by an edit, applet, or lifecycle endpoint. Callers should poll with moderate backoff; typical actions complete in seconds, slow ones (upgrade, applet activation requiring image pull) in minutes.

See the Action Statuses table.

Required permission: broker_action.

Authorizations

AuthorizationstringRequired

The tenant API key value, sent as the literal Authorization header value (no Bearer prefix).

x-xdr-auth-idstringRequired

The tenant API key identifier corresponding to the value sent in Authorization.

Path parameters

action_idstring · min: 1Required

The opaque action identifier returned by a prior mutating call.

Example: act_2c8d6b9e1a

Responses

200

Current action status.

application/json

Status payload returned by getActionStatus. The single status field reflects the current state of the asynchronous broker action.

statusstring · enumRequired

Possible states of an asynchronous broker action.

Possible values:

401

Missing or invalid Authorization / x-xdr-auth-id credentials.

application/json

403

Authenticated caller lacks the broker_action permission. (This read-only poll endpoint performs no cluster-member check, so the shared cluster-member 403 wording does not apply here.)

application/json

500

Unexpected server-side failure.

application/json

get/public_api/v1/brokers/action_status/{action_id}/

GET /public_api/v1/brokers/action_status/{action_id}/ HTTP/1.1
Host: api-cortex.paloaltonetworks.com
Authorization: YOUR_API_KEY
x-xdr-auth-id: YOUR_API_KEY
Accept: */*

{
  "status": "IN_PROGRESS"
}