/sessions

The sessions endpoint is used to authenticate the user and create a session token for accessing all other NetOps Console Server endpoints.

post

Create a new authenticated session.

get

Retrieve the state of an authentication session.

put

Apply a challenge response to a session

delete

Log out of and delete a session

/ports

Configuring and viewing ports information [no_sorting_required]

get

Gets ports attached to the NetOps Console Server appliance.

put

Update properties for all ports attached to the NetOps Console Server appliance.

Viewing and deleting of any active session on a specific port.

get

Retrieve a single port by ID.

put

Set the properties for a single port.

get

Retrieve all active sessions on this port.

delete

Disconnect active sessions on this port. Use query parameters to select a subset of sessions for disconnection. If no query parameters are given, all sessions on this port will be disconnected.

get

Retrieve an active session on this port.

delete

Disconnect the session.

put

Control power for a console device.

post

Reset the tx/rx counters for a particular serial port.

Manage Port Auto-Discovery

post

Trigger the port Auto-Discovery process

delete

Cancel an Auto-Discovery job

get

Get Port Auto-Discovery state

Manage Port Auto-Discovery Scheduling

put

Schedule the Port Auto-Discovery process

get

Get the Port Auto-Discovery schedule

Get auto_discovery logs.

get

Get auto_discovery logs.

Get logs for the last auto_discovery run.

get

Get logs for the last auto_discovery run.

Provides information about the serial pin status and Tx & Rx counters for each of this device's serial ports [no_sorting_required]

get

Gets the list of active pin status for all serial port signals and the Tx and RX byte counters.

Provides information about the serial pin status and Tx & Rx counters for each of this device's serial ports

get

Gets the list of active pin status for all serial port signals and the Tx and RX byte counters.

/managementports

Used for working with local management console information.

get

Gets the local management console ports attached to the NetOps Console Server appliance.

put

Set the properties for local management console ports.

Used for working with a specific management port.

get

Retrieve a single local management console port by ID.

put

Set properties for a single local management console port.

/logs

Used for working with the logs on the system.

get

Fetch last n log lines in syslog.

get

Fetch last n log lines in portlog.

logs/portlog_settings endpoint is to check and update port log settings.

get

Retrieve the current settings.

put

Set the port log settings.

/pots_modems

get

Query the configuration of POTS modems available on the system

put

Configure the POTS modems available on the system

get

request POTS modem settings

put

Defines POTS modem settings

delete

Disconnect all active sessions on POTS modem

/monitor

Used for monitoring the state of the various services running on the system.

Used for monitoring the state of the various network discovery (LLDP/CDP) protocols running on the system.

Get the current status of the network discovery (LLDP/CDP) protocols on this device.

get

Get the current status of the network discovery (LLDP/CDP) protocols on this device.

Get the list of neighboring devices (peers) that have been discovered by the LLDP protocol.

get

Get the list of neighboring devices (peers) that have been discovered by the LLDP protocol.

Retrieve a single LLDP neighbor status by ID. Used for working with a specific LLDP neighbor status item.

get

Retrieve a single LLDP neighbor status by ID.

Used for monitoring addresses banned by Brute Force Protection.

get

Retrieves information about IP addresses banned by Brute Force Protection

Used for working with a specific ban.

get

Retrieve a single ban by ID.

Used for monitoring the status of static routes. Only IPv4 static routes are supported.

get

Retrieves information about the status of static routes.

Used for working with a specific static route status.

get

Retrieve a single static route status by ID.

/services

Used for working with the properties of the various services running on the system.

Provides access to the Brute Force Protection configuration on the system. When this service is enabled, the system watches for multiple failed login attempts and temporarily bans the offending IP Address for the configured amount of time.

get

Retrieves the Brute Force Protection configuration

put

Set the Brute Force Protection configuration

Provides access to the SSL certificate used by web services on the device.

get

Returns the current HTTPS certificate, CSR details and indicate if a pending CSR exists.

