Show/hide List Operations Expand Operations

Analysis

/api/v2/analysis

GET /api/v2/analysis

Get analysis reports

Documentation
Sandbox

Documentation

Get analysis report Supported types

health
device
users
ports
software
settings
logs
cve
metrics
docker

Supported search fields:

pub_key_digest - array of the devices id (exact match) - all report types
- Users
user - regex
comment - regex
pwd_alg - array. Allowed values [-1, 1, 2, '2a', 5, 6, 'unknown']. Where -1 - not set; 1 - MD5; 2 - Blowfish; 2a - Eksblowfish; 5 - SHA-256; 6 - SHA-512.
- Ports
proto - regex
socket - regex
proc_info - regex
- Software
name - regex
version - regex
arch - regex
update - regex (expected same format as version)

Supported sort fields:

pub_key_digest (alphabetical)
title (alphabetical)
device_name (with fallback to fqhost if not present) Supported report types:
health
users
settings
logs
cve
software
docker

Parameters

Parameter	Type	Required?	Description
search	json	false	Search conditions. Supported fields: ^see description on top
type	string	true	Report type: ^see description on top
sort_field	string	false	Field to sort, ts by default
sort_direction	string	false	Sort direction, desc by default
items_per_page	integer	false	Maximum number of records in result, default 30, max 1000
offset	integer	false	Offset, default 0

Status Codes

Status Code	Description
200	Returned when successful
400	Returned if required parameters are not set correctly
401	Returned when the user is not authenticated
403	Returned if access denied
500	Returned for internal server error

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/v2/analysis

Get analysis reports via POST. For the parameter description check the documentation for GET

Documentation
Sandbox

Documentation

Get analysis report (via POST)

this is exact copy of the GET request, and it is needed in case the search string is too big for the GET

Parameters

Parameter	Type	Required?	Description
search	json	false	Search conditions. Supported fields: ^see description on top
type	string	true	Report type: ^see description on top
sort_field	string	false	Field to sort, ts by default
sort_direction	string	false	Sort direction, desc by default
items_per_page	integer	false	Maximum number of records in result, default 30, max 1000
offset	integer	false	Offset, default 0

Status Codes

Status Code	Description
200	Returned when successful
400	Returned if required parameters are not set correctly
401	Returned when the user is not authenticated
403	Returned if access denied
500	Returned for internal server error

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/api/v2/analysis/orgstats

GET /api/v2/analysis/orgstats

Get organisation statistics

Documentation
Sandbox

Documentation

Get organisation statistics

Status Codes

Status Code	Description
200	Returned when successful
400	Returned if required parameters are not set correctly
401	Returned when the user is not authenticated
403	Returned if access denied
500	Returned for internal server error

Input

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Authentication

/api/v2/challenge-get

POST /api/v2/challenge-get

Get 2fa challenge

Documentation
Sandbox

Documentation

Get 2fa challenge

Parameters

Parameter	Type	Required?	Format	Description
challenge	string	true		challenge code from login attempt
preferProvider	string, Allowed values: google\|email	true		2fa provider

Status Codes

Status Code	Description
200	Returned when successful
401	Returned if user is not authenticated
500	Returned for internal server error

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/api/v2/challenge-verify

POST /api/v2/challenge-verify

2fa challenge

Documentation
Sandbox

Documentation

2fa verification. Verify challenge from login attempt together with the code from 2fa provider (email|google)

Parameters

Parameter	Type	Required?	Format	Description
challenge	string	true		challenge code from login attempt
code	string	true		verificatoin code from 2fa channel - email\|google

Status Codes

Status Code	Description
200	Returned when successful
401	Returned if user is not authenticated
500	Returned for internal server error

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/api/v2/login

POST /api/v2/login

Login

Documentation
Sandbox

Documentation

Login user

Parameters

Parameter	Type	Required?	Format	Description
email	string	true		email
password	string	true		Password

Status Codes

Status Code	Description
200	Returned when successful
401	Returned if user is not authenticated
500	Returned for internal server error

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/api/v2/logout

GET /api/v2/logout

Logout

Documentation
Sandbox

Documentation

Logout user

Parameters

Parameter	Type	Required?	Format	Description
full	string	false		Set to true to logout from all sessions

Status Codes

Status Code	Description
200	Returned when successful
401	Returned if user is not authenticated
500	Returned for internal server error

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/api/v2/refresh-jwt

POST /api/v2/refresh-jwt

update refresh token with PHPSESSID from COOKIE

Documentation
Sandbox

Documentation

Post api, update refresh token with PHPSESSID from COOKIE

Status Codes

Status Code	Description
200	Returned when successful
401	Returned when the user is not authenticated
403	Returned if access denied
404	Returned when resource not found
500	Returned for internal server error

Input

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Bootstrap

/api/v2/bootstrapkey

POST /api/v2/bootstrapkey

Generate a new key and return to the client. NOTE: no parameters needed

Documentation
Sandbox

Documentation

Generate a new bootstrap key

Status Codes

Status Code	Description
200	Returned when successful
401	Returned when the user is not authenticated
403	Returned if access denied
404	Returned when resource not found
500	Returned for internal server error

Input

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/api/v2/bootstrapkey/{bootstrap_key}

DELETE /api/v2/bootstrapkey/{bootstrap_key}

Delete bootstrap key

Documentation
Sandbox

Documentation

Delete bootstrap key

Requirements

Name	Requirement	Type	Description
bootstrap_key

Status Codes

Status Code	Description
200	Returned when successful
401	Returned when the user is not authenticated
403	Returned if access denied
404	Returned when resource not found
500	Returned for internal server error

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/v2/bootstrapkey/{bootstrap_key}

Get bootstrap key

Documentation
Sandbox

Documentation

Get bootstrap key

Requirements

Name	Requirement	Type	Description
bootstrap_key		string

Status Codes

