Devices

Get Devices

GET

https://api.securithings.com

/v1/devices

Returns one or more devices user has access to.

Some fields are applicable only to devices with specific capabilities.

Results can be filtered using the query parameters specified below.

Returns 200 with empty devices list and a total of 0 when no devices found.

Get Devices › query Parameters

limit

integer · min: 1 · max: 1000

The number of items to return, default is 100 and maximum is 1000.

Default: 100

offset

integer · min: 0

The number of items to skip before starting to collect the result set.

Default: 0

status

string · enum

The status of the device.

Enum values:

online

offline

partial

unknown

probe.agent

string · enum

Agent probe status.

Enum values:

down

unknown

unmonitored

probe.deviceSource

string · enum

Management Server probe status.

Enum values:

down

unknown

unmonitored

probe.edge

string · enum

Edge probe status.

Enum values:

down

unknown

unmonitored

probe.host

string · enum

Host probe status.

Enum values:

down

unknown

unmonitored

probe.app

string · enum

App probe status.

Enum values:

down

unknown

unmonitored

isFirmwareVulnerable

boolean

Is the firmware version vulnerable.

isFirmwareLatest

boolean

Is the current firmware version is the latest available.

isFirmwareUpgradeAvailable

boolean

Is there a newer firmware version available.

lifeCycleStatus

string · enum

End of support status.

Enum values:

current_product

eol

eos

unknown

onboardedAfter

string · date-time

Filter devices onboarded after the specified date, in ISO 8601 format.

onboardedBefore

string · date-time

Filter devices onboarded before the specified date, in ISO 8601 format.

maintenanceMode

boolean

Filter devices by maintenance mode.

hardenedAfter

string · date-time

Filter devices last hardened after the specified date, in ISO 8601 format.

hardenedBefore

string · date-time

Filter devices last hardened before the specified date, in ISO 8601 format.

recordingStatus

string · enum

Filter devices by recording status.

Enum values:

recording

notRecording

error

unknown

storageServer

string

Filter devices by storage server.

compliance.firmware.patchedVersion

string

Filter devices by available firmware patch version.

isOrphaned

boolean

Filter devices by whether they no longer exist in the management platform.

Get Devices › Responses

A list of device objects.

DeviceInfo[]

A list of device objects.

total

integer

The total number of devices matching the query.

GET/v1/devices

curl https://api.securithings.com/v1/devices \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "devices": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Headquarters camera1",
      "vendor": "Axis",
      "model": "P3225-LVE",
      "firmwareVersion": "9.80.1",
      "deviceType": "camera",
      "availableTask": {
        "hardenDevice": true,
        "restartDevice": true,
        "rotate8021xCertificate": false,
        "rotatePassword": true,
        "rotateSslCertificate": true,
        "upgradeFirmware": true
      },
      "compliance": {
        "vulnerability": {
          "isFirmwareVulnerable": true
        },
        "firmware": {
          "isUpgradeAvailable": true,
          "isLatest": false,
          "patchedVersion": "12.11.77"
        },
        "lifecycle": {
          "status": "current_product",
          "date": null
        },
        "hardening": {
          "lastHardened": "2026-07-10T12:51:32Z"
        }
      },
      "network": {
        "ipv6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
        "ipv4": "10.0.0.32",
        "mac": "00:0a:95:9d:68:16",
        "port": 80,
        "defaultGateway": "10.0.0.1",
        "defaultGatewayV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7000"
      },
      "status": "online",
      "lastSeen": "2021-09-01T12:34:56Z",
      "probe": {
        "agent": "unmonitored",
        "deviceSource": "up",
        "edge": "up",
        "host": "unknown",
        "app": "up"
      },
      "deviceSources": [
        {
          "id": 4
        }
      ],
      "sites": [
        {
          "id": 10
        }
      ],
      "onboardingDate": "2026-06-14T11:04:43.000Z",
      "maintenanceMode": false,
      "recordingStatus": "recording",
      "storageServer": "Recording Server 80B5F8",
      "isOrphaned": false
    },
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Headquarters Back Door Reader",
      "vendor": "Mercury",
      "model": "LP1502",
      "firmwareVersion": "1.30.7 (677)",
      "deviceType": "access_control",
      "availableTask": {
        "hardenDevice": false,
        "restartDevice": true,
        "rotate8021xCertificate": false,
        "rotatePassword": false,
        "rotateSslCertificate": false,
        "upgradeFirmware": false
      },
      "compliance": {
        "vulnerability": {
          "isFirmwareVulnerable": false
        },
        "firmware": {
          "isUpgradeAvailable": true,
          "isLatest": false,
          "patchedVersion": null
        },
        "lifecycle": {
          "status": "eol",
          "date": "2028-12-31T00:00:00.000Z"
        },
        "hardening": {
          "lastHardened": null
        }
      },
      "network": {
        "ipv6": "2001:0db8:85a3:0000:0000:8a2e:1124:5555",
        "ipv4": "10.0.22.5",
        "mac": "00:0a:95:9d:F4:16",
        "port": 80,
        "defaultGateway": "10.0.22.1",
        "defaultGatewayV6": "2001:0db8:85a3:0000:0000:8a2e:1124:5000"
      },
      "status": "online",
      "lastSeen": "2024-01-22T12:34:56Z",
      "probe": {
        "agent": "unmonitored",
        "deviceSource": "down",
        "edge": "unknown",
        "host": "unmonitored",
        "app": "up"
      },
      "deviceSources": [
        {
          "id": 5
        }
      ],
      "sites": [
        {
          "id": 10
        }
      ],
      "onboardingDate": "2024-01-15T09:12:30.000Z",
      "maintenanceMode": false,
      "recordingStatus": "unknown",
      "storageServer": null,
      "isOrphaned": false
    }
  ],
  "total": 2
}