put

Create a new CSR, delete the pending CSR or upload the certificate for the pending CSR.

get

This entity is used to download the CSR object.

Trivial File Transfer Protocol (TFTP) is a service that allows files to be transferred to or from the NetOps Console Server appliance. This entity provides access to the TFTP server configuration on the system.

get

Retrieves the TFTP server configuration.

put

Set the TFTP server configuration.

Provides access to the NTP client configuration on the system.

get

Fetch NTP client configuration.

put

Set the NTP client configuration, including enabling/disabling the NTP service.

Provides information the current synchronization state of NTP

get

Gets the current sync status for NTP

Provides access to the Network Discovery Protocols (LLDP/CDP) configuration.

get

Fetch the Network Discovery Protocols configuration.

put

Modify Network Discovery Protocols configuration.

Provides access to the remote syslog server configuration.

get

Fetch remote syslog server configuration list.

post

Create a new syslog server data in the configuration.

get

Fetch a configured syslog server by id.

put

Set the syslog server configuration

delete

Delete a syslog server.

Retrieve and configure the SNMP TRAP/INFORM settings.

get

Get the snmp manager legacy configuration.

put

Set the snmp manager legacy configuration.

SNMP Alert Managers are used to receive and log SNMP TRAP and INFORM messages sent by the NetOps Console Server. To receive SNMP alerts generated by the system at least one SNMP Alert Manager must be configured.

get

Get the snmp manager configuration.

post

Add a new snmp manager.

Retrieve and update information for a specific SNMP Alert Manager.

get

Get the configuration of an SNMP Manager

put

Update settings for SNMP Managers on the NetOps Console Server appliance.

delete

Delete an snmp manager

Simple Network Management Protocol (SNMP) is an Internet Standard protocol for collecting and organizing information about managed devices on IP networks and for modifying that information to change device behaviour. This entity allows configuration of the SNMP service.

get

Get the snmpd configuration.

put

Set the snmpd configuration.

Configure the Secure Shell Protocol (SSH) service.

get

Fetch configuration for the SSH service.

put

Set configuration for the SSH service.

Retrieve and configure routing services on the NetOps Console Server appliance.

get

Fetch the configuration for the available routing daemons.

put

Set the configuration for the available routing daemons.

/alerts

Used to configure various types of alerts

Retrieve and configure Authentication Trap Group settings.

get

Get the authentication trap group settings.

put

Set the authentication trap group settings.

Retrieve and configure System Trap Group settings.

get

Get the system trap group settings.

put

Set the system trap group settings.

Retrieve and configure Networking Trap Group settings.

get

Get the networking trap group settings.

put

Set the networking trap group settings.

Retrieve and configure config change trap group settings.

get

Get the config change trap group settings.

put

Set the config trap group settings.

/monitoring

Used to configure various types of monitoring systems

Used to configure various types of alerts

Retrieve and configure Networking Alert Group settings.

get

Get the networking alert group settings.

put

Set the networking alert group settings.

Retrieve and configure Power Alert Group settings.

get

Get the power alert group settings.

put

Set the power alert group settings.

Retrieve and configure System Alert Group settings.

get

Get the system alert group settings.

put

Set the system alert group settings.

/physifs

Read and manipulate the network physical interfaces on the NetOps Console Server appliance.

get

Get a list of the network interfaces on the NetOps Console Server appliance.

post

Add a new interface to the NetOps Console Server appliance.

put

Update a list of the network interfaces on the NetOps Console Server appliance.

Retrieve and update configuration for a specific network interface on the NetOps Console Server.

get

Get a network interface on the NetOps Console Server appliance by id.

put

Update settings for a network interface on the NetOps Console Server appliance.

delete

Delete a network interface by id. Currently only aggregate interfaces can be deleted.

/conns

Read and manipulate the network connections on the NetOps Console Server appliance.

get

Get a list of the network connections on the server.

post