Status Code	Description
200	Returned when successful
401	Returned when the user is not authenticated
403	Returned if access denied
404	Returned when resource not found
500	Returned for internal server error

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /api/v2/bootstrapkey/{bootstrap_key}

Enable or disable auto accept and set default group for the key

Documentation
Sandbox

Documentation

Enable or disable auto accept and set group

Requirements

Name	Requirement	Type	Description
bootstrap_key		string	Bootstrap key ID

Parameters

Parameter	Type	Required?	Format	Description
auto_accept	boolean	true		Auto accept value: true ot false
group_id	string	true		Group id. Set to null for unassigned

Status Codes

Status Code	Description
200	Returned when successful
401	Returned when the user is not authenticated
403	Returned if access denied
404	Returned when resource not found
500	Returned for internal server error

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/api/v2/bootstrapkeylist

GET /api/v2/bootstrapkeylist

Get bootstrap keys

Documentation
Sandbox

Documentation

Get bootstrap keys

Status Codes

Status Code	Description
200	Returned when successful
401	Returned when the user is not authenticated
403	Returned if access denied
404	Returned when resource not found
500	Returned for internal server error

Input

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

CVE

/api/v2/cve/status/cves

PATCH /api/v2/cve/status/cves

Set CVE status

Documentation
Sandbox

Documentation

Patch CVE - set status

Parameters

Parameter	Type	Required?	Format	Description
cve_ids	array	false		cve ids
status	string	true		available cve status

Status Codes

Status Code	Description
204	Returned when successful
400	Returned if required parameters are not set correctly
401	Returned when the user is not authenticated
403	Returned if access denied
404	Returned when resource not found
500	Returned for internal server error

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/api/v2/cve/{cve_id}

DELETE /api/v2/cve/{cve_id}

Delete CVE item. Only allowed if affected host count for this CVE = 0

Documentation
Sandbox

Documentation

Delete CVE item. Only allowed if affected host count for this CVE = 0

Requirements

Name	Requirement	Type	Description
cve_id		string	CVE Id

Parameters

Parameter	Type	Required?	Format	Description
message	string	false		Commit message

Status Codes

Status Code	Description
200	Returned when successful
401	Returned when the user is not authenticated
403	Returned if access denied
404	Returned when resource not found
500	Returned for internal server error

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/v2/cve/{cve_id}

Get CVE item info by Id

Documentation
Sandbox

Documentation

Get CVE item info by Id

Requirements

Name	Requirement	Type	Description
cve_id		string	CVE Id

Status Codes

Status Code	Description
200	Returned when successful
401	Returned when the user is not authenticated
403	Returned if access denied
404	Returned when resource not found
500	Returned for internal server error

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PATCH /api/v2/cve/{cve_id}

Disable or enable CVE

Documentation
Sandbox

Documentation

Patch CVE - set as disabled/enabled

Requirements

Name	Requirement	Type	Description
cve_id		string	CVE ID

Parameters

Parameter	Type	Required?	Format	Description
disabled	boolean	true		Disabled value: true ot false
message	string	false		Commit message

Status Codes

Status Code	Description
204	Returned when successful
400	Returned if required parameters are not set correctly
401	Returned when the user is not authenticated
403	Returned if access denied
404	Returned when resource not found
500	Returned for internal server error

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/api/v2/cve_hosts_max_count

GET /api/v2/cve_hosts_max_count

Get hosts with max count of CVE - we include all CVE type

Documentation
Sandbox

Documentation

Get hosts with max count of CVE - we include all CVE type. If device_id is set - return count of CVE for that host

Parameters

Parameter	Type	Required?	Format	Description
device_id	string	false		Device id
limit	integer	false		Maximum number of records, default 5, max 100

Status Codes

Status Code	Description
200	Returned when successful
401	Returned when the user is not authenticated
403	Returned if access denied
404	Returned when resource not found
500	Returned for internal server error

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/api/v2/cvelist

GET /api/v2/cvelist

Get list of CVE items detected in the system

Documentation
Sandbox

Documentation

Get list of CVE items detected in the system

Supported search fields:

cve_id - exact match
package_name - substring
disabled - boolean
statuses - array('string')|string

Supported sort fields:

cve_id - (alphabetical)
package_name - (alphabetical)
score - numeric
updated - date
hosts_count - numeric
disabled - boolean

Requirements

Name	Type	Description
search	json	Search conditions. Supported fields: ^see description on top
sort_field	string	Field to sort, cve_id by default
sort_direction	string	Sort direction, asc by default
items_per_page	integer	Maximum number of records in result, default 30, max 1000
offset	integer	Offset

Status Codes

Status Code	Description
200	Returned when successful
401	Returned when the user is not authenticated
403	Returned if access denied
404	Returned when resource not found
500	Returned for internal server error

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/api/v2/cvescorestats

GET /api/v2/cvescorestats

Get CVE scores for active/disabled items based on severity

Documentation
Sandbox

Documentation

Get CVE scores for active/disabled items based on severity

Status Codes

Status Code	Description
200	Returned when successful
401	Returned when the user is not authenticated
403	Returned if access denied
404	Returned when resource not found
500	Returned for internal server error

Input

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Change

/api/v2/change

POST /api/v2/change

Add new change to the configuration

Documentation
Sandbox

Documentation

Add new change to the configuration

Requirements

Name	Type	Description
node_id	string	Device or group id. Note: node_id or tag is required
tag	string	Tag
config	json	Config change as json
formtype	string	form which we change

Status Codes

Status Code	Description
204	Returned when successful
400	Returned if required parameters are not set correctly
401	Returned when the user is not authenticated
403	Returned if access denied
404	Returned when resource not found
500	Returned for internal server error

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/api/v2/change/{sha}

DELETE /api/v2/change/{sha}

Delete single uncommitted change by sha. You can delete only config changes

Documentation
Sandbox

Documentation

Delete change by sha - only uncommitted. You can delete only config changes

Requirements

Name	Requirement	Type	Description
sha