json

application/json

Get Device By ID

GET

https://api.securithings.com

/v1/devices/{id}

Returns basic information about a specific device in the system.

Returns 404 if the device is not found or the user does not have access to the device.

Get Device By ID › path Parameters

id

string · required

The device id

Get Device By ID › Responses

Single device information

DeviceInfo

id

DeviceId

The unique identifier of the device, generated by SecuriThings and will identify the device in the system.

name

string

The name field represents the user-assigned device name as displayed in the management system.

vendor

string

The manufacturer of the device.

model

string

The model of the device.

firmwareVersion

string

the current firmware version that the device is running.

deviceType

string · enum

The type of device, such as camera, access control panel, intercom, or other classifications.

Enum values:

camera

decoder

encoder

intercom

fire_alarm

smart_lock

printer

access_control

object

Nested object providing compliance-related details.

object

Nested object providing network-related details.

status

string · enum

The current operational status of the device (e.g., "online" or "offline").

Enum values:

online

offline

partial

unknown

lastSeen

string · date-time

The last known active time of the device in ISO 8601 format.

object

The status of each probe available.

object[]

Specifies the discovery source and the integration methods for the device.

object[]

Specifies the site or geolocation associated with the device, indicating the physical or logical location to which it is connected.

onboardingDate

string | null · date-time

The date and time the device was onboarded, in ISO 8601 format.

maintenanceMode

boolean | null

Whether the device is in maintenance mode.

recordingStatus

string · enum

The recording status of the device.

Enum values:

recording

notRecording

error

unknown

storageServer

string | null

The storage server the device is associated with.

isOrphaned

boolean | null

Whether the device no longer exists in the management platform.

GET/v1/devices/{id}

curl https://api.securithings.com/v1/devices/:id \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Headquarters camera1",
  "vendor": "Axis",
  "model": "P3225-LVE",
  "firmwareVersion": "9.80.1",
  "deviceType": "camera",
  "availableTask": {
    "hardenDevice": true,
    "restartDevice": true,
    "rotate8021xCertificate": false,
    "rotatePassword": true,
    "rotateSslCertificate": true,
    "upgradeFirmware": true
  },
  "compliance": {
    "vulnerability": {
      "isFirmwareVulnerable": true
    },
    "firmware": {
      "isUpgradeAvailable": true,
      "isLatest": false,
      "patchedVersion": "12.11.77"
    },
    "lifecycle": {
      "status": "current_product",
      "date": null
    },
    "hardening": {
      "lastHardened": "2026-07-10T12:51:32Z"
    }
  },
  "network": {
    "ipv6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
    "ipv4": "10.0.0.32",
    "mac": "00:0a:95:9d:68:16",
    "port": 80,
    "defaultGateway": "10.0.0.1",
    "defaultGatewayV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7000"
  },
  "status": "online",
  "lastSeen": "2021-09-01T12:34:56Z",
  "probe": {
    "agent": "unmonitored",
    "deviceSource": "up",
    "edge": "up",
    "host": "down",
    "app": "up"
  },
  "deviceSources": [
    {
      "id": 4
    }
  ],
  "sites": [
    {
      "id": 10
    }
  ],
  "onboardingDate": "2026-06-14T11:04:43.000Z",
  "maintenanceMode": false,
  "recordingStatus": "recording",
  "storageServer": "Recording Server 80B5F8",
  "isOrphaned": false
}

json

application/json

Get Device Vulnerabilities By ID

GET

https://api.securithings.com

/v1/devices/{id}/vulnerabilities

