Summary
Ping an address
Description
Ping an address/port combination from an Adapter
Route
No Northbound API Available
Roles
admin
Parameters
DetailsExampleSchema
Name |
Type |
Required |
Description |
address |
string |
yes |
- |
port |
number |
yes |
- |
Copied to Clipboard
{
"address": "minim",
"port": 50075
}
Copied to Clipboard
{
"type": "object",
"properties": {
"address": {
"type": "string",
"title": "address",
"required": [
"address"
]
},
"port": {
"type": "number",
"title": "port",
"multipleOf": 1,
"minimum": 0,
"maximum": 65535
}
},
"required": [
"address",
"port"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
Name |
Type |
Description |
result |
object |
- |
Copied to Clipboard
{
"isFound": true,
"timeout": true,
"error": "deserunt"
}
Copied to Clipboard
{
"type": "object",
"title": "result",
"properties": {
"isFound": {
"type": "boolean"
},
"timeout": {
"type": "boolean"
},
"error": {
"type": "string"
}
},
"required": [
"isFound",
"timeout",
"error"
]
}