Status Codes

Status Code	Description
200	Returned when successful
401	Returned when the user is not authenticated
403	Returned if access denied
404	Returned when resource not found
500	Returned for internal server error

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/v2/change/{sha}

Get change - return change by sha

Documentation
Sandbox

Documentation

Get change

Requirements

Name	Requirement	Type	Description
sha		string	change id

Status Codes

Status Code	Description
200	Returned when successful
401	Returned when the user is not authenticated
403	Returned if access denied
404	Returned when resource not found
500	Returned for internal server error

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/api/v2/changelist

GET /api/v2/changelist

Get list of uncommitted changes

Documentation
Sandbox

Documentation

Get list of changes

Requirements

Name	Type	Description
search	json	Search conditions. Supported fields: user_id, group_id, status, form_type
created_start	date	Start date UTC, format: YYYY-MM-DD hh:ii:ss. Default -1 month from now
created_end	date	End date UTC, format: YYYY-MM-DD hh:ii:ss. Default: now
sort	string	Field to sort, created by default
sort_direction	string	Sort direction, desc by default
limit	integer	Maximum number of records, default 3000, max 10 000
offset	integer	Offset

Status Codes

Status Code	Description
200	Returned when successful
401	Returned when the user is not authenticated
403	Returned if access denied
404	Returned when resource not found
500	Returned for internal server error

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/api/v2/changes

DELETE /api/v2/changes

Delete all uncommitted changes

Documentation
Sandbox

Documentation

Delete all uncommitted changes

Status Codes

Status Code	Description
200	Returned when successful
401	Returned when the user is not authenticated
403	Returned if access denied
404	Returned when resource not found
500	Returned for internal server error

Input

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Commit

/api/v2/commit

POST /api/v2/commit

Commit changes and create a new configuration

Documentation
Sandbox

Documentation

Commit changes and create a new configuration

Requirements

Name	Requirement	Type	Description
action		string	Action to execute. Only commit is supported for now
message		string	Commit message

Status Codes

Status Code	Description
200	Returned when successful
204	Returned when nothing to commit
400	Returned if required parameters are not set correctly
401	Returned when the user is not authenticated
403	Returned if access denied
404	Returned when resource not found
500	Returned for internal server error

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/api/v2/commit/{sha}

GET /api/v2/commit/{sha}

Get commit - return commit by id. We support full sha or at least 6 first characters

Documentation
Sandbox

Documentation

Get commit

Requirements

Name	Requirement	Type	Description
sha		string	Commit SHA, could be a substring with 6+ characters
report_type		string	Repot type - detailed or short. Short by default

Status Codes

Status Code	Description
200	Returned when successful
401	Returned when the user is not authenticated
403	Returned if access denied
404	Returned when resource not found
500	Returned for internal server error

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/api/v2/commitlist

GET /api/v2/commitlist

Get list of commits

Documentation
Sandbox

Documentation

Get list of commits

Supported search fields:

commit_sha - commit sha - full string or substring with at least 6 characters
message - commit message (substring), also search for CVE_ID (exact match)
user_id - id of the user who created commit (exact match)
committer - name or surname of the user (substring match)
change_sha - change sha - full string or substring with at least 6 characters
labels_include - array of tags which MUST be preset (exact match)
labels_exclude - array of tags which MUST NOT be preset (exact match)
start_date - Start date UTC, format: YYYY-MM-DD hh:ii:ss
end_date - End date UTC, format: YYYY-MM-DD hh:ii:ss.

Supported sort fields:

user_id
type
message
created

Requirements

Name	Type	Description
search	json	Search conditions. Supported fields: ^see full list on top. Example: {"message": "update xyz"}
sort_field	string	Field to sort, created by default
sort_direction	string	Sort direction, desc by default
items_per_page	integer	Maximum number of records in result, default 30, max 1000
offset	integer	Offset
report_type	string	Detailed or short result. Default: short. Detailed includes config_history

Status Codes

Status Code	Description
200	Returned when successful
401	Returned when the user is not authenticated
403	Returned if access denied
404	Returned when resource not found
500	Returned for internal server error

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Company

/api/v2/company/{company_id}

GET /api/v2/company/{company_id}

Get company

Documentation
Sandbox

Documentation

Get company information

Requirements

Name	Requirement	Type	Description
company_id		string	Company UUID

Status Codes

Status Code	Description
200	Returned when successful
401	Returned when the user is not authenticated
403	Returned if access denied
404	Returned when resource not found
500	Returned for internal server error

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PATCH /api/v2/company/{company_id}

Update company

Documentation
Sandbox

Documentation

Update company

Requirements

Name	Requirement	Type	Description
company_id		string	Company UUID

Parameters

Parameter	Type	Required?	Format	Description
name	string	false		Name of company

Status Codes

Status Code	Description
204	Returned when successful
400	Returned if required parameters are not set correctly
401	Returned when the user is not authenticated
403	Returned if access denied
404	Returned when resource not found
500	Returned for internal server error

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /api/v2/company/{company_id}

Update company

Documentation
Sandbox

Documentation

Update company

Requirements

Name	Requirement	Type	Description
company_id		string	Company UUID

Parameters

Parameter	Type	Required?	Format	Description
name	string	true		Name of company
support_access	bool	false		Support access. False by default

Status Codes

Status Code	Description
204	Returned when successful
400	Returned if required parameters are not set correctly
401	Returned when the user is not authenticated
403	Returned if access denied
404	Returned when resource not found
500	Returned for internal server error

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Config

/api/v2/config/{device_id}

GET DEPRECATED /api/v2/config/{device_id}

Get active config for device

Documentation
Sandbox

Documentation

Get active config for the node

Requirements

Name	Requirement	Type	Description
device_id		string	Node id

Status Codes

Status Code	Description
200	Returned when successful
401	Returned when the user is not authenticated
403	Returned if access denied
404	Returned when resource not found
500	Returned for internal server error

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/api/v2/config/{type}/{item_id}