Add a new network connection to the NetOps Console Server appliance.

put

Put a list of the network connections on the server.

Retrieve and update configuration for a specific network connection on the NetOps Console Server.

get

Get the configuration of a network connection on the NetOps Console Server appliance.

put

Update settings for a network connection on the NetOps Console Server appliance.

delete

Delete a network connection on the NetOps Console Server appliance.

/static_routes

Configuring and viewing static routes

get

Get list of static routes

put

Create a list of static routes. Overwrite existing routes

post

Add a static route

delete

Delete all static routes

Retrieve and update configuration for a specific static route.

get

Get the configuration of a static route by its id.

put

Set the properties of a static route.

delete

Delete a static route

/lighthouse_enrollments

View and control enrollment to a lighthouse

get

Get the information about the lighthouse enrollments

post

Create a new lighthouse enrollment

Retrieve or remove configuration for a specific Lighthouse enrollment.

get

Get lighthouse-enrollment information by id.

delete

Delete lighthouse enrollment object and begin unenrollment

/registration

Registration endpoint accessed by a Lighthouse to start Lighthouse driven enrollment

post

Initial contact from Lighthouse to start the Enrollment process

delete

Remove connection to this lighthouse

Remove a connection to a given Lighthouse by ID

delete

Update the lhvpn_tunnel server address

put

/system

System endpoints are related to configuring and accessing information about the NetOps Console Server appliance itself.

Retrieve the system's Disk Space usage

get
get

Retrieve or change the NetOps Console Server appliance system's hostname.

get

Get the NetOps Console Server appliance hostname.

put

Set the NetOps Console Server appliance hostname.

Retrieve or change the NetOps Console Server appliance system's banner text.

get

Get the NetOps Console Server appliance banner text.

put

Set the NetOps Console Server appliance banner text.

Retrieve or change the NetOps Console Server appliance system's cloud connect configuration.

get

Get the NetOps Console Server appliance cloud connect configuration.

put

Set the NetOps Console Server appliance cloud connect configuration.

Retrieve or change the NetOps Console Server appliance WebUI session timeout.

get

Retrieve the WebUI session timeout (in minutes).

put

Set the WebUI session timeout (in minutes).

Retrieve or change the NetOps Console Server appliance CLI.

get

Retrieve the CLI session timeout (in minutes).

put

Set the CLI session timeout (in minutes).

Retrieve or change the NetOps Console Server appliance session timeouts.

get

Retrieve session timeouts (in minutes).

put

Set the session timeouts (in minutes).

Configure the SSH authorized keys for all users.

get

Retrieve ssh authorized keys for all users

post

Add an SSH key for the specified user

delete

Delete an SSH key.

get

Get an SSH key by key-id

The SSH port used in Direct SSH links.

get

Retrieve the system SSH port.

put

Set the system SSH port.

Retrieve and update the system's timezone.

get

Retrieves the system timezone.

put

Set the system timezone.

Retrieve and update the NetOps Console Server's time.

get

Retrieve the NetOps Console Server current time.

put

Set the NetOps Console Server current time.

delete

Delete the configuration effectively performing a system reset. The will reset to factory settings and reboot.

post

Wait 10 seconds then perform a system reboot.

Retrieve or change the NetOps Console Server appliance system's information (hostname, contact and location).

get

Get the NetOps Console Server appliance system information.

put

Set the NetOps Console Server appliance system information.

Cellular logging provides the ability to capture the RRC connection messages from the cellular module. This entity allows configuration of cellular logging and is only to be used during compliance testing.

get

Retrieves configuration for cellular logging.

put

Set the configuration for cellular logging.

get

Retrieve configuration items related to running the cell reliability test.

put

Update configuration items related to running the cell reliability test. This allows the user to enable and disable the test, change how frequently it executes, configure the URL to use in the test and configure the alert threshold for signal strength.

This entity is used to upgrade the system firmware of the NetOps Console Server appliance.

