Summary
Get all adapters.
Description
Get all adapters in IAP.
Route
GET /adapters
Roles
admin
apiread
Parameters
DetailsExampleSchema
Name |
Type |
Required |
Description |
queryOptions |
object |
yes |
Options for query parameters. |
Copied to Clipboard
{
"queryOptions": {
"contains": "redis",
"containsField": "name",
"equals": "redis",
"equalsField": "name",
"startsWith": "redis",
"startsWithField": "name",
"skip": 1,
"limit": 10,
"sort": "name",
"order": 1,
"skipActiveSync": false
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"queryOptions": {
"title": "queryOptions",
"type": "object",
"properties": {
"contains": {
"type": "string",
"examples": [
"redis"
]
},
"containsField": {
"type": "string",
"examples": [
"name"
]
},
"equals": {
"type": "string",
"examples": [
"redis"
]
},
"equalsField": {
"type": "string",
"examples": [
"name"
]
},
"startsWith": {
"type": "string",
"examples": [
"redis"
]
},
"startsWithField": {
"type": "string",
"examples": [
"name"
]
},
"skip": {
"$ref": "common-schema#/definitions/skip"
},
"limit": {
"$ref": "common-schema#/definitions/limit"
},
"sort": {
"$ref": "common-schema#/definitions/sort"
},
"order": {
"$ref": "common-schema#/definitions/order"
},
"skipActiveSync": {
"type": "boolean",
"default": false
}
}
}
},
"required": [
"queryOptions"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
Name |
Type |
Description |
results |
object |
Contains an array of adapters and the total in the response. |
Copied to Clipboard
{
"results": [
{
"metadata": {
"isActive": true,
"activeSync": true
},
"data": {
"loggerProps": {
"log_max_files": 100,
"log_max_file_size": 1048576,
"log_level": "warn",
"log_directory": "/var/log/pronghorn",
"log_filename": "pronghorn.log",
"console_level": "warn",
"description": "Logging",
"log_timezone_offset": -5,
"metrics_filename": "metrics.log",
"metrics_max_files": 31,
"metrics_rotation_interval": "7d",
"metrics_rotation_size": "10M",
"syslog": {
"level": "warning",
"facility": "local0",
"type": "5424",
"host": "localhost",
"port": 514,
"protocol": "udp4",
"pid": "process.pid",
"localhost": "",
"app_name": "process.title",
"eol": "CR"
}
},
"isEncrypted": false,
"model": "",
"name": "",
"type": "Application",
"profiling": false,
"virtual": true,
"systemProps": {
"maxOldSpaceSize": 2048
},
"eventDeduplication": {
"active": true,
"cacheTtl": 10000,
"uniqueProps": [
"/messageId",
"/messageId",
"/messageId",
"/messageId",
"/messageId"
]
}
}
},
{
"metadata": {
"isActive": true,
"activeSync": true
},
"data": {
"loggerProps": {
"log_max_files": 100,
"log_max_file_size": 1048576,
"log_level": "info",
"log_directory": "/var/log/pronghorn",
"log_filename": "pronghorn.log",
"console_level": "trace",
"description": "Logger Settings",
"log_timezone_offset": 0,
"metrics_filename": "metrics.log",
"metrics_max_files": 31,
"metrics_rotation_interval": "7d",
"metrics_rotation_size": "10M",
"syslog": {
"level": "error",
"facility": "local0",
"type": "BSD",
"path": "/dev/log",
"pid": "process.pid",
"localhost": "",
"app_name": "",
"eol": ""
}
},
"isEncrypted": true,
"model": "@itential/adapter-local_aaa",
"name": "",
"type": "Application",
"properties": {
"id": "Local AAA",
"type": "",
"brokers": [
"aaa"
],
"groups": [
"5fe9f10cc1fca243d562e1d8",
"5fe9f10cc1fca243d562e1d8",
"5fe9f10cc1fca243d562e1d8"
]
},
"profiling": false,
"virtual": true,
"systemProps": {
"maxOldSpaceSize": 1024
},
"eventDeduplication": {
"active": false,
"cacheTtl": 10000,
"uniqueProps": [
"/messageId",
"/messageId"
]
}
}
}
],
"total": 50
}