GET /api/v2/config/{type}/{item_id}

Get active config for node

Documentation
Sandbox

Documentation

Get active config for the node

Requirements

Name	Requirement	Type	Description
type		string	Item type. Allowed values: node, tag
item_id		string	Node id or tag string

Status Codes

Status Code	Description
200	Returned when successful
401	Returned when the user is not authenticated
403	Returned if access denied
404	Returned when resource not found
500	Returned for internal server error

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/api/v2/configpreview/{node_id}

GET DEPRECATED /api/v2/configpreview/{node_id}

Get config preview for device. It shows how config will look with all NEW (not committed) changes

Documentation
Sandbox

Documentation

Get config preview for the device

Requirements

Name	Requirement	Type	Description
device_id		string	Device or group id
node_id

Status Codes

Status Code	Description
200	Returned when successful
401	Returned when the user is not authenticated
403	Returned if access denied
404	Returned when resource not found
500	Returned for internal server error

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/api/v2/configpreview/{type}/{item_id}

GET /api/v2/configpreview/{type}/{item_id}

Get config preview for device. It shows how config will look with all NEW (not committed) changes

Documentation
Sandbox

Documentation

Get config preview for the device

Requirements

Name	Requirement	Type	Description
type		string	Item type. Allowed values: node, tag
item_id		string	Node id or tag string

Status Codes

Status Code	Description
200	Returned when successful
401	Returned when the user is not authenticated
403	Returned if access denied
404	Returned when resource not found
500	Returned for internal server error

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Device Attribute

/api/v2/deviceattribute/{device_id}

GET /api/v2/deviceattribute/{device_id}

Get user defined device information, such as device_name, address, location AND automatically discovered info by IP

Documentation
Sandbox

Documentation

Get device attribute information information

Requirements

Name	Requirement	Type	Description
device_id		string	device pub key

Status Codes

Status Code	Description
200	Returned when successful
401	Returned when the user is not authenticated
403	Returned if access denied
404	Returned when resource not found
500	Returned for internal server error

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PATCH /api/v2/deviceattribute/{device_id}

Get user defined device information, such as device_name, address, location AND automatically discovered info by IP

Documentation
Sandbox

Documentation

Update device custom info

Requirements

Name	Requirement	Type	Description
device_id		string	Device ID

Parameters

Parameter	Type	Required?	Description
device_name	string	false	Device name
description	string	false	Description
country	string	false	Country
city	string	false	City
zip	string	false	Zip code
address	string	false	Address
latitude	float	false	Latitude
longitude	float	false	Longitude

Status Codes

Status Code	Description
204	Returned when successful
400	Returned if required parameters are not set correctly
401	Returned when the user is not authenticated
403	Returned if access denied
500	Returned for internal server error

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

File

/api/v2/file

DELETE /api/v2/file

Delete directory or file specified by path.

Documentation
Sandbox

Documentation

Delete directory or file specified by path if item is a directory - we check if it is empty. You can not delete Non-empty directories

Requirements

Name	Requirement	Type	Description
path		string	Full path to directory or file

Status Codes

Status Code	Description
200	Returned when successful
401	Returned when the user is not authenticated
403	Returned if access denied
404	Returned when resource not found
500	Returned for internal server error

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/v2/file

Download a file.

Documentation
Sandbox

Documentation

Download a file specified by full path

Requirements

Name	Requirement	Type	Description
path		string	File path

Status Codes

Status Code	Description
200	Returned when successful
400	Returned if bad request - validation error for example
401	Returned when the user is not authenticated
403	Returned if access denied
404	Returned when resource not found
500	Returned for internal server error

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PATCH /api/v2/file

Rename a file

Documentation
Sandbox

Documentation

Rename file

Requirements

Name	Type	Description
path	string	old path with name
name	string	file name
newpath	string	new path with name

Return

Parameter	Type	Versions	Description
200 - Returned when successful
path	string	*

Status Codes

Status Code	Description
200	Returned when successful
401	Returned when the user is not authenticated
403	Returned if access denied
404	Returned when resource not found
500	Returned for internal server error

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/v2/file

Upload a file. Expected content type - multipart/form-data

Documentation
Sandbox

Documentation

Upload a file. Expected content type - multipart/form-data path variable is also required. Path MUST contain leading and ending slashes, for example, if file is uploaded to the bbb folder => /aa/bb/

NOTE: API sandbox doesn't support file upload. Please use cURL.

example:

curl -i -X POST -H "Authorization: Bearer [jwt-token]" -H "Content-Type: multipart/form-data" -F "path=[path_to_upload_starting_with /]" -F "file=@[local_file_to_upload]; filename=[filename]" https://www.app.qbee.io/api/v2/file

This would upload qbee_example.conf file to the root folder of your storage:

curl -i -X POST -H "Authorization: Bearer [jwt-token]" -H "Content-Type: multipart/form-data" -F "path=/" -F "file=@qbee_example.conf; filename=qbee_example.conf" https://www.app.qbee.io/api/v2/file

Parameters

Parameter	Type	Required?	Format	Description
file	file	false		File
path	string	false		path to file

Status Codes

Status Code	Description
200	Returned when successful
400	Returned if bad request - validation error for example
401	Returned when the user is not authenticated
403	Returned if access denied
404	Returned when resource not found
500	Returned for internal server error

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/api/v2/file/createdir

POST /api/v2/file/createdir

Create directory

Documentation
Sandbox

Documentation

Create directory

Requirements

Name	Requirement	Type	Description
name		string	Directory name
path		string	Directory path

Status Codes

Status Code	Description
200	Returned when successful
401	Returned when the user is not authenticated
403	Returned if access denied
404	Returned when resource not found
500	Returned for internal server error

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/api/v2/file/stats

GET /api/v2/file/stats

Files statistics (space used (Mb), quota (Mb) and more)

Documentation
Sandbox

Documentation

File statistics

