API docs by Redocly

qbee.io API (2.25.37)

Download OpenAPI specification:

qbee.io: support@qbee.io URL: https://qbee.io License: Apache 2.0

This is the API description for the Qbee API.

Account

Organization-wide account settings.

Get company information

Get company information - requires permission company:read

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "company": {
    },
  • "status": "string"
}

Update company information

Update company information - requires permission company:manage

Authorizations:
Bearer
Request Body schema: application/json
required

Company update request

auth_methods
Array of strings
Items Enum: "password" "password-email" "password-totp" "oauth2-google" "oauth2-microsoft" "oauth2-github" "saml2"

auth_methods is the list of authentication methods enabled for the account.

contact_email
string

ContactEmail contains email of the contact person.

contact_person
string

ContactPerson contains name of the person to contact regarding technical and billing inquires.

name
string

Name of the company.

Responses

Request samples

Content type
application/json
{
  • "auth_methods": [
    ],
  • "contact_email": "string",
  • "contact_person": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "company": {
    },
  • "status": "string"
}

Update company information

Update company information - requires permission company:manage

Authorizations:
Bearer
Request Body schema: application/json
required

Company update request

auth_methods
Array of strings
Items Enum: "password" "password-email" "password-totp" "oauth2-google" "oauth2-microsoft" "oauth2-github" "saml2"

auth_methods is the list of authentication methods enabled for the account.

contact_email
string

ContactEmail contains email of the contact person.

contact_person
string

ContactPerson contains name of the person to contact regarding technical and billing inquires.

name
string

Name of the company.

Responses

Request samples

Content type
application/json
{
  • "auth_methods": [
    ],
  • "contact_email": "string",
  • "contact_person": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "company": {
    },
  • "status": "string"
}

Authentication & Tokens

Authentication endpoints for login, token refresh, and 2FA challenges.

Get MFA challenge

Get MFA challenge

Request Body schema: application/json
required

MFA Challenge Request

challenge
string

The challenge to be solved

preferProvider
string

Preferred MFA provider (e.g., "totp", "email", etc.)

Responses

Request samples

Content type
application/json
{
  • "challenge": "string",
  • "preferProvider": "string"
}

Response samples

Content type
application/json
{
  • "availableTwoFactorProviders": [
    ],
  • "challenge": "string",
  • "twoFactorProvider": "string"
}

Complete MFA challenge

Complete MFA challenge

Request Body schema: application/json
required

MFA Challenge Completion Request

challenge
string

The challenge to be solved

code
string

The code provided by the user

Responses

Request samples

Content type
application/json
{
  • "challenge": "string",
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "token": "string"
}

Logs user into the system

Logs user into the system

Authorizations:
Bearer
Request Body schema: application/json
required

Login request

email
string

The email of the user

password
string

The password of the user

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "token": "string"
}

Logs user out of the system

Logs user out of the system

Responses

Refresh JWT token

Refresh JWT

Authorizations:
Bearer
cookie Parameters
PHPSESSID
required
string

the user session cookie

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Identity and Access Management

Management of users, roles, and permissions across the account.

Creates a new role

Creates a new role - requires permission roles:manage

Authorizations:
Bearer
Request Body schema: application/json
required
name
required
string [ 1 .. 64 ] characters

Name is the name of the role.

description
string <= 255 characters

Description is the optional description of the role.

required
Array of objects (RolePolicy) non-empty

Policies is the list of policies that are assigned to this role.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "policies": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "policies": [
    ],
  • "created_at": 0,
  • "created_by": {
    },
  • "updated_at": 0,
  • "updated_by": {
    },
  • "used_by": [
    ]
}

Gets an existing role

Gets an existing role - requires permission roles:read

Authorizations:
Bearer
path Parameters
roleID
required
string <uuid>

Role ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "policies": [
    ],
  • "created_at": 0,
  • "created_by": {
    },
  • "updated_at": 0,
  • "updated_by": {
    },
  • "used_by": [
    ]
}

Updates an existing role

Updates an existing role - requires permission roles:manage

Authorizations:
Bearer
path Parameters
roleID
required
string

Role ID

Request Body schema: application/json
required
name
required
string [ 1 .. 64 ] characters

Name is the name of the role.

description
string <= 255 characters

Description is the optional description of the role.

required
Array of objects (RolePolicy) non-empty

