SecuriThings Developer CenterSecuriThings Developer Center
Overview

​SecuriThings API

All endpoints require authentication using a JWT token, checkout the Authentication for more information.

You can find a Postman collection for this API here.

Endpoint:https://api.securithings.com
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.

​query Parameters

  • limit
    integer

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

  • offset
    integer

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

  • status
    string

    The status of the device, can be online, offline, partial or unknown.

  • probe.agent
    string

    Agent probe status, can be up, down, unknown or unmonitored.

  • probe.deviceSource
    string

    Management Server probe status, can be up, down, unknown or unmonitored.

  • probe.edge
    string

    Edge probe status, can be up, down, unknown or unmonitored.

  • probe.host
    string

    Host probe status, can be up, down, unknown or unmonitored.

  • probe.app
    string

    App probe status, can be up, down, unknown or unmonitored.

  • availableTask.rotatePassword
    boolean

    Indicate if a password rotation task is available (0 = not available, 1 = available).

  • availableTask.upgradeFirmware
    boolean

    Indicate if a firmware upgrade task is available (0 = not available, 1 = available).

  • availableTask.rotateSSLCertificate
    boolean

    Indicate if an SSL certificate rotation task is available (0 = not available, 1 = available).

  • availableTask.rotate8021xCertificate
    boolean

    Indicate if an 802.1x certificate task is available (0 = not available, 1 = available).

  • availableTask.restartDevice
    boolean

    Indicate if a remote restart task is available (0 = not available, 1 = available).

  • availableTask.hardenDevice
    boolean

    Indicate if a device hardening task is available (0 = not available, 1 = available).

  • 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

    End of support status, can be current_product, eol, eos or unknown.

​Responses

    • devices
      object[]
      optional

      A list of device objects.

    • total
      integer
      optional

      The total number of devices matching the query.

​Get Device By ID

GET
https://api.securithings.com
/v1/devices/{id}

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.

​path Parameters

  • id
    string
    required

    The device id

​Responses

    • id
      string
      optional

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

    • name
      string
      optional

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

    • vendor
      string
      optional

      The manufacturer of the device.

    • model
      string
      optional

      The model of the device.

    • firmwareVersion
      string
      optional

      the current firmware version that the device is running.

    • deviceType
      string
      optional

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

    • compliance
      object
      optional

      Nested object providing compliance-related details.

    • network
      object
      optional

      Nested object providing network-related details.

    • status
      string
      optional

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

    • lastSeen
      string
      optional

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

    • probe
      object
      optional

      The status of each probe available.

    • availableTask
      object
      optional

      The available tasks for the device.

    • deviceSources
      object[]
      optional

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

    • sites
      object[]
      optional

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

​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.

​path Parameters

  • id
    string
    required

    The device id

​Responses

    • cveId
      string
      optional

      The cveId field represents CVE identifier (if available).

    • description
      string
      optional

      The description field provides a detailed description of the vulnerability.

    • reportDate
      string
      optional

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

    • severity
      string
      optional

      The severity field indicates the severity of the vulnerability.

    • reportLink
      string
      optional

      The reportLink field provides a link to the vulnerability report.

Sites

​Get Sites

GET
https://api.securithings.com
/v1/sites

Returns one or more sites (geolocation) user has access to.

Results can be filtered using the query parameters specified below.

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

​query Parameters

  • limit
    integer

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

  • offset
    integer

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

  • name
    string

    The name of the site.

​Responses

    • sites
      object[]
      optional

      A list of site objects representing various locations.

    • total
      integer
      optional

      The total number of sites matching the query

​Get Site By ID

GET
https://api.securithings.com
/v1/sites/{id}

Returns basic information about a specific site (geolocation) in the system.

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

​path Parameters

  • id
    string
    required

    The site id

​Responses

    • id
      integer
      optional

      The unique identifier.

    • name
      string
      optional

      The name assigned to the site, provided by the user.

    • description
      string
      optional

      A brief explanation of the site's purpose or significance.

    • coordinates
      object
      optional

      The geographic coordinates of the site.

DeviceSources

​Get Device Sources

GET
https://api.securithings.com
/v1/deviceSources

Returns one or more device sources user has access to.

Results can be filtered using the query parameters specified below.

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

Note: The type internal is used for CSV based device sources.

Note: The version field reference to the version of the type, each type has a different version schema.

​query Parameters

  • limit
    integer

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

  • offset
    integer

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

  • name
    string

    The name of the device source.

​Responses

    • deviceSources
      object[]
      optional

      A list of device sources.

    • total
      integer
      optional

      The total number of device sources matching the query

​Get Device Source By ID

GET
https://api.securithings.com
/v1/deviceSources/{id}

Returns basic information about a specific device source in the system.

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

Note: The type internal is used for CSV based device sources.

Note: The version field reference to the version of the type, each type has a different version schema.

​path Parameters

  • id
    string
    required

    The device source id

​Responses

    • id
      optional
    • name
      string
      optional

      The name of the device source, as define by the user.

    • type
      string
      optional

      The type of the device source, indicating the integration or system.

    • version
      string
      optional

      The version of the device source as defined by the end user in the system.