Page Comparison

GET snmp_devices/meta

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	GET

Returns list of meta data information used for SNMP Devices configuration.

Resource URL

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

Example Request

GET

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

Code Block

language	json

{
    "DeviceTypes": {
        "1": "Scopus IRD-2900",
        "2": "Tandberg Rx8200",
        "3": "Tandberg Rx1290",
        "4": "Sencore 3187B",
        "5": "Cisco D9854"
    }
}

GET snmp_devices

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	GET

Returns a list of all SNMP Devices configuration data.

Resource URL

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

Example Request

GET

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

Code Block

language	json

[
    {
        "SnmpDevice": {
            "id": 1,
            "title": "ext_Device",
            "ip_address": "192.168.0.1",
            "port": 162,
            "snmp_device_type_id": 1,
            "read_community": "read",
            "write_community": "write",
            "input_port_id": 1,
            "output_port_id": 1,
            "network_id": 0,
            "modified": "1619952244989",
            "created": "1619952244989"
        }
    },
    {
        "SnmpDevice": {
            "id": 2,
            "title": "ext_Device2",
            "ip_address": "192.168.0.2",
            "port": 2000,
            "snmp_device_type_id": 3,
            "read_community": "read",
            "write_community": "write",
            "input_port_id": 1,
            "output_port_id": 1,
            "network_id": 1,
            "modified": "1619952308937",
            "created": "1619952281683"
        }
    }
]

GET snmp_devices/{id}

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	GET

Returns a single specific SNMP Device configuration data.

Resource URL

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

Parameters

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

Example Request

GET

http://44.235.52.211/api/2.0/snmp_devices/1/.json

Code Block

language	json

{
    "SnmpDevice": {
        "id": 1,
        "title": "ext_Device",
        "ip_address": "192.168.0.1",
        "port": 162,
        "snmp_device_type_id": 1,
        "read_community": "read",
        "write_community": "write",
        "input_port_id": 1,
        "output_port_id": 1,
        "network_id": 0,
        "modified": "1619952244989",
        "created": "1619952244989"
    }
}

POST snmp_devices

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	POST

Adds a new SNMP Device configuration.

Resource URL

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

Example Request

POST

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

Body

Code Block

language	json

{
  "SnmpDevice": {
    "ip_address": "192.168.0.34",
    "network_id": 0,
    "port": 162,
    "read_community": "read",
    "snmp_device_type_id": 3,
    "title": "SNMP Dev_NEW",
    "write_community": "write"
  }
}

Response

Code Block

language	json

{
    "SnmpDevice": {
        "id": 4,
        "title": "SNMP Dev_NEW",
        "ip_address": "192.168.0.34",
        "port": 162,
        "snmp_device_type_id": 3,
        "read_community": "read",
        "write_community": "write",
        "input_port_id": 1,
        "output_port_id": 1,
        "network_id": 0,
        "modified": "1619957663731",
        "created": "1619957663731"
    }
}

POST snmp_devices/{id}

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	POST

Duplicates a single specific SNMP Device, preserving all configuration data except for title.

Resource URL

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

Parameters

Parameter	Data Type	Description
id (required)	integer	The ID of the desired SNMP device to be copied.

Example Request

POST

http://44.235.52.211/api/2.0/snmp_devices/2/.json

Code Block

language	json

{
    "SnmpDevice": {
        "id": 6,
        "title": "ext_Device2_2",
        "ip_address": "192.168.0.2",
        "port": 2000,
        "snmp_device_type_id": 3,
        "read_community": "read",
        "write_community": "write",
        "input_port_id": 1,
        "output_port_id": 1,
        "network_id": 1,
        "modified": "1619957832396",
        "created": "1619957832396"
    }
}

PUT snmp_devices/{id}

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	PUT

Updates a single specific SNMP Device configuration.

Resource URL

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

Parameters

Parameter	Data Type	Description
1 (required)	integer	The ID of the desired SNMP device to be updated.

Example Request

PUT

http://44.235.52.211/api/2.0/snmp_devices/1/.json

Body

Code Block

language	json

{
  "SnmpDevice": {
    "ip_address": "192.168.0.12",
    "network_id": 0,
    "port": 162,
    "read_community": "read",
    "snmp_device_type_id": 4,
    "title": "SNMP Dev_EDIT",
    "write_community": "write"
  }
}

Response

Code Block

language	json

{
    "SnmpDevice": {
        "id": 1,
        "title": "SNMP Dev_EDIT",
        "ip_address": "192.168.0.12",
        "port": 162,
        "snmp_device_type_id": 4,
        "read_community": "read",
        "write_community": "write",
        "input_port_id": 1,
        "output_port_id": 1,
        "network_id": 0,
        "modified": "1619957858988",
        "created": "1619952244989"
    }
}

DELETE snmp_devices/{id}

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	DELETE

Deletes a single specific SNMP Device configuration.

Resource URL

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

Parameters

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

Example Request

DELETE

http://44.235.52.211/api/2.0/snmp_devices/1/.json

Code Block

language	json

{
    "success": true
}

GET snmp_devices/command/setDevice/{channel_id}/{snmp_dev_id}/{device_id}

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	GET

Send a specific channel to a pre-configured external SNMP Device.

Resource URL

http://{host}/api/2.0/snmp_devices/command/test/{id}/.format

Parameters

Parameter	Data Type	Description
id (required)	integer	The ID of the desired SNMP device to be displayed.

Example Request

GET

http://44.235.52.211/api/2.0/snmp_devices/command/setDevice/1/1/.json

Code Block

language	json

{
    "Task": {
        "id": 572836,
        "device_id": 9011,
        "type": "Agent Test",
        "type_id": 12,
        "mode": "Starting",
        "mode_id": 1,
        "status": null,
        "description": null,
        "total": 0,
        "completed": 0,
        "time_remained": 0,
        "modified": "1619505090620"
    }
}

Page Comparison

Versions Compared

Old Version 2

New Version 3

Key

GET snmp_devices/meta

Resource Information

Resource URL

Example Request

GET snmp_devices

Resource Information

Resource URL

Example Request

GET snmp_devices/{id}

Resource Information

Resource URL

Parameters

Example Request

POST snmp_devices

Resource Information

Resource URL

Example Request

POST snmp_devices/{id}

Resource Information

Resource URL

Parameters

Example Request

PUT snmp_devices/{id}

Resource Information

Resource URL

Parameters

Example Request

DELETE snmp_devices/{id}

Resource Information

Resource URL

Parameters

Example Request

GET snmp_devices/command/setDevice/{channel_id}/{snmp_dev_id}/{device_id}

Resource Information

Resource URL

Parameters

Example Request