4.3. API Methods

Note

The methods in this chapter are under development. Please contact technical support for more information.

Method

Description

ProjectsList

The method returns a list of available projects for the user with the specified user_id. Also it displays additional information about the user’s role, the number of active probes and tasks in the project.

ProjectCreate

The method allows you to create a new project for the user with the specified user_id.

ProjectSettingsChange

The method allows you to change the settings of an existing project.

TemplateList

The method returns a list of existing templates in the project.

TemplateDownload

The method returns template in JSON format by its template_id.

TemplateUpload

This method allows you to import a template in JSON format to the server.

TaskStart

The method allows you to create and run verification tasks, and returns the task identifier task_id, which allows you to manage the task, track its status, and request a report.

TaskStop

The method allows you to stop a task by its task_ids.

TaskStatus

The method returns the status of a task by its task_ids and allows you to track the current stage of verification task.

TaskReport

The method returns a report for the completed task.

TaskReportGenerate

The method launches the process of generating a report file for the completed task.

AppList

The method returns the list of running and inactive probes of a project.

AppState

The method returns information about a probe, description, a current state, system resources utilization.