Policies is the list of policies that are assigned to this role.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "policies": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "policies": [
    ],
  • "created_at": 0,
  • "created_by": {
    },
  • "updated_at": 0,
  • "updated_by": {
    },
  • "used_by": [
    ]
}

Deletes an existing role

Deletes an existing role - requires permission roles:manage

Authorizations:
Bearer
path Parameters
roleID
required
string

Role ID

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Lists all roles

Lists all roles - requires permission roles:read

Authorizations:
Bearer
query Parameters
search
string
Example: search={"name":"admin","description":"ops"}

JSON-encoded search filter. Example: {"name":"admin","description":"ops"}. Only name and description are supported. Values must be strings. Validation rules: name <= 64 chars, description <= 255 chars.

items_per_page
integer [ 1 .. 1000 ]
Example: items_per_page=10

Number of items per page.

offset
integer >= 0

Offset for pagination.

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "total": 0,
  • "items": [
    ]
}

creates a new user in the account

Creates a new user in the account - requires permission users:manage

Authorizations:
Bearer
Request Body schema: application/json
required

user data

auth_methods
Array of strings
Items Enum: "password" "password-email" "password-totp" "oauth2-google" "oauth2-microsoft" "oauth2-github" "saml2"

auth_methods is the list of authentication methods enabled for the user. If set to non-empty value, overrides company-wide authentication methods.

email
string
enabled
boolean
fname
string
lname
string
roles
Array of strings

Responses

Request samples

Content type
application/json
{
  • "auth_methods": [
    ],
  • "email": "string",
  • "enabled": true,
  • "fname": "string",
  • "lname": "string",
  • "roles": [
    ]
}

Response samples

Content type
application/json
{
  • "qr": "string",
  • "status": "string",
  • "user": {
    }
}

Retrieves user information for a specific user

Retrieves user information for a specific user - requires permission users:read

Authorizations:
Bearer
path Parameters
userID
required
string

User ID

query Parameters
company
string
Default: "false"
Enum: "true" "false"

include company information

roles
string
Default: "false"
Enum: "true" "false"

include roles information

Responses

Response samples

Content type
application/json
{
  • "qr": "string",
  • "status": "string",
  • "user": {
    }
}

Deletes a user from an account

Deletes a user from an account - requires permission users:manage

Authorizations:
Bearer
path Parameters
userID
required
string

User ID

Responses

Response samples

Content type
application/json
{
  • "qr": "string",
  • "status": "string",
  • "user": {
    }
}

Updates the user in its account

Updates the user in its account - requires permission users:manage

Authorizations:
Bearer
path Parameters
userID
required
string

User ID

Request Body schema: application/json
required

user data

auth_methods
Array of strings
Items Enum: "password" "password-email" "password-totp" "oauth2-google" "oauth2-microsoft" "oauth2-github" "saml2"

auth_methods is the list of authentication methods enabled for the user. If set to non-empty value, overrides company-wide authentication methods.

enabled
boolean

following fields can be only update by the account admin

fname
string

following fields can be update by either the user itself or the account admin

hostname
string
Enum: "fqhost" "device_name"

following fields can be only updated by the user itself

lname
string
new_password
string
old_password
string
roles
Array of strings

Responses

Request samples

Content type
application/json
{
  • "auth_methods": [
    ],
  • "enabled": true,
  • "fname": "string",
  • "hostname": "fqhost",
  • "lname": "string",
  • "new_password": "string",
  • "old_password": "string",
  • "roles": [
    ]
}

Response samples

Content type
application/json
{
  • "qr": "string",
  • "status": "string",
  • "user": {
    }
}

retrieves a list of all users in the account

retrieves a list of all users in the account - requires permission users:read

Authorizations:
Bearer
query Parameters
items_per_page
integer >= 1
Default: 10

Number of items per page

offset
integer >= 0
Default: 0

Offset for pagination

sort_direction
string
Default: "asc"
Enum: "asc" "desc"

Sort direction

sort
string
Default: "fname"
Enum: "fname" "lname" "email"

Sort by field

search
string

Search term

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "status": "string",
  • "total": 0
}

User Profile

Endpoints for managing an individual user's profile and notification preferences.

Retrieves the current user notifications mode

Retrieves the current user notifications mode

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "enabled": true,
  • "labels": [
    ],
  • "severity": "INFO"
}

Updates the current user notifications mode

Updates the current user notifications mode

Authorizations:
Bearer
Request Body schema: application/json
required

