Account

Get scan template details

get/account/tasks/templates/{scan_template_id}

Path parameters

scan_template_idstring uuid required

UUID of the scan template to retrieve

Response

scan template

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"
  }
}

Changes

Changed in 2 of the 50 revisions of this API.136

Jun 23, 20224244458bf900135See the full diff
- ▲
  the response's body type/format changed from / to object/ for status 200
  response-body-type-changed
- ○
  added the optional property agent_id to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property client_id to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property created_at to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property created_by to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property created_by_user_id to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property cruncher_id to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property description to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property error to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property grace_period to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property hidden to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property hosted_zone_id to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property linked_task_count to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property name to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property organization_id to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property params to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property parent_id to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property recur to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property recur_frequency to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property recur_last to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property recur_last_task_id to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property recur_next to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property site_id to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property size_data to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property size_results to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property size_site to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property source_id to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property start_time to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property stats to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property status to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property template_id to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property type to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property updated_at to the response with the 200 status
  response-optional-property-added
- ○
  added the required property acl to the response with the 200 status
  response-required-property-added
- ○
  added the required property global to the response with the 200 status
  response-required-property-added
- ○
  added the required property id to the response with the 200 status
  response-required-property-added
Jun 23, 202283affdd268e51See the full diff
- ○
  endpoint added
  endpoint-added

Full history