Retrieves a detailed list of vulnerabilities associated with a specific device. This endpoint allows clients to query vulnerabilities by providing the unique device identifier, enabling visibility into potential security risks affecting the device.

Returns 404 if the device is not found or the user does not have access to the device.

Get Device Vulnerabilities By ID › path Parameters

id

string · required

The device id

Get Device Vulnerabilities By ID › Responses

Single device vulnerabilities

DeviceVulnerabilities

cveId

string

The cveId field represents CVE identifier (if available).

description

string

The description field provides a detailed description of the vulnerability.

reportDate

string

The reportDate field indicates the date when the vulnerability was reported.

severity

string · enum

The severity field indicates the severity of the vulnerability.

Enum values:

critical

high

medium

low

reportLink

string

The reportLink field provides a link to the vulnerability report.

Get Device Passwords Metadata By ID

GET

https://api.securithings.com

/v1/devices/{id}/passwords

Returns password metadata for all users associated with a specific device. The actual password values are not included in the response.

Returns 404 if the device is not found or the user does not have access to the device.

Get Device Passwords Metadata By ID › path Parameters

id

string · required

The device id

Get Device Passwords Metadata By ID › Responses

Device passwords metadata

DevicePasswordsMetadata

object[]

Get Device Certificates By ID

GET

https://api.securithings.com

/v1/devices/{id}/certificates

Returns certificate data for all supported certificate types associated with a specific device.

Returns 404 if the device is not found or the user does not have access to the device.

Get Device Certificates By ID › path Parameters

id

string · required

The device id

Get Device Certificates By ID › Responses

Device certificates

DeviceCertificates

object[]

total

integer

The total number of certificates matching the query.

GET/v1/devices/{id}/certificates

curl https://api.securithings.com/v1/devices/:id/certificates \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "certificates": [
    {
      "type": "ssl",
      "status": "valid",
      "issueDate": "2026-04-14T11:36:00Z",
      "expirationDate": "2027-04-14T11:36:00Z",
      "issuerCommonName": "O=Keyfactor,O=SecuriThings,OU=IoT Demo,CN=SecuriThings Demo Issuing RSA G1",
      "subjectCommonName": "C=US,CN=ip-192-168-2-38.ec2.internal",
      "serialNumber": "513A727679B93D2D1416569DB6A98AF33C953FEC",
      "fingerprint": "A020C94F4044D2189B78CFBE9CDB6D5F0CF51726",
      "signatureAlgorithm": "SHA256WITHRSA",
      "keySize": 2048,
      "subjectAlternativeNames": {
        "dns": [
          "ip-192-168-2-44.ec2.internal"
        ]
      },
      "certificate": "-----BEGIN CERTIFICATE-----\nMIIFjTCCBHWg...\n-----END CERTIFICATE-----\n"
    },
    {
      "type": "802.1x",
      "status": "valid",
      "issueDate": "2021-09-09T12:30:00Z",
      "expirationDate": "2023-09-09T12:30:00Z",
      "issuerCommonName": "O=Axis Communications AB,CN=Axis device ID Intermediate CA RSA 2",
      "subjectCommonName": "C=SE,L=Lund,O=Axis Communications AB,CN=axis-b8a44f44ce09-rsa2048-1,SERIALNUMBER=b8a44f44ce09",
      "serialNumber": "50567B3B09902A1B6A135A9869CF722D102F42D",
      "fingerprint": "1BDC76201E938D767FD516A3F0F80313768D7626",
      "signatureAlgorithm": "SHA256WITHRSA",
      "keySize": 2048,
      "subjectAlternativeNames": {
        "dns": [
          "ip-192-168-2-44.ec2.internal"
        ]
      },
      "certificate": "-----BEGIN CERTIFICATE-----\nLS0tLS1CRUd...\n-----END CERTIFICATE-----\n"
    }
  ],
  "total": 2
}

json

application/json

Discovered Devices

Get Devices

GET

https://api.securithings.com

/v1/devices

Returns one or more devices user has access to.

Some fields are applicable only to devices with specific capabilities.

Results can be filtered using the query parameters specified below.

Returns 200 with empty devices list and a total of 0 when no devices found.

Get Devices › query Parameters

limit

integer · min: 1 · max: 1000

The number of items to return, default is 100 and maximum is 1000.

Default: 100

offset

integer · min: 0

The number of items to skip before starting to collect the result set.

Default: 0

status

string · enum

The status of the device.

Enum values:

online

offline

partial

unknown

probe.agent

string · enum

Agent probe status.

Enum values:

down

unknown

unmonitored

probe.deviceSource

string · enum

Management Server probe status.

Enum values:

down

unknown

unmonitored

probe.edge

string · enum

Edge probe status.

Enum values:

down

unknown

