Fortinet white logo
Fortinet white logo

CameraStatus

CameraStatus

Camera statuses.

Permissions required include both Camera status and Camera configuration.

HTTP Methods
  • GET

URL

Either:

  • https://HOST_OR_IP/api/v1/CameraStatus
  • https://HOST_OR_IP/api/v1/CameraStatus?showInactiveCamera=0

where variables are:

  • showInactiveCamera — Whether or not to include cameras whose status is 2:

    • 0 — Do not include. Default value if this parameter is not included in the URL.

    • 1 — Include.

Response JSON

{
    "objectID": "CameraStatusCollection:",
    "reqAction": 1,
    "totalRemoteCount": 5,
    "subCount": 5,
    "remoteSorting": true,
    "nextPage": false,
    "nodePermission": 3,
    "nodeAccessDetails": 1,
    "collection": [
        {
            "mkey": "FD50",
            "status": 1,
            "action_scheduled": 3,
            "action_pending": 2,
            "action_current": 1,
            "action_problem": 0,
            "last_query": 1762267129,
            "flag": 1,
            "detail_code": 0,
            "detail_info": "",
            "support_status": 0,
            "eos_version": ""
        },
        ...
    ]
}

where attributes are:

  • mkey — Unique name of the device.

  • status — Whether the device is:

    • 1 — Enabled.

    • 2 — Disabled.

  • action_scheduled — Scheduled actions, represented as a bitmask. See Action.

  • action_pending — Action started but not yet active, represented as a bitmask. See Action.

  • action_current — Current action, represented as a bitmask. See Action.

  • action_problem — Errors during action, represented as a bitmask. See Action.

  • last_query — Timestamp of the last status query in UTC in seconds since January 1, 1970, UTC (also called the Unix epoch). Convert to the Unix epoch to a UTC relative timestamp, and then convert UTC to your local time zone.

  • flag — Connectivity and activity status, represented as a bitmask. See Flag.

  • detail_code — Error code, if any.

  • detail_info — Error code details, if any.

  • support_status — Whether the device has reached the end of support version:

    • 0 — Device is supported by this FortiRecorder version.

    • 1 — Device is not supported by this FortiRecorderversion.

  • eos_versionFortiRecorder version number when this device will reach end-of-support, such as 7.4.0.

Action

Multiple bits can be active at the same time.

  • 0 — Idle.

  • 1 << 0 — Continuous recording. See also Recording type.

  • 1 << 1 — Motion detection recording.

  • 1 << 2 — Digital input.

  • 1 << 3 — Audio detection.

  • 1 << 4 — Passive infrared (PIR) detection.

  • 1 << 5 — Tamper detection.

  • 1 << 8 — Continuous recording on the camera's SD card ("edge recording"). See also Recording type.

  • 1 << 9 — Motion recording on the camera's SD card ("edge recording").

  • 1 << 10 — Digital input recording on the camera's SD card ("edge recording").

  • 1 << 11 — Audio recording on the camera's SD card ("edge recording").

  • 1 << 12 — Passive infrared (PIR) recording on the camera's SD card ("edge recording").

  • 1 << 13 — Tamper detection recording on the camera's SD card ("edge recording").

Flag

  • 0 — End-of-support reached. FortiRecorder will not try to connect to the camera.

  • 1 — Active. Camera has recently communicated with FortiRecorder.

  • 2 — Inactive. Camera has not recently communicated with FortiRecorder.

  • 3 — Camera is not configured.

  • 4 — Camera is unreachable.

  • 5 — Camera is not configured and has a default address.

  • 6 — Camera has an invalid address.

  • 7 — Camera has a default address.

  • 8 — Camera is being configured.

  • 9 — Camera has a configuration error.

  • 10 — Camera is upgrading its software.

  • 11 — Camera is rebooting.

  • 12 — Camera is not configured and has an invalid address.

  • 13 — Duplicate IP address detected. Camera has the same IP address as another device.

  • 14 — Camera is managed by another FortiRecorder.