Subscription

enabled
boolean

Enabled is true if the subscription is enabled.

labels
Array of strings (ReportLabel)
Items Enum: "heartbeat" "settings" "users" "sshkeys" "package_management" "file_distribution" "connectivity_watchdog" "metrics_monitor" "proc_watch" "ntp" "parameters" "software_management" "docker_containers" "podman_containers" "docker_compose" "password" "firewall" "rauc"

Labels is the list of labels the subscription is interested in. If the list is empty, the subscription is interested in all labels.

severity
string
Enum: "INFO" "ERR" "WARN" "CRIT"

Severity is the severity of the subscription (INFO < WARN < ERR < CRIT). Subscriber will receive reports with severity equal or higher than the subscription severity.

Responses

Request samples

Content type
application/json
{
  • "enabled": true,
  • "labels": [
    ],
  • "severity": "INFO"
}

Response samples

Content type
application/json
{
  • "enabled": true,
  • "labels": [
    ],
  • "severity": "INFO"
}

Retrieves user information for currently authenticated user

Authorizations:
Bearer
query Parameters
company
string
Default: "false"
Enum: "true" "false"

include company information

roles
string
Default: "false"
Enum: "true" "false"

include roles information

qr-code
string
Default: "false"
Enum: "true" "false"

include QR code for Google Authenticator setup if available

Responses

Response samples

Content type
application/json
{
  • "qr": "string",
  • "status": "string",
  • "user": {
    }
}

Updates the profile of the currently authenticated user

updates the profile of the currently authenticated user

Authorizations:
Bearer
Request Body schema: application/json
required

user data

auth_methods
Array of strings
Items Enum: "password" "password-email" "password-totp" "oauth2-google" "oauth2-microsoft" "oauth2-github" "saml2"

auth_methods is the list of authentication methods enabled for the user. If set to non-empty value, overrides company-wide authentication methods.

enabled
boolean

following fields can be only update by the account admin

fname
string

following fields can be update by either the user itself or the account admin

hostname
string
Enum: "fqhost" "device_name"

following fields can be only updated by the user itself

lname
string
new_password
string
old_password
string
roles
Array of strings

Responses

Request samples

Content type
application/json
{
  • "auth_methods": [
    ],
  • "enabled": true,
  • "fname": "string",
  • "hostname": "fqhost",
  • "lname": "string",
  • "new_password": "string",
  • "old_password": "string",
  • "roles": [
    ]
}

Response samples

Content type
application/json
{
  • "qr": "string",
  • "status": "string",
  • "user": {
    }
}

lists OAuth2 providers for the user

retrieves a list of OAuth2 providers for the user

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • "string"
]

unlinks an OAuth2 provider from the user

unlinks an OAuth2 provider from the user

Authorizations:
Bearer
path Parameters
provider
required
string

Provider ID

Responses

Response samples

Content type
application/json
[
  • "string"
]

Activates TOTP 2FA on the user account

Authorizations:
Bearer
Request Body schema: application/json
required

TOTP payload

code
string

Responses

Request samples

