v50

latestOpenAPI 3.0.0Commercialraw.githubusercontent.com2022-08-0911645127.8 KB

Organization

Update task parameters

patch/org/tasks/{task_id}

Path parameters

task_idstring uuid required

UUID of the task to update

Request body

idstring uuid required

namestring

descriptionstring

template_idstring uuid

client_idstring uuid

organization_idstring uuid

agent_idstring uuid

site_idstring uuid

cruncher_idstring uuid

created_atinteger

created_bystring email

created_by_user_idstring uuid

updated_atinteger

typestring

statusstring

errorstring

paramsobject

statsobject

hiddenboolean

parent_idstring uuid

recurboolean

recur_frequencystring

start_timeinteger

recur_lastinteger

recur_nextinteger

recur_last_task_idstring uuid

Example request

{
  "id": "e77602e0-3fb8-4734-aef9-fbc6fdcb0fa8",
  "name": "Hourly Scan",
  "description": "Scan the headquarters hourly",
  "template_id": "e77602e0-3fb8-4734-aef9-fbc6fdcb0fa8",
  "client_id": "e77602e0-3fb8-4734-aef9-fbc6fdcb0fa8",
  "organization_id": "e77602e0-3fb8-4734-aef9-fbc6fdcb0fa8",
  "agent_id": "e77602e0-3fb8-4734-aef9-fbc6fdcb0fa8",
  "site_id": "e77602e0-3fb8-4734-aef9-fbc6fdcb0fa8",
  "cruncher_id": "e77602e0-3fb8-4734-aef9-fbc6fdcb0fa8",
  "created_at": 1576300370,
  "created_by": "user@example.com",
  "created_by_user_id": "e77602e0-3fb8-4734-aef9-fbc6fdcb0fa8",
  "updated_at": 1576300370,
  "type": "scan",
  "status": "processed",
  "error": "agent unavailable",
  "parent_id": "e77602e0-3fb8-4734-aef9-fbc6fdcb0fa8",
  "recur_frequency": "hour",
  "start_time": 1576300370,
  "recur_last": 1576300370,
  "recur_next": 1576300370,
  "recur_last_task_id": "e77602e0-3fb8-4734-aef9-fbc6fdcb0fa8"
}

Response

task details