v50

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

Account

Get all scan templates across all organizations (up to 1000)

get/account/tasks/templates

Query parameters

searchstring

an optional search string for filtering results

Response

array of scan templates

idstring uuid required

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

namestring

descriptionstring

grace_periodstring

source_idstring

template_idstring uuid

size_siteinteger

size_datainteger

size_resultsinteger

hosted_zone_idstring uuid

linked_task_countinteger

globalboolean required

aclobject required

Example response

[
  {
    "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",
    "name": "My Scan Template",
    "description": "My Scan Template",
    "grace_period": "4",
    "source_id": "1",
    "template_id": "e77602e0-3fb8-4734-aef9-fbc6fdcb0fa8",
    "hosted_zone_id": "e77602e0-3fb8-4734-aef9-fbc6fdcb0fa8",
    "linked_task_count": 1,
    "acl": {
      "e77602e0-3fb8-4734-aef9-fbc6fdcb0fa8": "user"
    }
  }
]