Summary
Create a new integration.
Description
Create a new integration in IAP.
Route
POST /integrations
Roles
admin
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| properties |
object |
yes |
An object containing all the integration properties. |
Copied to Clipboard
{
"properties": {
"name": "",
"type": "Application",
"virtual": false,
"loggerProps": {
"log_max_files": 100,
"log_max_file_size": 1048576,
"log_level": "spam",
"log_directory": "/var/log/pronghorn",
"log_filename": "pronghorn.log",
"console_level": "info",
"description": "Logging",
"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": "5424",
"host": "localhost",
"port": 514,
"protocol": "udp4",
"pid": "process.pid",
"localhost": "",
"app_name": "",
"eol": "CR"
}
},
"isEncrypted": true,
"model": ""
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"properties": {
"title": "properties",
"type": "object",
"properties": {
"loggerProps": {
"$ref": "services-schema#/properties/loggerProps"
},
"isEncrypted": {
"$ref": "services-schema#/properties/isEncrypted"
},
"model": {
"$ref": "services-schema#/properties/model"
},
"name": {
"$ref": "services-schema#/properties/name"
},
"type": {
"$ref": "services-schema#/properties/type"
},
"properties": {
"$ref": "services-schema#/properties/properties"
},
"virtual": {
"$ref": "services-schema#/properties/virtual"
}
},
"required": [
"name",
"type",
"properties",
"virtual"
]
}
},
"required": [
"properties"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| result |
object |
The result of the integration creation process. |
Copied to Clipboard
{
"status": "Created",
"message": "A sample success message",
"data": {
"loggerProps": {
"log_max_files": 100,
"log_max_file_size": 1048576,
"log_level": "spam",
"log_directory": "/var/log/pronghorn",
"log_filename": "pronghorn.log",
"console_level": "info",
"description": "Logging",
"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": "5424",
"path": "",
"pid": "process.pid",
"localhost": "",
"app_name": "",
"eol": ""
}
},
"isEncrypted": false,
"model": "",
"name": "Local AAA",
"type": "Application",
"profiling": false,
"virtual": false,
"systemProps": {
"maxOldSpaceSize": 1024
},
"eventDeduplication": {
"active": true,
"cacheTtl": 10000,
"algorithm": "md5",
"uniqueProps": [
"/messageId"
]
}
}
}
