Get Action for a Specific Incident

Retrieves details of a specific action.

Retrieves details of a specific action for an incident.

get/v1/{accountId}/incidents/{incidentId}/actions/{actionId}

Request

Base URL
https://api.usa.cloud.watchguard.com/rest/threatsync/management
Auth
API key in header WatchGuard-API-Key and HTTP bearer
TypeScript
https://skmtc.dev/watchguard/apis/threatsync-management-api/docs/v1/:accountId/incidents/:incidentId/actions/:actionId/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

accountIdstring required

Your WatchGuard Cloud Account ID.

incidentIdstring required

ID of an incident.

actionIdstring required

ID of an action.

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",
  "incidentId": "ch3hmad3u2h464hfedi0",
  "status": "performed",
  "history": [
    {
      "lastUpdateTime": "2023-09-27T06:44:34Z",
      "status": "inProgress"
    },
    {
      "errorMessage": "",
      "lastUpdateTime": "2023-09-27T06:44:34Z",
      "status": "performed"
    }
  ],
  "result": {
    "status": "performed"
  }
}

Changes

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