Status Codes

Status Code	Description
200	Returned when successful
401	Returned when the user is not authenticated
403	Returned if access denied
404	Returned when resource not found
500	Returned for internal server error

Input

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/api/v2/files

GET /api/v2/files

Get list of uploaded files

Documentation
Sandbox

Documentation

Get list of uploaded files

Supported search fields:

name - substring

Supported sort fields:

name - alphabetical
size - numeric
created - numeric

Note:

if path is empty and search is empty - show files from the root folder
if path is empty and search is not empty - search in ALL files
if path is not empty and search is empty - show files from that directory
if path is not empty and search is not empty - search in that folder only

Requirements

Name	Type	Description
path	string	Directory to show or search. If empty - root will be used. If search is not empty and path is empty - we search in all folders
search	json	Search conditions. Supported fields: ^see description on top
sort_field	string	Field to sort, name by default
sort_direction	string	Sort direction, asc by default
items_per_page	integer	Maximum number of records in result, default 50, max 1000
offset	integer	Offset

Status Codes

Status Code	Description
200	Returned when successful
401	Returned when the user is not authenticated
403	Returned if access denied
404	Returned when resource not found
500	Returned for internal server error

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Group

/api/v2/groupreportssummary/{group_id}

GET /api/v2/groupreportssummary/{group_id}

Get group or device reports statistics (how many info, warn, err, crit) reprots for the last month, week and day

Documentation
Sandbox

Documentation

Get group reports summary

Requirements

Name	Requirement	Type	Description
group_id		string	Group id

Status Codes

Status Code	Description
200	Returned when successful
401	Returned when the user is not authenticated
403	Returned if access denied
404	Returned when resource not found
500	Returned for internal server error

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Group tree

/api/v2/grouptree

GET /api/v2/grouptree

Get group - return full tree

Documentation
Sandbox

Documentation

Get group tree

Parameters

Parameter	Type	Required?	Format	Description
skip_unassigned	boolean	false		skip or not unassigned hosts in the tree output

Status Codes

Status Code	Description
200	Returned when successful
401	Returned when the user is not authenticated
403	Returned if access denied
404	Returned when resource not found
500	Returned for internal server error

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /api/v2/grouptree

Update tree.

Documentation
Sandbox

Documentation

Update group.

Allowed actions:

create (group only)
rename (group only)
delete [group only]
move

We expect array of changes with the structure like array of changes. where each change looks like:

Create group: {"action":"create", "data":{"parent_id":"root", "node_id":"YYY", "title":"some_title", "type":"group", "position":0}}

Rename group: {"action":"rename", "data":{"parent_id":"root", "node_id":"YYY", "title":"my new title"}}

Delete group: (note group must be empty) {"action":"delete", "data":{"parent_id":"root", "node_id":"YYY"}}

