Summary
Create a new adapter.
Description
Create a new adapter in IAP.
Route
POST /adapters
Roles
admin
Parameters
DetailsExampleSchema
Name |
Type |
Required |
Description |
properties |
object |
yes |
An object containing all the adapter properties. |
Copied to Clipboard
{
"properties": {
"name": "Local AAA",
"type": "Application",
"properties": {
"id": "Local AAA",
"type": "Email",
"brokers": [
"aaa"
],
"groups": [
"pronghorn_admin",
"pronghorn_admin"
]
},
"loggerProps": {
"log_max_files": 100,
"log_max_file_size": 1048576,
"log_level": "error",
"log_directory": "/var/log/pronghorn",
"log_filename": "pronghorn.log",
"console_level": "error",
"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": "warning",
"facility": "local0",
"type": "BSD",
"path": "",
"pid": "process.pid",
"localhost": "localhost",
"app_name": "",
"eol": ""
}
},
"isEncrypted": false,
"model": "@itential/adapter-local_aaa"
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"properties": {
"title": "properties",
"type": "object",
"properties": {
"loggerProps": {
"$ref": "services-schema#/definitions/loggerProps"
},
"isEncrypted": {
"$ref": "services-schema#/definitions/isEncrypted"
},
"model": {
"$ref": "services-schema#/definitions/model"
},
"name": {
"$ref": "services-schema#/definitions/name"
},
"type": {
"$ref": "services-schema#/definitions/type"
},
"properties": {
"type": "object",
"properties": {
"id": {
"type": "string",
"title": "id",
"description": "The id for the service",
"const": {
"$data": "2/name"
},
"examples": [
"Local AAA"
]
},
"type": {
"type": "string",
"title": "Type",
"description": "The type of an adapter",
"examples": [
"local_aaa",
"Redis",
"Email"
]
},
"properties": {
"type": "object",
"properties": {}
},
"brokers": {
"type": "array",
"description": "Brokers which utilize this service",
"items": {
"type": "string",
"description": "Name of the broker",
"examples": [
"aaa"
]
}
},
"groups": {
"type": "array",
"description": "Groups which can use this service",
"items": {
"type": "string",
"description": "Name of the group",
"examples": [
"pronghorn_admin"
]
}
}
},
"required": [
"id",
"type"
]
}
},
"required": [
"name",
"type",
"properties"
]
}
},
"required": [
"properties"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
Name |
Type |
Description |
result |
object |
The result of the adapter creation process. |
Copied to Clipboard
{
"status": "OK",
"message": "A sample success message",
"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": "spam",
"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": "info",
"facility": "local0",
"type": "BSD",
"host": "localhost",
"port": 514,
"protocol": "udp4",
"pid": "process.pid",
"localhost": "",
"app_name": "process.title",
"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": false,
"systemProps": {
"maxOldSpaceSize": 2048
},
"eventDeduplication": {
"active": true,
"cacheTtl": 10000,
"uniqueProps": [
"/messageId",
"/messageId"
]
}
}
}