post

Upgrade the system firmware either by uploading a file or providing a url to download the file from. This endpoint will always return success if the firmware upgrade job was started - it occurs in the background and the state of which should be retrieved from the GET /system/firmware_upgrade_status endpoint. At least 'file' or 'firmware_url' are required.

This entity provides the status of the most recent firmware upgrade job.

get

Retrieve the status of the most recent firmware upgrade job.

Retrieve the NetOps Console Server's most recent firmware and REST API version.

get

Get the version information.

Retrieve the NetOps Console Server appliance's serial number.

get

Get the serial number information.

Retrieve the NetOps Console Server appliance's model name.

get

Get the model name information.

Retrieve basic system information

get

Retrieve basic system information

This system configuration option allows users to set whether the OpenSSL package uses only FIPS 140-2 compliant cryptographic modules.

get

Retrieves the system configuration of FIPS 140-2 compliance for the OpenSSL package.

put

Set whether the OpenSSL packages only uses FIPS 140-2 compliant cryptographic modules.

/support_report

A report which will provide information about the state of the NetOps Console Server appliance. This information can be used to help analyse and understand the state of the system. The report is large and may take in the order of a minute to obtain.

get

Retrieve the support report data.

/auth

Configure remote authentication, authorization, accounting (AAA) servers.

get

Retrieve information on AAA servers.

put

Set the AAA config.

/local_password_policy

Configure the password policy for local users. This includes expiry and complexity settings.

get

Retrieve the local password policy.

put

Set the local password policy.

/users

Retrieve and update user information.

get

Retrieve a list of users.

put

Replace current user list with a new one. Used by Lighthouse Template push

post

Create a new User data in the config.

Retrieve and update information for a specific user.

get

Retrieve the User information by ID.

put

Set a user's properties in the config.

delete

Delete a User

Configure the SSH authorized keys for a specific user.

get

Retrieve ssh authorized keys for a user

post

Add an SSH key for a user

get

Retrieve ssh authorized keys for a user

delete

Delete an SSH key for a user.

/groups

Retrieve or update group information.

get

Retrieve a list of groups.

put

Replace current groups list with a new one. Used by Lighthouse Template push

post

Create a new Group in the config.

Retrieve or update information for a specific group.

get

Retrieve the Group information by ID.

put

Update a Group data in the config.

delete

Delete a Group

/scripts

The scripts endpoint is used to upload and execute custom user scripts on the NetOps Console Server appliance and to retrieve the status of currently executing scripts.

post

Upload a shell script to be executed on the node

get

Retrieve the status of a script executing on the node, as in GET /scripts?execution_id={id}, where id is the value for execution_id returned in the 200 response to the POST /scripts request.

/firewall

Firewall endpoints are related to configuring and accessing information about the firewall running on the NetOps Console Server appliance.

Collection of custom services defined for the NetOps Console Server appliance's firewall. A service is a named grouping of one or more TCP or UDP ports for a particular networking protocol. For example, the 'https' service refers to TCP port 443. The appliance includes many predefined services for common protocols (see /firewall/predefined_services). This collection contains only custom services which have been defined by the administrator.

get

Retrieve a list of custom services defined for the NetOps Console Server appliance.

post

Create a new custom service in the config.

Retrieve or update a specific custom firewall service.

get

Retrieve the custom service by ID.

put

Set the configuration for an existing firewall service.

delete

Delete a service.

Collection of zones defined for the NetOps Console Server appliance's firewall. A zone includes 1 or more interfaces.

get

Retrieve a list of zones defined for the NetOps Console Server appliance.

post

Create a new zone in the config.

put

Set a list of firewall zones in the config.

Retrieve or update a specific firewall zone.

get

Retrieve the zone by ID.

put

Set the configuration for an existing firewall zone.

delete

Delete a zone.

Collection of rules defined for the NetOps Console Server appliance's firewall. A rule maps a service to a zone.

get