Move group: {"action":"move", "data":{"parent_id": "new_parent_id", "old_parent_id':"old_parent_id", "node_id":"YYY", "position": 3, "type":"group/device"}}

Requirements

Name	Requirement	Type	Description
changes		json	Array of changes.

Status Codes

Status Code	Description
204	Returned when successful
400	Returned if required parameters are not set correctly
401	Returned when the user is not authenticated
403	Returned if access denied
404	Returned when resource not found
500	Returned for internal server error

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/api/v2/grouptree/{node_id}

GET /api/v2/grouptree/{node_id}

Get group node info. If group - info about the node and child devices. If device - very short info about device

Documentation
Sandbox

Documentation

Get group devices

Requirements

Name	Requirement	Type	Description
node_id		string	Group id or device id

Status Codes

Status Code	Description
200	Returned when successful
401	Returned when the user is not authenticated
403	Returned if access denied
404	Returned when resource not found
500	Returned for internal server error

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PATCH /api/v2/grouptree/{node_id}

Set tags to the node

Documentation
Sandbox

Documentation

Set tags to the node.

example: tags: ["root-tag1", "root-tag2"]

Requirements

Name	Requirement	Type	Description
node_id		string	Group id or device id
tags		array	Array of tags

Status Codes

Status Code	Description
200	Returned when successful
401	Returned when the user is not authenticated
403	Returned if access denied
404	Returned when resource not found
500	Returned for internal server error

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Inventory

/api/v2/inventory

GET /api/v2/inventory

Get devices list

Documentation
Sandbox

Documentation

Get list of devices

Supported search fields:

node_id - device node id
uuid - device uuid
title - fqhost, remoteaddr or device title (can be set in the attributes)
flavor - OS flavor
arch - os architecture
ip - ipv4_first, ip_addresses, remoteaddr or ipv4 fields from inventory (exact match)
description - device description - can be set in the attributes
latitude - can be set in the attributes
longitude - can be set in the attributes
country - can be set in the attributes
city - can be set in the attributes
zip - can be set in the attributes
address - can be set in the attributes
device_attribute - in this case we will search in the flavor, architecture, description, lat/long, country, city, zip, address, ipv4_first, ip_addresses, remoteaddr, ipv4 using OR condition and substring match
ancestor_ids - array of node_ids of the parent group (any level) where device should be placed.

NOTE:
- if "root" is specified we return unassigned hosts in addition to others
- To get unassigned hosts - use "unassigned_group" as one of the ancestor_ids array items
commit_sha - commit sha which is on device or scheduled to be pushed to the device. At least 6 characters. Search starts from the beginning of the string

NOTE:
- we require that search value should be at least 3 characters long. Commit sha - at least 6.

Supported sort fields:

title (fqhost or remoteaddr - depending on what is available)
device_name (from attribute)
last_reported_time
last_policy_update
active_config_commit_sha (commit which is scheduled for the device. It will be equal to the device_config_commit_sha once device receive it )

Parameters

Parameter	Type	Required?	Description
search	array	false	Search criteria. See description on top
report_type	string	false	short ir detailed report. allowed: short, detailed. Default: detailed
items_per_page	integer	false	Maximum number of records in result, default 30, max 10000
offset	integer	false	Offset
sort_field	string	false	Field to sort, title by default
sort_direction	string	false	Sort direction, asc by default

Status Codes

Status Code	Description
200	Returned when successful
400	Returned if required parameters are not set correctly
401	Returned when the user is not authenticated
403	Returned if access denied
500	Returned for internal server error

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/api/v2/inventory/{device_id}

DELETE /api/v2/inventory/{device_id}

Delete device - this will remove device from the inventory, group, configuration and associated reports AND alert service.

Documentation
Sandbox

Documentation

Delete device

Requirements

Name	Requirement	Type	Description
device_id		string	Device id

Parameters

Parameter	Type	Required?	Format	Description
message	string	false		Commit message

Status Codes

Status Code	Description
204	Returned when successful
400	Returned if required parameters are not set correctly
401	Returned when the user is not authenticated
403	Returned if access denied
500	Returned for internal server error

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/v2/inventory/{device_id}

Get inventory information about device

Documentation
Sandbox

Documentation

Get device inventory information

Requirements

Name	Requirement	Type	Description
device_id		string	device id

Status Codes

Status Code	Description
200	Returned when successful
401	Returned when the user is not authenticated
403	Returned if access denied
404	Returned when resource not found
500	Returned for internal server error

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/api/v2/inventorylist

GET DEPRECATED /api/v2/inventorylist

Get devices list

Documentation
Sandbox

Documentation

Get list of devices

Parameters

Parameter	Type	Required?	Description
report_type	string	false	short ir detailed report. allowed: short, detailed. Default: detailed
limit	integer	false	Maximum number of records. Default 1000. Maximum: 10 000
offset	integer	false	Offset

Status Codes

Status Code	Description
200	Returned when successful
400	Returned if required parameters are not set correctly
401	Returned when the user is not authenticated
403	Returned if access denied
500	Returned for internal server error

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/api/v2/inventoryonlinestats

GET /api/v2/inventoryonlinestats

Return how many devices registered and how many are offline

Documentation
Sandbox

Documentation

Return how many devices registered and how many are offline

Status Codes

Status Code	Description
200	Returned when successful
400	Returned if required parameters are not set correctly
401	Returned when the user is not authenticated
403	Returned if access denied
500	Returned for internal server error

Input

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/api/v2/inventoryreport/docker/{device_id}

GET /api/v2/inventoryreport/docker/{device_id}

Get docker inventory report for the device

Documentation
Sandbox

Documentation

Get device inventory report

Requirements

Name	Requirement	Type	Description
device_id		string	device id

Status Codes

Status Code	Description
200	Returned when successful
401	Returned when the user is not authenticated
403	Returned if access denied
404	Returned when resource not found
500	Returned for internal server error

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/api/v2/inventoryreport/{device_id}

GET /api/v2/inventoryreport/{device_id}

Get inventory report for the device

Documentation
Sandbox

Documentation

Get device inventory report

Requirements

Name	Requirement	Type	Description
device_id		string	device id

Status Codes

Status Code	Description
200	Returned when successful
401	Returned when the user is not authenticated
403	Returned if access denied
404	Returned when resource not found
500	Returned for internal server error

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/api/v2/inventorysummarybytype/{node_id}

GET /api/v2/inventorysummarybytype/{node_id}

Get summary by inventory property type. 'ports' and 'users' are supported now

Documentation
Sandbox

Documentation

Get summary report by inventory property type. It will return combined info for each host by the property ( for example: ports or users. * NOTE: This method will be changed soon

Requirements

Name	Requirement	Type	Description
node_id		string	device or group id
type		string	Type name. Ports and users are supported by now

Status Codes

Status Code	Description
200	Returned when successful
400	Returned if required parameters are not set correctly
401	Returned when the user is not authenticated
403	Returned if access denied
500	Returned for internal server error

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Metric

/api/v2/metric/last

GET /api/v2/metric/last

Get last measurements for the cpu/mem/filesystem for all devices

Documentation
Sandbox

Documentation

Get last measurements for the cpu/mem/filesystem for all devices

Status Codes

Status Code	Description
200	Returned when successful
400	Returned if required parameters are not set correctly
401	Returned when the user is not authenticated
403	Returned if access denied
500	Returned for internal server error

Input

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/api/v2/metric/{device_id}/filesystem

GET /api/v2/metric/{device_id}/filesystem

Get return traffic info for the last day, week, month

Documentation
Sandbox

Documentation

Get filesystem_use, filesystem_avail info

Requirements

Name	Requirement	Type	Description
device_id		string	Device or group ID

Status Codes

Status Code	Description
200	Returned when successful
401	Returned when the user is not authenticated
403	Returned if access denied
404	Returned when resource not found
422	Returned if requested ID is group and it doesn't contain devices as children
500	Returned for internal server error

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/api/v2/metric/{node_id}

GET /api/v2/metric/{node_id}

Get metrics by type (cpu/mem/filesystem/load average) for the device or group

Documentation
Sandbox

Documentation

Get metrics by type (cpu/mem/filesystem/load average) for the device or group

Supported search fields:

start_date - Start date, format: YYYY-MM-DD hh:ii:ss (2021-03-18 10:35:48). Default 30 min from now. If timezone parameter is not specified UTC will be used
end_date - End date, format: YYYY-MM-DD hh:ii:ss (2021-03-18 10:35:48). Default now. If timezone parameter is not specified UTC will be used

Supported type fields:

cpu_user
cpu_system
cpu_iowait
filesystem_use
filesystem_avail
memory_swaputil
memory_memutil
memory_memfree
loadavg (load average 1mim, 5min, 15min)
network (rx per interface, tx per interface, total for all interfaces rx+tx)

NOTE: We output metrics results per device. This mean that classical offset and items_per_device works differently

offset parameter will be applied inside each device metric values. For example: if without offset you have 25 values for a host, you applied offset of 20 you will get only 5 values for that host.
items_per_device will be applied inside each device metric values limiting how many metrics results you get

NOTE: total shows how many results you can get for the time interval and grouping you specified. This mean that if you do not specify limit or offset the total will be equal to the result set

NOTE: network output is different compare to others. It contains results and totals per interface of the device

NOTE: you can get csv file by providing content-type: text/csv or by setting output parameter equal to csv

Requirements

Name	Requirement	Type	Description
node_id		string	Device or group ID
type		string	Measurement type, supported: cpu_user, cpu_system ... ^see description on top

Parameters

Parameter	Type	Required?	Description
timezone	string	false	Time zone. Default: UTC. Example: Europe/Oslo. Supported zones are: https://www.php.net/manual/en/timezones.php. Contact us if you can not find a time zone you are looking for
with_count	boolean	false	Return total available records withput limit and offset. This would make query slower. False by default
search	json	false	Search conditions. Supported fields: ^see description on top
group_by_time	integer	false	Group by time interval. ALL points for the start/end interval would be grouped into the time buckets. Supported minutes and hours. Format: Xm (20m), Xh (4h)
items_per_device	integer	false	Maximum number of records in single device result, default 1000, max 10000.
offset	integer	false	Offset in single device result. Default 0
output	string	false	Return result in json or csv. Default: json.

Status Codes

Status Code	Description
200	Returned when successful
401	Returned when the user is not authenticated
403	Returned if access denied
404	Returned when resource not found
422	Returned if requested ID is group and it doesn't contain devices as children
500	Returned for internal server error

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/api/v2/metric/{node_id}/conn/last

GET /api/v2/metric/{node_id}/conn/last

Get last connections

Documentation
Sandbox

Documentation

Get last connections

Requirements

Name	Requirement	Type	Description
node_id		string	Device or group ID

Status Codes

Status Code	Description
200	Returned when successful
400	Returned if required parameters are not set correctly
401	Returned when the user is not authenticated
403	Returned if access denied
500	Returned for internal server error

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/api/v2/metric/{node_id}/conn/outage

GET /api/v2/metric/{node_id}/conn/outage

Get maximum connection outages

Documentation
Sandbox

Documentation

Get maximum connection outages

Requirements

Name	Requirement	Type	Description
node_id		string	Device or group ID

Parameters

Parameter	Type	Required?	Format	Description
days	integer	false		number of days to check for outages

Status Codes

Status Code	Description
200	Returned when successful
400	Returned if required parameters are not set correctly
401	Returned when the user is not authenticated
403	Returned if access denied
500	Returned for internal server error

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/api/v2/metric/{node_id}/conn/overview

GET /api/v2/metric/{node_id}/conn/overview

Get connection overview

Documentation
Sandbox

Documentation

Get connection overview

Supported search fields:

start_date - Start date UTC, format: YYYY-MM-DD hh:ii:ss (2019-03-18 10:35:48). Default 60 min from end_date
end_date - End date UTC, format: YYYY-MM-DD hh:ii:ss (2019-03-18 10:35:48). Default now

Requirements

Name	Requirement	Type	Description
node_id		string	Device or group ID

Parameters

Parameter	Type	Required?	Format	Description
search	json	false		Search conditions. Supported fields: ^see description on top

Status Codes

Status Code	Description
200	Returned when successful
400	Returned if required parameters are not set correctly
401	Returned when the user is not authenticated
403	Returned if access denied
500	Returned for internal server error

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/api/v2/metric/{node_id}/conn/series

GET /api/v2/metric/{node_id}/conn/series

Get time series data for connection quality

Documentation
Sandbox

Documentation

Get time series for connection quality

Supported search fields:

start_date - Start date UTC, format: YYYY-MM-DD hh:ii:ss (2019-03-18 10:35:48). Default 60 min from end_date
end_date - End date UTC, format: YYYY-MM-DD hh:ii:ss (2019-03-18 10:35:48). Default now

Requirements

Name	Requirement	Type	Description
node_id		string	Device or group ID

Parameters

Parameter	Type	Required?	Format	Description
search	json	false		Search conditions. Supported fields: ^see description on top

Status Codes

Status Code	Description
200	Returned when successful
400	Returned if required parameters are not set correctly
401	Returned when the user is not authenticated
403	Returned if access denied
500	Returned for internal server error

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/api/v2/metric/{node_id}/conn/summary

GET /api/v2/metric/{node_id}/conn/summary

Get summary for network connectivity

Documentation
Sandbox

Documentation

Get summary for network connectivity

Requirements

Name	Requirement	Type	Description
node_id		string	Device or group ID

Status Codes

Status Code	Description
200	Returned when successful
400	Returned if required parameters are not set correctly
401	Returned when the user is not authenticated
403	Returned if access denied
500	Returned for internal server error

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/api/v2/metric/{node_id}/top

GET /api/v2/metric/{node_id}/top

Get top load for cpu/mem/filesystem for the device or group by period

Documentation
Sandbox

Documentation

Get top load for cpu/mem/filesystem for the device or group by period

Supported search fields:

start_date - Start date UTC, format: YYYY-MM-DD hh:ii:ss (2019-03-18 10:35:48). Default 30 min from now
end_date - End date UTC, format: YYYY-MM-DD hh:ii:ss (2019-03-18 10:35:48). Default now

NOTE: if only one device_id provided in array, we check if it is a group id, and in this case - we search withing a group.

Requirements

Name	Requirement	Type	Description
node_id		string	Device or group ID

Parameters

Parameter	Type	Required?	Format	Description
search	json	false		Search conditions. Supported fields: ^see description on top
limit	integer	false		Limit result number. Default: 5. Max allowed 1000

Status Codes

Status Code	Description
200	Returned when successful
401	Returned when the user is not authenticated
403	Returned if access denied
404	Returned when resource not found
422	Returned if requested ID is group and it doesn't contain devices as children
500	Returned for internal server error

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/api/v2/metric/{node_id}/topdetailed

GET /api/v2/metric/{node_id}/topdetailed

Get top load for cpu/mem/filesystem for the device or group by period detailed

Documentation
Sandbox

Documentation

Get top load for cpu/mem/filesystem for the devices inside the group.

Supported search fields:

start_date - Start date, format: YYYY-MM-DD hh:ii:ss (2021-03-18 10:35:48). Default 30 min from now. If timezone parameter is not specified UTC will be used
end_date - End date, format: YYYY-MM-DD hh:ii:ss (2021-03-18 10:35:48). Default now. If timezone parameter is not specified UTC will be used

NOTE: if only one device_id provided in array, we check if it is a group id, and in this case - we search withing a group.

Requirements

Name	Requirement	Type	Description
node_id		string	group ID

Parameters

Parameter	Type	Required?	Description
search	json	false	Search conditions. Supported fields: ^see description on top
limit	integer	false	Limit how many top devices would be selected. Default: 5. Max allowed 1000
group_by_time	integer	false	Group by time interval. ALL points for the start/end interval would be grouped into the time buckets. Supported minutes and hours. Format: Xm (20m), Xh (4h)
items_per_device	integer	false	Maximum number of records in single device result, default 1000, max 10000.
offset	integer	false	Offset in single device result. Default 0
output	string	false	Return result in json or csv. Default: json. NOTE. CSV supports only one metric is available
type	string	false	Measurement type - only for CSV, supported: cpu_user, cpu_system ... ^see description for Get metrics by type.
timezone	string	false	Time zone. Default: UTC. Example: Europe/Oslo. Supported zones are: https://www.php.net/manual/en/timezones.php. Contact us if you can not find a time zone you are looking for

Status Codes

Status Code	Description
200	Returned when successful
401	Returned when the user is not authenticated
403	Returned if access denied
404	Returned when resource not found
422	Returned if requested ID is group and it doesn't contain devices as children
500	Returned for internal server error

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/api/v2/metric/{node_id}/traffic

GET /api/v2/metric/{node_id}/traffic

Get return traffic info for the last day, week, month

Documentation
Sandbox

Documentation

Get traffic info for the last day, week, month

Requirements

Name	Requirement	Type	Description
node_id		string	Device or group ID

Parameters

Parameter	Type	Required?	Format	Description
timezone	string	false		Time zone. Default: UTC. Example: Europe/Oslo. Supported zones are: https://www.php.net/manual/en/timezones.php. Contact us if you can not find a time zone you are looking for

Status Codes

Status Code	Description
200	Returned when successful
401	Returned when the user is not authenticated
403	Returned if access denied
404	Returned when resource not found
422	Returned if requested ID is group and it doesn't contain devices as children
500	Returned for internal server error

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Node

/api/v2/node/{node_id}

GET /api/v2/node/{node_id}

Get info about the node. if id is device - return short device info, if group - reports group summary

Documentation
Sandbox

Documentation

Get info about the node. if id is device - return short device info, if group - reports group summary

Requirements

Name	Requirement	Type	Description
node_id		string	Device or group id

Status Codes

Status Code	Description
200	Returned when successful
401	Returned when the user is not authenticated
403	Returned if access denied
404	Returned when resource not found
500	Returned for internal server error

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Package

/api/v2/package/agent

GET /api/v2/package/agent

Get a list of packages. Return the last versions available for each package by default.

Documentation
Sandbox

Documentation

Get a 'list of packages. Return the last versions available for each package by default.

Supported search fields:

version - package version
package_title - qbee internal file name
package_name - file name
type - package type (agent or connect)

Status Codes

Status Code	Description
200	Returned when successful
401	Returned when the user is not authenticated
403	Returned if access denied
404	Returned when resource not found
500	Returned for internal server error

Input

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/api/v2/package/qbee-connect

GET /api/v2/package/qbee-connect

Get qbee-connect last version and download links.

Documentation
Sandbox

Documentation

Get qbee-connect last version and download links.

Status Codes

Status Code	Description
200	Returned when successful
401	Returned when the user is not authenticated
403	Returned if access denied
404	Returned when resource not found
500	Returned for internal server error

Input

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Pending hosts

/api/v2/pendinghost

GET /api/v2/pendinghost

Get pending hosts

Documentation
Sandbox

Documentation

Get pending hosts

Parameters

Parameter	Type	Required?	Description
pendingonly	boolean	false	If true - show only pending
limit	integer	false	Maximum number of records. Default: 1000. Maximum 10 000
offset	integer	false	Offset

Status Codes

Status Code	Description
204	Returned when successful
400	Returned if required parameters are not set correctly
401	Returned when the user is not authenticated
403	Returned if access denied
500	Returned for internal server error

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/v2/pendinghost

Approve host

Documentation
Sandbox

Documentation

Approve host

Parameters

Parameter	Type	Required?	Format	Description
node_id	string	true		device pub key

Status Codes

Status Code	Description
204	Returned when successful
400	Returned if required parameters are not set correctly
401	Returned when the user is not authenticated
403	Returned if access denied
500	Returned for internal server error

API documentation - qbee.io

Analysis

/api/v2/analysis

GET /api/v2/analysis

Documentation

Parameters

Status Codes

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/v2/analysis

Documentation

Parameters

Status Codes

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/api/v2/analysis/orgstats

GET /api/v2/analysis/orgstats

Documentation

Status Codes

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Authentication

/api/v2/challenge-get

POST /api/v2/challenge-get

Documentation

Parameters

Status Codes

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/api/v2/challenge-verify

POST /api/v2/challenge-verify

Documentation

Parameters

Status Codes

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/api/v2/login

POST /api/v2/login

Documentation

Parameters

Status Codes

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/api/v2/logout

GET /api/v2/logout

Documentation

Parameters

Status Codes

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/api/v2/refresh-jwt

POST /api/v2/refresh-jwt

Documentation