WAwatchguard
Perform Action

Performs an action.

Performs a specified action.

post/v1/{accountId}/actions

Request

Path parameters

accountIdstring required

Your WatchGuard Cloud Account ID.

Request body

commandstring required

Name of the action to perform.

parametersobject required

Parameters required to perform the action. These depend on the specified action.

entityIdstring

ID of the entity.

Example request

{
  "command": "blockAddress",
  "parameters": {
    "address": "3.3.3.3"
  }
}

Response

Successful response.

idstring

ID of an action.

accountstring

Account ID.

entityIdstring

ID of the entity.

entityTypestring

The type of entity.

irreversibleboolean

Indicates whether the action is reversible.

typestring

Identifies whether an action was performed manually or through an automation policy.

responderstring

Indicates whether the action was initiated at the source, initiated manually, or initiated by an automation policy.

creationTimestring

The time the action was created.

commandstring

The name of the action performed.

lastUpdateTimestring

Last updated time of the action.

initiatedBystring

The name of the operator who initiated the action.

incidentIdstring

ID of an incident.

errorMessagestring

Describes the reason the action failed.

statusstring

Status of the action.

Example response

{
  "id": "cd08f4a339fb40feb4ee69314cdb1f8c",
  "account": "WCG-1-123abc456 or ACC-1234567",
  "entityType": "firebox",
  "parameters": {
    "address": "3.3.3.3"
  },
  "type": "manual",
  "responder": "System",
  "creationTime": "2023-09-27T06:44:34Z",
  "command": "blockAddress",
  "lastUpdateTime": "2023-09-27T06:44:34Z",
  "initiatedBy": "ffc1c30697abdc4e_rw_id",
  "status": "inProgress",
  "history": [
    {
      "lastUpdateTime": "2023-09-27T06:44:34Z",
      "status": "inProgress"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.