Scanners

GET scanner_tasks/meta

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	GET

Returns list of pre-defined scanner tasks.

Resource URL

http://{host}/api/2.0/scanner_tasks/meta/.format

Example Request

GET

http://44.235.52.211/api/2.0/scanner_tasks/meta/.json

{
    "AccessTypes": {
        "1": "MPEGTS",
        "3": "OTT",
        "4": "RTMP",
        "5": "Uncompressed",
        "8": "CTP"
    },
    "Modes": {
        "1": "Starting",
        "2": "Running",
        "3": "Canceling",
        "4": "Canceled",
        "5": "Finished",
        "6": "Finishing",
        "7": "Failed",
        "8": "Restarting"
    }
}

GET scanner_tasks

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	GET

Returns a list of all available scanner tasks configurations.

Resource URL

http://{host}/api/2.0/scanner_tasks/.format

Example Request

GET

http://44.235.52.211/api/2.0/scanner_tasks/.json

[
    {
        "ScanTask": {
            "id": 44194,
            "mode_id": 5,
            "device_id": 9011,
            "time_remained": 0,
            "progress": 100,
            "status": "Finished (0 new, 0 current)",
            "modified": "1612763175621",
            "created": "1612763150518",
            "ScanEntries": [
                {
                    "id": 11,
                    "source": "192.10.0.5",
                    "title": "ott #RES|BAND#",
                    "ssm_ip_address": null,
                    "network_id": 1,
                    "port": null,
                    "access_type_id": 3
                }
            ]
        }
    },
    {
        "ScanTask": {
            "id": 494691,
            "mode_id": 5,
            "device_id": 9011,
            "time_remained": 0,
            "progress": 100,
            "status": "Finished (0 new, 0 current)",
            "modified": "1612763215641",
            "created": "1612763213282",
            "ScanEntries": [
                {
                    "id": 12,
                    "source": "192.10.10.1",
                    "title": "rtmp #RES|BAND#",
                    "ssm_ip_address": null,
                    "network_id": 1,
                    "port": null,
                    "access_type_id": 4
                }
            ]
        }
    }    
]

GET scanner_tasks/{id}

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	GET

Returns single scanner tasks configurations.

Resource URL

http://{host}/api/2.0/scanner_tasks/{id}/.format

Parameters

Parameter	Data Type	Description
id (required)	integer	The ID of the desired Scanner task to be viewed.

Example Request

GET

http://44.235.52.211/api/2.0/scanner_tasks/735189/.json

{
    "ScanTask": {
        "id": 735189,
        "mode_id": 5,
        "device_id": 9011,
        "time_remained": 0,
        "progress": 100,
        "status": "Finished (0 new, 0 current)",
        "modified": "1612701112750",
        "created": "1612699631127",
        "ScanEntries": [
            {
                "id": 1,
                "source": "10.1.1.0",
                "title": "test1",
                "ssm_ip_address": null,
                "network_id": 1,
                "port": null,
                "access_type_id": 3
            }
        ]
    }
}

POST scanner_tasks

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	POST

Adds a new scanner task to the system and auto-start the scan process.

Resource URL

http://{host}/api/2.0/scanner_tasks/.format

Example Request

POST

http://44.235.52.211/api/2.0/scanner_tasks/.json

DELETE scanner_tasks/{id}

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	DELETE

Deletes a scanner task.

Resource URL

http://{host}/api/2.0/scanner_tasks/{id}/.format

Parameters

Parameter	Data Type	Description
id (required)	integer	The ID of the desired Scanner task to be deleted.

Example Request

DELETE

http://44.235.52.211/api/2.0/scanner_tasks/44194/.json

GET scanner_tasks/command/stop/{id}

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	GET

Stops a running scanner task. Channels found until that time are kept.

Resource URL

http://{host}/api/2.0/scanner_tasks/command/stop/{id}/.format

Example Request

GET

http://44.235.52.211/api/2.0/scanner_tasks/command/stop/26901/.json

GET scanner_tasks/command/restart/{id}

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	GET

Restarts an idle scanner task.

Resource URL

http://{host}/api/2.0/scanner_tasks/command/restart/{id}/.format

Example Request

GET

http://44.235.52.211/api/2.0/scanner_tasks/command/restart/735189/.json