Перейти к основному содержимому
API docs by Redocly

Open Ports Monitoring API (v0.0.1)

Enabling and disabling open port monitoring for an IP address, viewing a list of open ports on an IP address, and tagging trusted open ports

IPs

Operations with IP addresses for scanning

Connect the IP address to the Monitoring service

Authorizations:
X-Token
Request Body schema: application/json

IP address that you want to connect to the service

ip
required
string

Responses

Request samples

Content type
application/json
{
  • "ip": "192.168.100.2"
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "result": {
    }
}

Get a list of IP addresses that are connected to the Monitoring service

Authorizations:
X-Token

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Disconnect the IP address from the Monitoring service

Authorizations:
X-Token
Request Body schema: application/json

IP address to be disconnected from the service

ip
required
string

Responses

Request samples

Content type
application/json
{
  • "ip": "192.168.100.2"
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "result": "Successful deletion of the IP address"
}

Ports

Operations with open ports after scanning

Get a list of open ports of all IPs or a specific IP

Authorizations:
X-Token
Request Body schema: application/json

(Optional) The IP address for which to get a list of open ports

ip
string

Responses

Request samples

Content type
application/json
{
  • "ip": "192.168.100.2"
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "result": {
    }
}

Set the "trusted" tag for open ports of a specific IP or all IPs connected to the service

Authorizations:
X-Token
Request Body schema: application/json

(Optional) IP address whose open ports you want to set as "trusted"

ip
string

Responses

Request samples

Content type
application/json
{
  • "ip": "192.168.100.2"
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "result": "Successful tag change for 1 ports"
}

Get the status of a specific port for the selected IP

Authorizations:
X-Token
path Parameters
port
required
string
Example: 22

Open port number

Request Body schema: application/json

IP address

ip
required
string

Responses

Request samples

Content type
application/json
{
  • "ip": "192.168.100.2"
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "result": {
    }
}

Change the KNOWN tag for the open port of the selected IP

Authorizations:
X-Token
path Parameters
port
required
string
Example: 22

Open port number

Request Body schema: application/json

IP address

ip
required
string

Responses

Request samples

Content type
application/json
{
  • "ip": "192.168.100.2"
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "result": "Successful tag change for 1 ports"
}