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": "local_aaa",
      "brokers": [
        "aaa",
        "aaa",
        "aaa",
        "aaa"
      ],
      "groups": [
        "pronghorn_admin",
        "pronghorn_admin",
        "pronghorn_admin",
        "pronghorn_admin",
        "pronghorn_admin"
      ]
    },
    "loggerProps": {
      "log_max_files": 100,
      "log_max_file_size": 1048576,
      "log_level": "spam",
      "log_directory": "/var/log/pronghorn",
      "log_filename": "pronghorn.log",
      "console_level": "warn",
      "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",
        "path": "",
        "pid": "process.pid",
        "localhost": "localhost",
        "app_name": "process.title",
        "eol": ""
      }
    },
    "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": {
          "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": "warn",
      "log_directory": "/var/log/pronghorn",
      "log_filename": "pronghorn.log",
      "console_level": "info",
      "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": "BSD",
        "host": "localhost",
        "port": 514,
        "protocol": "udp4",
        "pid": "process.pid",
        "localhost": "localhost",
        "app_name": "",
        "eol": ""
      }
    },
    "isEncrypted": false,
    "model": "@itential/adapter-local_aaa",
    "name": "",
    "type": "Application",
    "properties": {
      "id": "Local AAA",
      "type": "",
      "brokers": [
        "aaa"
      ],
      "groups": [
        "5fe9f10cc1fca243d562e1d8",
        "5fe9f10cc1fca243d562e1d8",
        "5fe9f10cc1fca243d562e1d8"
      ]
    },
    "profiling": true,
    "virtual": true
  }
}