di-factory-api-ms2.json

{"apiVersion":"2.4-SNAPSHOT","apis":[{"description":"initializeGateway","operations":[{"method":"POST","summary":"Initialize Gateway data during production process","notes":"To be invoked by Gateway producers. Can only be invoked once for same serial number.Certificate expiry is configured as a property on the server. After this call, the deviceManagement and OpenVPN server must accept connections with the given certificates.","nickname":"initializeGateway","produces":["*/*"],"consumes":["application/json"],"parameters":[{"allowMultiple":false,"defaultValue":"","description":"gatewayParamsIn","name":"body","paramType":"body","type":"NewGatewayJsonIn","required":false}],"responseMessages":[{"code":200,"message":null,"responseModel":"NewGatewayJsonOut"},{"code":400,"message":"Invalid mac address / cipher type / gateway category / gateway type, Serial number or MAC adress already used","responseModel":"Void"},{"code":401,"message":"Operation not allowed","responseModel":"Void"},{"code":404,"message":"Unknown business unit key / location","responseModel":"Void"},{"code":500,"message":"mPrm not reachable","responseModel":"Void"}],"deprecated":"false","type":"NewGatewayJsonOut"}],"path":"/factory/gateway/initialize"}],"basePath":"/api","consumes":["application/json"],"models":{"NewGatewayJsonOut":{"description":"","id":"NewGatewayJsonOut","properties":{"serialNumber":{"description":"unique lifelong id of gateway","required":true,"type":"string"},"activationKey":{"description":"Independent unique code to be used for various purposes (activation, licensing...)","required":true,"type":"string"},"proSystCertificate":{"description":"initial certificate to connect gateway to prosyst device management in PEM format","required":true,"type":"string"},"proSystPrivateKey":{"description":"initial private Key im PEM format","required":true,"type":"string"},"openVPNCertificate":{"description":"initial certificate to open OpenVPN connection in PEM format","required":true,"type":"string"},"openVPNPrivateKey":{"description":"initial private Key im PEM format","required":true,"type":"string"},"webUIPassword":{"description":"password to grant access to gateway web ui","required":true,"type":"string"}}},"NewGatewayJsonIn":{"description":"","id":"NewGatewayJsonIn","properties":{"serialNumber":{"description":"unique lifelong id of gateway","required":true,"type":"string"},"businessUnitKey":{"description":"","required":true,"type":"string"},"locationKey":{"description":"","required":true,"type":"string"},"cipherType":{"description":"one of the currently allowed ciphers for this gateway type and category","required":true,"type":"string"},"gatewayCategoryKey":{"description":"","required":true,"type":"string"},"gatewayTypeKey":{"description":"","required":true,"type":"string"},"macAddress":{"description":"","required":true,"type":"string"}}}},"produces":["*/*"],"resourcePath":"/factory/gateway/initialize","swaggerVersion":"1.2"}