Summary
Update the properties of an adapter.
Description
Update the properties of an adapter in IAP.
Route
PUT /adapters/:name/properties
Roles
admin
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| name |
string |
yes |
The name for the selected adapter. |
| properties |
object |
yes |
An object containing only the adapter properties. |
Copied to Clipboard
{
"properties": {
"title": "properties"
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"properties": {
"title": "properties"
}
},
"required": [
"properties"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| result |
object |
The output of the adapter properties update process. |
Copied to Clipboard
{
"status": "Created",
"message": "A sample success message",
"data": {
"loggerProps": {
"log_max_files": 100,
"log_max_file_size": 1048576,
"log_level": "trace",
"log_directory": "/var/log/pronghorn",
"log_filename": "pronghorn.log",
"console_level": "spam",
"description": "Logger Settings",
"log_timezone_offset": -5,
"metrics_filename": "metrics.log",
"metrics_max_files": 31,
"metrics_rotation_interval": "7d",
"metrics_rotation_size": "10M",
"syslog": {
"level": "debug",
"facility": "local0",
"type": "5424",
"host": "localhost",
"port": 514,
"protocol": "udp4",
"pid": "process.pid",
"localhost": "localhost",
"app_name": "",
"eol": "CR"
}
},
"isEncrypted": false,
"model": "@itential/adapter-local_aaa",
"name": "",
"type": "Application",
"properties": {
"id": "",
"type": "",
"brokers": [
"aaa"
],
"groups": [
"5fe9f10cc1fca243d562e1d8",
"5fe9f10cc1fca243d562e1d8",
"5fe9f10cc1fca243d562e1d8"
]
},
"profiling": false,
"virtual": false,
"systemProps": {
"maxOldSpaceSize": 1024
},
"eventDeduplication": {
"active": false,
"cacheTtl": 10000,
"algorithm": "md5",
"uniqueProps": [
"/messageId",
"/messageId",
"/messageId",
"/messageId"
]
}
}
}