Retrieve a list of rules defined for the NetOps Console Server appliance.

post

Create a new rule in the config.

delete

Bulk delete a list of rules defined for the NetOps Console Server appliance.

Retrieve or update a specific firewall rich rule.

get

Retrieve the rule by ID.

put

Set the configuration for an existing firewall rule.

delete

Delete a rule.

Collection of predefined services defined for the NetOps Console Server appliance's firewall. A service is a named grouping of one or more TCP or UDP ports for a particular networking protocol. For example, the 'https' service refers to TCP port 443. This collection contains predefined services for common protocols and doesn't include the services added by the administrator.

get

Retrieve a list of predefined services defined for the NetOps Console Server appliance.

Retrieve a predefined service by name.

get

Collection of policies defined for the NetOps Console Server appliance's firewall. A policy applies a set of rules to traffic flowing between between zones.

get

Retrieve a list of policies defined for the NetOps Console Server appliance.

post

Create a new policy in the config.

Retrieve or update a specific firewall policy.

get

Retrieve the policy by ID.

put

Set the configuration for an existing firewall policy.

delete

Delete a policy.

Collection of source addresses matched with a list of services for which source nating rules will be applied.

get

Retrieve a list of source address matched with services defined for the NetOps Console Server appliance.

put

Replace current firewall service translation list with a new one.

post

Create a new service translation in the config.

Retrieve or update a specific firewall service translation.

get

Retrieve the specific firewall service translation by ID.

put

Set the configuration for an existing service translation.

delete

Delete a service translation.

/cellfw

The cellfw endpoints are related to checking, upgrading and scheduling upgrades for modem firmware.

Retrieve cellular modem version and related information.

get

Retrieve cellular modem version and related information.

/export

Retrieve system configuration for the NetOps Console Server.

get

/failover

Failover endpoint is to check failover status and retrieve / change failover settings.

failover/settings endpoint is to check and update failover settings. When failover is enabled, this device will consume from 1MB to 1.6 MB of bandwidth per day on the probe_physif connection. If the probe addresses are unreachable, this device will take from 108 to 156 seconds to enter the failover state.

get

Retrieve the current failover settings.

put

Set the failover settings.

failover/status endpoint is to check current failover status.

get

Retrieve the current failover status.

/cellmodem

Retrieve information about the cell modem.

get

This endpoint is used to retrieve status data about the cellular modem in the device

Cell modem SIM status

get

Retrieve the current SIM status.

Retrieve the status information for a specific Cell Modem SIM

get

/ipsec_tunnels

Read and manipulate the IPsec tunnels on the NetOps Console Server appliance.

get

Get a list of the IPsec tunnels.

post

Add a new network tunnel to the NetOps Console Server appliance.

Retrieve or update configuration for a specific IPsec tunnel on the NetOps Console Server.

get

Get the configuration of an IPsec tunnel on the NetOps Console Server appliance.

put

Update settings for an IPsec tunnel on the NetOps Console Server appliance.

delete

Delete an IPsec tunnel on the NetOps Console Server appliance.

/ipsec

Read and manipulate files that are used by IPsec tunnels using Public Key Infrastructure (PKI) for authentication.

An x509 bundle is a collection of certificates stored in PKCS12 format. This bundle removes the need to upload individual certificates.

get

Get a list of x509 bundles stored on the device.

post

Configure a new x509 bundle.

Retrieve or update a single configured x509 bundle.

get

Get a single configured x509 bundle by its ID.

put

Set the configuration for an existing x509 bundle.

delete

Delete an x509 Bundle.

Read, add, modify and delete Certificate Authority (CA) certificates used by IPsec tunnels using Public Key Infrastructure (PKI) for authentication

get

Get a list of all configured CA certificates

post

Configure a new CA certificate

Retrieve or update a single configured CA.

get

Get a single configured CA by it ID

put

Update a single configured CA

delete

Delete a CA

