WAwatchguard
Get Actions

Retrieves a list of actions.

Retrieves a list of actions.

get/v1/{accountId}/actions

Request

Path parameters

accountIdstring required

Your WatchGuard Cloud Account ID.

Query parameters

querystring

Query string that enables you to search for records that match the specified data. Specify parameter names and associated values to retrieve objects that match those values.

sortBystring

Specifies how to sort results. This can be the names of one or more response parameters, separated by commas.

sortOrderstring

Specifies whether to sort the results in ascending or descending order. This can be one of these values:

  • asc - Sorts results in ascending order.
  • desc - Sorts results in descending order.
groupBystring

Specifies the parameter to group data by.

fieldsstring

Specifies which response parameters to return in the results. If you do not specify a value, the API returns all response parameters. This can be one or more values, separated by commas.

countOnlyboolean

Specifies whether to retrieve only a count of records.

limitinteger

Maximum number of records to retrieve in the response. The maximum is limited to 500 records. The default value is 250.

startAfterstring

Cursor value that identifies the record after which you want to retrieve records. This value must match the data returned in the response parameter you specify in the sortBy request paramter.

durationstring

Duration of time in days to retrieve records for. Specify a number followed by the letter D. For example, 7D.

Response

Successful response.

countinteger

Total count of actions.

Example response

{
  "items": [
    {
      "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"
      }
    }
  ],
  "count": 1
}

Changes

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