Content type
application/json
{
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Bootstrap Keys

Management of bootstrap keys used to securely onboard new devices into the fleet.

Generate a bootstrap key

Generate a new bootstrap key - requires permission bootstrap-keys:manage

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Get a bootstrap key

Get a bootstrap key - requires permission bootstrap-keys:read

Authorizations:
Bearer
path Parameters
keyID
required
string

Bootstrap key ID

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Update a bootstrap key

Update a bootstrap key - requires permission bootstrap-keys:manage

Authorizations:
Bearer
path Parameters
keyID
required
string

Bootstrap key ID

Request Body schema: application/json
required

Bootstrap key details

auto_accept
boolean

AutoAccept defines whether devices should be auto-accepted during bootstrap.

group_id
string

GroupID where devices will be assigned during bootstrap process.

owner
string

Creator of the key.

timestamp
integer

Timestamp in nanoseconds when key was created.

Responses

Request samples

Content type
application/json
{
  • "auto_accept": true,
  • "group_id": "string",
  • "owner": "string",
  • "timestamp": 0
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Delete a bootstrap key

Delete a bootstrap key - requires permission bootstrap-keys:manage

Authorizations:
Bearer
path Parameters
keyID
required
string

Bootstrap key ID

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get details of all bootstrapkeys

Get details of all bootstrapkeys - requires permission bootstrap-keys:read

Authorizations:
Bearer
header Parameters
Authorization
required
string

Authorization

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Devices

Device fleet management, including analysis, inventory, details, metrics, and approval of pending hosts.

Perform analysis on devices

Perform analysis on devices - requires analysis:read permission

Authorizations:
Bearer
Request Body schema: application/json
required

Analysis Request

items_per_page
integer

ItemsPerPage defines maximum number of records in result, default 30, max 1000

offset
integer

Offset defines offset of the first record in result, default 0

object

Search defines search parameters for analysis.

sort_direction
string

SortDirection defines sort direction, 'desc' by default.

sort_field
string

SortField defines field used to sort, 'title' by default. For supported sort fields, see analysisSortFields.

type
string
Enum: "device" "health" "software" "users" "ports" "docker"

Type defines analysis type.

Responses

Request samples

Content type
application/json
{
  • "items_per_page": 0,
  • "offset": 0,
  • "search": {
    },
  • "sort_direction": "string",
  • "sort_field": "string",
  • "type": "device"
}

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0
}

Perform metrics analysis on devices

Perform metrics analysis on devices - requires analysis:read or device:read permission

Authorizations:
BearerBearer
Request Body schema: application/json
required

Analysis Request

items_per_page
integer

ItemsPerPage defines maximum number of records in result, default 30, max 1000

offset
integer

Offset defines offset of the first record in result, default 0

object

Search defines search parameters for analysis.

sort_direction
string

SortDirection defines sort direction, 'desc' by default.

sort_field
string

SortField defines field used to sort, 'title' by default. For supported sort fields, see analysisSortFields.

type
string
Value: "metrics"

Type defines analysis type.

Responses

Request samples

Content type
application/json
{
  • "items_per_page": 0,
  • "offset": 0,
  • "search": {
    },
  • "sort_direction": "string",
  • "sort_field": "string",
  • "type": "metrics"
}

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0
}

Get device inventory

Get device inventory - requires permission device:read

Authorizations:
Bearer
path Parameters
deviceID
required
string

Device ID

type
required
string
Enum: "system" "ports" "users" "software" "processes" "docker_containers" "docker_images" "docker_volumes" "docker_networks" "podman_containers" "podman_images" "podman_volumes" "podman_networks" "rauc"

Inventory Type

Responses

Response samples

Content type
application/json
{ }

Get latest device metrics

Get latest device metrics - requires permission device:read

Authorizations:
Bearer
path Parameters
deviceID
required
string

Device ID

Responses

Response samples

Content type
application/json
{
  • "cpu": {
    },
  • "filesystem": {
    },
  • "load": {
    },
  • "memory": {
    }
}

Device attributes

Get device attributes - requires permission device:read

Authorizations:
Bearer
path Parameters
deviceID
required
string

Device ID

Responses

Response samples

Content type
application/json
{
  • "address": "string",
  • "city": "string",
  • "country": "string",
  • "description": "string",
  • "device_name": "string",
  • "discovered_address": "string",
  • "discovered_by_post_address_latitude": "string",
  • "discovered_by_post_address_longitude": "string",
  • "discovered_city": "string",
  • "discovered_country": "string",
  • "discovered_latitude": "string",
  • "discovered_longitude": "string",
  • "discovered_zip": "string",
  • "latitude": "string",
  • "longitude": "string",
  • "pub_key_digest": "string",
  • "updated_auto": 0,
  • "updated_user": 0,
  • "zip": "string"
}

Update device attributes

Update device attributes - requires permission device:manage

Authorizations:
Bearer
path Parameters
deviceID
required
string

Device ID

header Parameters
Authorization
required
string

Authorization

Request Body schema: application/json
required

Device attributes

address
string
city
string
country
string
description
string
device_name
string
latitude
string
longitude
string
zip
string

Responses

Request samples

Content type
application/json
{
  • "address": "string",
  • "city": "string",
  • "country": "string",
  • "description": "string",
  • "device_name": "string",
  • "latitude": "string",
  • "longitude": "string",
  • "zip": "string"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Searches device inventories

Searches device inventories - requires permission device:read

Authorizations:
Bearer
query Parameters
itemsPerPage
integer

ItemsPerPage defines maximum number of records in result, default 30, max 1000

offset
integer

Offset defines offset of the first record in result, default 0

reportType
string
Enum: "detailed" "short"

ReportType defines report type, 'detailed' by default. 'detailed' includes config history.

sortDirection
string

SortDirection defines sort direction, 'desc' by default.

sortField
string

SortField defines field used to sort, 'created' by default. Supported sort fields:

  • title (fqhost or remoteaddr - depending on what is available)
  • device_name (from attribute)
  • exp_hard (sort by heartbeat expiration time)
  • last_reported_time (soft by last heartbeat timestamp)
  • last_policy_update
  • commit_sha
object (InventoryListSearch)

Search term

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0
}