CameraStatus

CameraStatus

Camera statuses.

Permissions required include both Camera status and Camera configuration.

HTTP Methods
  • GET

URL

Either:

  • https://HOST_OR_IP/api/v1/CameraStatus
  • https://HOST_OR_IP/api/v1/CameraStatus?showInactiveCamera=0

where variables are:

  • showInactiveCamera — Whether or not to include cameras whose status is 2:

    • 0 — Do not include. Default value if this parameter is not included in the URL.

    • 1 — Include.

Response JSON

{
    "objectID": "CameraStatusCollection:",
    "reqAction": 1,
    "totalRemoteCount": 5,
    "subCount": 5,
    "remoteSorting": true,
    "nextPage": false,
    "nodePermission": 3,
    "nodeAccessDetails": 1,
    "collection": [
        {
            "mkey": "FD50",
            "status": 1,
            "action_scheduled": 3,
            "action_pending": 2,
            "action_current": 1,
            "action_problem": 0,
            "last_query": 1762267129,
            "flag": 1,
            "detail_code": 0,
            "detail_info": "",
            "support_status": 0,
            "eos_version": ""
        },
        ...
    ]
}

where attributes are:

  • mkey — Unique name of the device.

  • status — Whether the device is:

    • 1 — Enabled.

    • 2 — Disabled.

  • action_scheduled — Scheduled actions, represented as a bitmask. See Action.

  • action_pending — Action started but not yet active, represented as a bitmask. See Action.

  • action_current — Current action, represented as a bitmask. See Action.

  • action_problem — Errors during action, represented as a bitmask. See Action.

  • last_query — Timestamp of the last status query in UTC in seconds since January 1, 1970, UTC (also called the Unix epoch). Convert to the Unix epoch to a UTC relative timestamp, and then convert UTC to your local time zone.

  • flag — Connectivity and activity status, represented as a bitmask. See Flag.

  • detail_code — Error code, if any.

  • detail_info — Error code details, if any.

  • support_status — Whether the device has reached the end of support version:

    • 0 — Device is supported by this FortiRecorder version.

    • 1 — Device is not supported by this FortiRecorderversion.

  • eos_versionFortiRecorder version number when this device will reach end-of-support, such as 7.4.0.

Action

Multiple bits can be active at the same time.

  • 0 — Idle.

  • 1 << 0 — Continuous recording. See also Recording type.

  • 1 << 1 — Motion detection recording.

  • 1 << 2 — Digital input.

  • 1 << 3 — Audio detection.

  • 1 << 4 — Passive infrared (PIR) detection.

  • 1 << 5 — Tamper detection.

  • 1 << 8 — Continuous recording on the camera's SD card ("edge recording"). See also Recording type.

  • 1 << 9 — Motion recording on the camera's SD card ("edge recording").

  • 1 << 10 — Digital input recording on the camera's SD card ("edge recording").

  • 1 << 11 — Audio recording on the camera's SD card ("edge recording").

  • 1 << 12 — Passive infrared (PIR) recording on the camera's SD card ("edge recording").

  • 1 << 13 — Tamper detection recording on the camera's SD card ("edge recording").

Flag

  • 0 — End-of-support reached. FortiRecorder will not try to connect to the camera.

  • 1 — Active. Camera has recently communicated with FortiRecorder.

  • 2 — Inactive. Camera has not recently communicated with FortiRecorder.

  • 3 — Camera is not configured.

  • 4 — Camera is unreachable.

  • 5 — Camera is not configured and has a default address.

  • 6 — Camera has an invalid address.

  • 7 — Camera has a default address.

  • 8 — Camera is being configured.

  • 9 — Camera has a configuration error.

  • 10 — Camera is upgrading its software.

  • 11 — Camera is rebooting.

  • 12 — Camera is not configured and has an invalid address.

  • 13 — Duplicate IP address detected. Camera has the same IP address as another device.

  • 14 — Camera is managed by another FortiRecorder.