WAwatchguard

Retrieve tasks.

Retrieves a list of all tasks created.

get/api/v1/accounts/{accountId}/tasks

Request

Path parameters

accountIdstring required

Your WatchGuard Cloud account ID.

Query parameters

topinteger

Specifies the number of objects to retrieve (there is a maximum supported by the server).

skipinteger

Bypasses the specified number of objects in the results returned.

countboolean

Indicates whether to return a counter that shows the total number of objects in the total_items response parameter.

filterstring
Example:Retrieves all immediate tasks: 41004%20Eq%201

Specifies a filter to retrieve the task list

  • 41003%20Eq%20{taskTypeEnum} where {taskTypeEnum} => 1=Antimalware scan, 2=Malware disinfection, 6=Patch installation, 7=Patch uninstallation,10=IOC search
  • 41004%20Eq%20{scheduleTypeEnum} where {scheduleTypeEnum} => 1=Immediate,2=One-time,3=Scheduled
  • 41006%20Eq%20{stateTypeEnum} where {stateTypeEnum} => 0=No recipients, 1=Unpublished, 2=In progress, 3=Canceled, 4=Finished

Response

OK

total_itemsinteger nullable

Total number of retrieved tasks.

Example response

{
  "data": {
    "account_id": "cd6c6dd6-b97f-453d-ad81-a5976dc0596a",
    "id": "8b7205bc-60e0-45a0-9956-b17b6a8673f1",
    "name": "Task name sample",
    "description": "Task description sample",
    "status": {
      "enabled": true,
      "last_job_date": "2023-06-11T12:00:00Z"
    },
    "schedule": {
      "start_date": "2023-06-11T12:00:00Z",
      "is_local_time": true,
      "execution_timeout": "1.07:06:05 specifies 1 day, 7 hours, 6 minutes, and 5 seconds.",
      "execution_window_expiration": "3.07:06:05 specifies 3 day, 7 hours, 6 minutes, and 5 seconds.",
      "publish_date": "2023-06-21T11:00:00Z"
    },
    "can_be_deleted": true,
    "can_be_copied": true,
    "can_access_to_detailed_view": true
  }
}

Changes

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