Online/offline stats for devices Deprecated

Online/offline stats for devices

Authorizations:
Bearer

Summary report by inventory property type Deprecated

Summary report by inventory property type

Authorizations:
Bearer
path Parameters
nodeID
required
string

Node ID

Get device inventory report docker Deprecated

Get device inventory report docker

Authorizations:
Bearer
path Parameters
deviceID
required
string

Device ID

Gets a device inventory

Gets a device inventory - requires permission device:read

Authorizations:
Bearer
path Parameters
deviceAttribute
required
string
Enum: "device_name" "uuid" "pub_key_digest"

Device Attribute

deviceValue
required
string

Device Value

Responses

Response samples

Content type
application/json
{
  • "agentinterval": "string",
  • "ancestors": [
    ],
  • "ancestors_titles": [
    ],
  • "attributes": {
    },
  • "config_status": "",
  • "exp_hard": 0,
  • "exp_soft": 0,
  • "last_reported_time": 0,
  • "node_id": "string",
  • "pub_key_digest": "string",
  • "status": "string",
  • "system": {
    },
  • "tags": [
    ],
  • "title": "string",
  • "uuid": "string"
}

Get device inventory

Get device inventory - requires permission device:read

Authorizations:
Bearer
path Parameters
deviceID
required
string

Device ID

Responses

Response samples

Content type
application/json
{ }

Delete a device

Delete a device - requires permission device:manage

Authorizations:
Bearer
path Parameters
deviceID
required
string

Device ID

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

List pending hosts

List pending hosts - requires permission device:approve

Authorizations:
Bearer
query Parameters
pendingonly
string
Value: "1"

Pending Only

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Approve a pending host

Approve a pending host - requires permission device:approve

Authorizations:
Bearer
Request Body schema: application/json
required

Approve Pending Host Request

node_id
string

Responses

Request samples

Content type
application/json
{
  • "node_id": "string"
}

Reject a pending host

Reject a pending host - requires permission device:approve

Authorizations:
Bearer
path Parameters
deviceID
required
string

Device ID

Responses

Remove an approved host

Remove an already approved host - requires permission device:approve

Authorizations:
Bearer
path Parameters
deviceID
required
string

Device ID

Responses

Groups

Management of the hierarchical device group tree, including group creation, deletion, and navigation.

Lists all group nodes

Lists all group nodes - requires permission device:read

Authorizations:
Bearer
query Parameters
object (GroupListSearch)

Search term

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieves the group tree

Retrieves the group tree - requires permission device:read

Authorizations:
Bearer
query Parameters
skip_unassigned
boolean
Default: true

Skip unassigned nodes

Responses

Response samples

Content type
application/json
{
  • "total_devices": 0,
  • "tree": {
    }
}

Updates the group tree

Updates the group tree - requires permission device:manage

Authorizations:
Bearer
Request Body schema: application/json
required

Group tree update request

Array of objects (GroupTreeChange)

Responses

Request samples