Read, add, modify and delete Certificate Revocation Lists for use by ipsec tunnels using Public Key Infrastucture (PKI) for authentication.

get

Get a list of all configured CRLs

post

Configure a new CRL file

Retrieve or update a single configured CRL.

get

Get a single configured CRL by it ID

put

Update a single configured CRL

delete

Delete a CRL

Read, add, modify and delete private keys.

get

Get a list of the configured private keys.

post

Configure a new private key.

Retrieve or update a single configured private key.

get

Get a single configured private key by its ID.

put

Update a single configured private key.

delete

Delete a private key.

Read, add, modify and delete x509 certificates (also known as Entity Certificates).

get

Get a list of the configured x509 certificates.

post

Configure a new x509 certificate.

Retrieve or udpate a single configured x509 certificate.

get

Get a single configured x509 certificate by its ID.

put

Update a single configured x509 certificate.

delete

Delete an x509 certificate.

/pdus

Configure, monitor and control PDUs connected to the device.

get

Get a list of all configured PDUs.

post

Add a new PDU.

Retrieve or update a specific PDU.

get

Get a PDU by id.

put

Update an existing PDU.

delete

Delete a PDU.

Read PDU driver list

get

Get a list of the PDU drivers. [visible:never]

/auto_response

Read and manipulate information pertaining to the Auto-Response system running on the NetOps Console Server appliance.

Read and manipulate the Auto-Response beacons on the NetOps Console Server appliance.

get

Get a list of the Auto-Response Beacons.

post

Add a new Auto-Response beacon to the NetOps Console Server appliance.

delete

Bulk delete a list of beacons defined for the NetOps Console Server appliance.

Retrieve or update configuration for a specific Auto-Response beacon.

get

Get the configuration of an Auto-Response beacon on the NetOps Console Server appliance.

put

Update settings for an Auto-Response beacon on the NetOps Console Server appliance.

delete

Delete an Auto-Response beacon on the NetOps Console Server appliance.

Read and manipulate the Auto-Response reactions on the NetOps Console Server appliance.

get

Get a list of the Auto-Response Reactions.

post

Add a new Auto-Response reaction to the NetOps Console Server appliance.

delete

Bulk delete a list of reactions defined for the NetOps Console Server appliance.

Retrieve or update configuration for a specific Auto-Response reaction.

get

Get the configuration of an Auto-Response reaction on the NetOps Console Server appliance.

put

Update settings for an Auto-Response reaction on the NetOps Console Server appliance.

delete

Delete an Auto-Response reaction on the NetOps Console Server appliance.

Read the AutoResponse Status on the NetOps Console Server appliance.

get

Get the status of the Auto-Response Beacons.

Read the status of Auto-Response beacons on the NetOps Console Server appliance.

get

Get the status of the Auto-Response Beacon

Read the AutoResponse Status of Beacon Modules on the NetOps Console Server appliance.

get

Get all the Beacon Modules and their resolution values that can be used to filter beacon events.

Get the status of a specific Auto-Response beacon module.

get

/ip_passthrough

IP Passthrough endpoints are for retrieving / changing IP Passthrough settings.

get

Retrieve the current IP Passthrough settings.

put

Set the IP Passthrough settings.

The IP Passthrough status endpoint provides information about what part of the IP Passthrough connection process the device is currently at and information about the connected downstream device.

get

Retrieve the current IP Passthrough status.

/access_rights

An access right is a permit granting the holder access to a feature or collection of related features.

get

Get a list of all known access rights.

Retrieve an access right by name.

get

/wireguards

Wireguard is a point-to-multipoint vpn. This entity provides access to the wireguard configurations on the system.

get

Retrieves all wireguard configurations.

post

Create a wireguard configuration.

Retrieve, update or remove a specific wireguard configuration.

get

Retrieve a wireguard configuration by id.

put

Update a wireguard configuration by id.

delete

Delete the wireguard configuration and stop that wireguard interface.