unmonitored

probe.host

string · enum

Host probe status.

Enum values:

down

unknown

unmonitored

probe.app

string · enum

App probe status.

Enum values:

down

unknown

unmonitored

isFirmwareVulnerable

boolean

Is the firmware version vulnerable.

isFirmwareLatest

boolean

Is the current firmware version is the latest available.

isFirmwareUpgradeAvailable

boolean

Is there a newer firmware version available.

lifeCycleStatus

string · enum

End of support status.

Enum values:

current_product

eol

eos

unknown

onboardedAfter

string · date-time

Filter devices onboarded after the specified date, in ISO 8601 format.

onboardedBefore

string · date-time

Filter devices onboarded before the specified date, in ISO 8601 format.

maintenanceMode

boolean

Filter devices by maintenance mode.

hardenedAfter

string · date-time

Filter devices last hardened after the specified date, in ISO 8601 format.

hardenedBefore

string · date-time

Filter devices last hardened before the specified date, in ISO 8601 format.

recordingStatus

string · enum

Filter devices by recording status.

Enum values:

recording

notRecording

error

unknown

storageServer

string

Filter devices by storage server.

compliance.firmware.patchedVersion

string

Filter devices by available firmware patch version.

isOrphaned

boolean

Filter devices by whether they no longer exist in the management platform.

Get Devices › Responses

A list of device objects.

DeviceInfo[]

A list of device objects.

total

integer

The total number of devices matching the query.

Get Device By ID

GET

https://api.securithings.com

/v1/devices/{id}

Returns basic information about a specific device in the system.

Returns 404 if the device is not found or the user does not have access to the device.

Get Device By ID › path Parameters

id

string · required

The device id

Get Device By ID › Responses

Single device information

DeviceInfo

id

DeviceId

The unique identifier of the device, generated by SecuriThings and will identify the device in the system.

name

string

The name field represents the user-assigned device name as displayed in the management system.

vendor

string

The manufacturer of the device.

model

string

The model of the device.

firmwareVersion

string

the current firmware version that the device is running.

deviceType

string · enum

The type of device, such as camera, access control panel, intercom, or other classifications.

Enum values:

camera

decoder

encoder

intercom

fire_alarm

smart_lock

printer

access_control

object

Nested object providing compliance-related details.

object

Nested object providing network-related details.

status

string · enum

The current operational status of the device (e.g., "online" or "offline").

Enum values:

online

offline

partial

unknown

lastSeen

string · date-time

The last known active time of the device in ISO 8601 format.

object

The status of each probe available.

object[]

Specifies the discovery source and the integration methods for the device.

object[]

Specifies the site or geolocation associated with the device, indicating the physical or logical location to which it is connected.

onboardingDate

string | null · date-time

The date and time the device was onboarded, in ISO 8601 format.

maintenanceMode

boolean | null

Whether the device is in maintenance mode.

recordingStatus

string · enum

The recording status of the device.

Enum values:

recording

notRecording

error

unknown

storageServer

string | null

The storage server the device is associated with.

isOrphaned

boolean | null

Whether the device no longer exists in the management platform.

Get Device Vulnerabilities By ID

GET

https://api.securithings.com

/v1/devices/{id}/vulnerabilities

Returns 404 if the device is not found or the user does not have access to the device.

Get Device Vulnerabilities By ID › path Parameters

id

string · required

The device id

Get Device Vulnerabilities By ID › Responses

Single device vulnerabilities

DeviceVulnerabilities

cveId

string

The cveId field represents CVE identifier (if available).

description

string

The description field provides a detailed description of the vulnerability.

reportDate

string

The reportDate field indicates the date when the vulnerability was reported.

severity

string · enum

The severity field indicates the severity of the vulnerability.

Enum values:

critical

high

medium

low

reportLink

string

The reportLink field provides a link to the vulnerability report.

Get Device Passwords Metadata By ID

GET

https://api.securithings.com

/v1/devices/{id}/passwords

Returns password metadata for all users associated with a specific device. The actual password values are not included in the response.

Returns 404 if the device is not found or the user does not have access to the device.

Get Device Passwords Metadata By ID › path Parameters

id

string · required

The device id

Get Device Passwords Metadata By ID › Responses

Device passwords metadata

DevicePasswordsMetadata

object[]

Get Device Certificates By ID

GET

https://api.securithings.com

/v1/devices/{id}/certificates

Returns certificate data for all supported certificate types associated with a specific device.

Returns 404 if the device is not found or the user does not have access to the device.

Get Device Certificates By ID › path Parameters

id

string · required

The device id

Get Device Certificates By ID › Responses

Device certificates

DeviceCertificates

object[]

total

integer

The total number of certificates matching the query.