Content type
application/json
{
  • "changes": [
    ]
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Retrieves a node from the group tree

Retrieves a node from the group tree - requires permission device:read

Authorizations:
Bearer
path Parameters
nodeID
required
string

Node ID

Responses

Response samples

Content type
application/json
{
  • "agentinterval": 0,
  • "ancestors": [
    ],
  • "attributes": {
    },
  • "config_propagated": true,
  • "device_commit_sha": "string",
  • "last_reported": 0,
  • "node_id": "string",
  • "nodes": [
    ],
  • "pub_key_digest": "string",
  • "pushed_config": {
    },
  • "settings": {
    },
  • "status": "string",
  • "system": {
    },
  • "tags": [
    ],
  • "title": "string",
  • "type": "device",
  • "uuid": "string"
}

Sets tags on a group node

Sets tags on a group node - requires permission device:manage

Authorizations:
Bearer
path Parameters
nodeID
required
string

Node ID

Request Body schema: application/json
required

Group tree set tags request

tags
Array of strings

Responses

Request samples

Content type
application/json
{
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Tags

Management of tags and their assignment to devices for flexible fleet organization.

List all tags

Returns a list of all tags used in the system - requires permission device:read

Authorizations:
Bearer
query Parameters
scope
string
Default: "all"
Enum: "all" "config" "nodes"

scope of the tags

format
string
Default: "simple"
Enum: "simple" "summary"

format of the response

Responses

Response samples

Content type
application/json
Example
[ ]

Configuration

Management and audit of configuration policies, commits, and changes applied to devices.

Create a new configuration change

Create a new configuration change - required permission configuration:manage

Authorizations:
Bearer
Request Body schema: application/json
required

Change

ConfigSettingsRequest (object) or ConfigUsersRequest (object) or ConfigSSHKeysRequest (object) or ConfigPackageManagementRequest (object) or ConfigFileDistributionRequest (object) or ConfigMetricsMonitorRequest (object) or ConfigProcWatchRequest (object) or ConfigNTPRequest (object) or ConfigParameters (object) or ConfigSoftwareManagement (object) or ConfigDockerContainersRequest (object) or ConfigPodmanContainersRequest (object) or ConfigDockerComposeRequest (object) or ConfigPasswordRequest (object) or ConfigFirewallRequest (object) or ConfigRaucRequest (object)

the configuration payload

extend
boolean

whether or not do extend parent configuration

formtype
string (FormType)
Enum: "settings" "users" "sshkeys" "package_management" "file_distribution" "connectivity_watchdog" "metrics_monitor" "proc_watch" "ntp" "parameters" "software_management" "docker_containers" "podman_containers" "docker_compose" "password" "firewall" "rauc"

the configuration type label

node_id
string

the node id the change is for (device id or group id)

tag
string

the tag the change is for

Responses

Request samples

Content type
application/json
{
  • "config": {
    },
  • "extend": true,
  • "formtype": "settings",
  • "node_id": "string",
  • "tag": "string"
}

Response samples

Content type
application/json
{
  • "content": null,
  • "created": 0,
  • "id": "string",
  • "node": {
    },
  • "sha": "string",
  • "status": "new",
  • "type": "string",
  • "updated": 0,
  • "user": {
    },
  • "user_id": "string",
  • "user_name": "string"
}

Get uncommitted change

Get an uncommitted change by its SHA - required permission configuration:read

Authorizations:
Bearer
path Parameters
sha
required
string

Change SHA

Responses

Response samples

Content type
application/json
{
  • "content": null,
  • "created": 0,
  • "id": "string",
  • "node": {
    },
  • "sha": "string",
  • "status": "new",
  • "type": "string",
  • "updated": 0,
  • "user": {
    },
  • "user_id": "string",
  • "user_name": "string"
}

Delete uncommitted change

Delete a specific uncommitted change by its SHA - required permission configuration:read

Authorizations:
Bearer
path Parameters
sha
required
string

Change SHA

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

List uncommitted changes

List all uncommitted changes - required permission configuration:read

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete all uncommitted changes

Delete all uncommitted changes - required permission configuration:manage

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Commit changes

Commits provided configuration changes. If not changes are provided, it will commit all uncommitted changes. Requires permissionconfiguration:manage

Authorizations:
Bearer
Request Body schema: application/json
required

Commit request

action
string
message
string
Array of objects (DeviceChange)

Responses

Request samples

Content type
application/json
{
  • "action": "string",
  • "message": "string",
  • "changes": [
    ]
}

Response samples

Content type
application/json
{
  • "changes": [
    ],
  • "created": 0,
  • "labels": [
    ],
  • "message": "string",
  • "sha": "string",
  • "tags": [
    ],
  • "type": "string",
  • "updated": 0,
  • "user": {
    },
  • "user_id": "string"
}

Get commit

Retrieves a specific commit by SHA - requires permission configuration:read

Authorizations:
Bearer
path Parameters
sha
required
string

Commit SHA

Responses

Response samples

Content type
application/json
{
  • "changes": [
    ],
  • "created": 0,
  • "labels": [
    ],
  • "message": "string",
  • "sha": "string",
  • "tags": [
    ],
  • "type": "string",
  • "updated": 0,
  • "user": {
    },
  • "user_id": "string"
}

List commits

Retrieves a list of commits - requires permission configuration:read

Authorizations:
Bearer
query Parameters
limit
integer

Limit defines maximum number of records in result, default 30, max 1000

offset
integer

Offset defines offset of the first record in result, default 0

sort
string

SortField defines field used to sort, 'created' by default. Supported sort fields:

  • user_id
  • type
  • message
  • created
sortDirection
string

SortDirection defines sort direction, 'desc' by default.

object (CommitListSearch)

Search term

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0
}

Get configuration

Get configuration for a specific entity - requires permission configuration:read

Authorizations:
Bearer
path Parameters
id
required
string

Entity ID

query Parameters
scope
string

Config scope

Responses

Response samples

Content type
application/json
{
  • "config": {
    },
  • "status": "string"
}

Get configuration

Get configuration for a specific entity - requires permission configuration:read

Authorizations:
Bearer
path Parameters
id
required
string

Entity ID

type
required
string

Entity type

query Parameters
scope
string

Config scope

Responses

Response samples

Content type
application/json
{
  • "config": {
    },
  • "status": "string"
}

Get configuration

Get configuration for a specific entity - requires permission configuration:read

Authorizations:
Bearer
path Parameters
id
required
string

Entity ID

query Parameters
scope
string

Config scope

Responses

Response samples

Content type
application/json
{
  • "config": {
    },
  • "status": "string"
}

Get configuration

Get configuration for a specific entity - requires permission configuration:read

Authorizations:
Bearer
path Parameters
id
required
string

Entity ID

type
required
string

Entity type

query Parameters
scope
string

Config scope

Responses

Response samples

Content type
application/json
{
  • "config": {
    },
  • "status": "string"
}

Files

Management of files, artifacts, and binaries available to devices in the fleet.

Downloads a file

Downloads a file - requires permission files:read

Authorizations:
Bearer
query Parameters
path
required
string

Path to the file

header Parameters
Range
string

Range of bytes to download

Responses

Uploads a file

Uploads a file - requires permission files:manage

Authorizations:
Bearer
Request Body schema: multipart/form-data
file
required
string <binary>

File to upload

path
string

Path where the file will be stored

replace
boolean

Whether to replace the file if it exists

Responses

Response samples

Content type
application/json
{
  • "file": "string",
  • "path": "string"
}

Deletes a file

Deletes a file - requires permission files:manage

Authorizations:
Bearer
Request Body schema: application/json
required

File delete request

path
string

Responses

Request samples

Content type
application/json
{
  • "path": "string"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Renames a file

Renames a file - requires permission files:manage

Authorizations:
Bearer
Request Body schema: application/json
required

File rename request

name
string

New name of the file.

newpath
string

NewPath of the file.

path
string

Path to the file to rename.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "newpath": "string",
  • "path": "string"
}

Response samples

Content type
application/json
{
  • "dir": "string",
  • "path": "string"
}

Creates a directory

Creates a directory - requires permission files:manage

Authorizations:
Bearer
Request Body schema: application/json
required

Create directory request

name
string

Name of the new directory.

path
string

Path where the directory will be created.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "path": "string"
}

Response samples

Content type
application/json
{
  • "dir": "string",
  • "path": "string"
}

Retrieves file metadata

Retrieves file metadata - requires permission files:read

Authorizations:
Bearer
query Parameters
path
required
string

File path

Responses

Response samples

Content type
application/json
{
  • "created": 0,
  • "digest": "string",
  • "extension": "string",
  • "is_dir": true,
  • "mime": "string",
  • "name": "string",
  • "path": "string",
  • "size": 0,
  • "user": {
    }
}

Retrieves file related statistics.

Retrieves file related statistics - requires permission files:read

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "count_files": 0,
  • "quota": 0,
  • "used": 0
}

Lists files and directories

Lists files and directories - requires permission files:read

Authorizations:
Bearer
query Parameters
items_per_page
integer

ItemsPerPage defines maximum number of records in result, default 50, max 1000

offset
integer

Offset defines offset of the first record in result, default 0

path
string

Path defines path to the directory to list files in. If path is empty and: - search is empty - show files from the root directory

  • search is not empty - search in ALL files Else, if path is not empty and:
    • search is empty - show files from that directory
  • search is not empty - search in that directory only
sort_direction
string

SortDirection defines sort direction, 'asc' by default.

sort_field
string

SortField defines field used to sort, 'name' by default. Supported sort fields:

  • name
  • size
  • extension
  • created
object (FileManagerListSearch)

Search term

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0
}

Remote Access

Management of remote access sessions, tunnels, and secure connections to devices.

Run agent

Trigger the agent to run on the device - requires permission remote-access:connect

Authorizations:
Bearer
path Parameters
deviceID
required
string

Device ID

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get device status

Get device status - requires permission device:read or remote-access:connect

Authorizations:
BearerBearer
path Parameters
deviceID
required
string

Device ID

Responses

Response samples

Content type
application/json
{
  • "edge": "string",
  • "edge_version": 0,
  • "remote_access": true,
  • "uuid": "string"
}

Generate a remote console token

Generate a remote console token - requires permission remote-access:connect

Authorizations:
Bearer
path Parameters
deviceID
required
string

Device ID

query Parameters
username
required
string

User Name

app_name
required
string

App Name

ports
string

Ports

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Reports

Access to device reports, including logs, audit data, and configuration application results.

Get report summary for a group Deprecated

Get report summary for a group

Authorizations:
Bearer
path Parameters
groupID
required
string

Group ID

Search reports

Search reports - requires permission reports:read

Authorizations:
Bearer
query Parameters
groupMode
boolean

GroupMode groups similar items (deduplication), default false.

itemsPerPage
integer

ItemsPerPage defines maximum number of records in result, default 30, max 1000

offset
integer

Offset defines offset of the first record in result, default 0

sortDirection
string

SortDirection defines sort direction, 'desc' by default.

sortField
string

SortField defines field used to sort, 'ts' by default. Supported sort fields:

  • title - host title (alphabetical)
  • device_name - device name with fallback to host title (alphabetical)
  • pub_key_digest (alphabetical)
  • severity (alphabetical)
  • labels (alphabetical)
  • ts (integer)
  • reports_count (integer, only in group_mode=true)
  • bundle_commit_id (alphabetical)
object (ReportListSearch)

Search term

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0
}

Mark reports as read

Mark reports as read - requires permission reports:acknowledge

Authorizations:
Bearer
Request Body schema: application/json
required

List of report IDs or group hashes to mark as read

ids
Array of strings <= 1000 items [ items^[a-fA-F0-9]{24}$ ]

List of specific report IDs to mark as read.

group_hashes
Array of strings <= 1000 items [ items^-?[0-9]+$ ]

List of Group Hashes (group_hash) to mark as read.

start_ts
integer <int64>

Optional start timestamp (Unix). Note: Must be paired with end_ts. Only reports with ts >= start_ts will be marked.

end_ts
integer <int64>

Optional end timestamp (Unix). Note: Must be paired with start_ts. Only reports with ts <= end_ts will be marked.

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ],
  • "group_hashes": [
    ],
  • "start_ts": 0,
  • "end_ts": 0
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

CVE (Vulnerabilities)

Retrieval and management of CVE vulnerability findings and their statuses for devices.

Retrieves a single CVE for the organization

Retrieves a single CVE for the organization - requires permission cve:read or device:read

Authorizations:
BearerBearer
path Parameters
id
required
string

CVE ID

Responses

Response samples

Content type
application/json
{
  • "affected_hosts": [
    ],
  • "cve": {
    },
  • "total_affected_hosts": 0,
  • "total_hosts_registered": 0
}

Deletes a single CVE for the organization

Deletes a single CVE for the organization - requires permission cve:manage

Authorizations:
Bearer
path Parameters
id
required
string

CVE ID

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Disable or enable a CVE for the organization

Disable or enable a CVE for the organization - requires permission cve:manage

Authorizations:
Bearer
path Parameters
id
required
string

CVE ID

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Retrieves a list of CVE for the organization

Retrieves a list of CVE for the organization - requires permission cve:read

Authorizations:
Bearer
query Parameters
itemsPerPage
integer

ItemsPerPage defines maximum number of items in the result, default 30, max 1000

offset
integer

Offset defines offset of the first record in result, default 0

sort
string
Enum: "cve_id" "package" "score" "updated" "disabled"

SortField defines field used to sort, 'created' by default. Supported sort fields:

  • cve_id - (alphabetical)
  • package - (alphabetical)
  • score - numeric
  • updated - date
  • disabled - boolean
sortDirection
string

SortDirection defines sort direction, 'desc' by default.

object (CVEListSearch)

Search term

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0
}