Summary
Creates a new profile
Description
Create a new profile in IAP.
Route
POST /profiles
Roles
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| properties | object | yes | An object containing all the profile properties. |
{ "properties": { "id": "profile1", "applicationProps": { "directory": "/opt/pronghorn/current/node_modules", "description": "Application" }, "uiProps": { "layout": "node_modules/@itential/pronghorn-core/ui/views/layout.jade", "home": "node_modules/@itential/pronghorn-core/ui/views/home.jade", "login": "node_modules/@itential/pronghorn-core/ui/views/login.jade", "profile": "node_modules/@itential/pronghorn-core/ui/views/profile.jade", "fav_icon": "node_modules/@itential/pronghorn-core/ui/img/favicon.ico", "description": "UI" }, "authenticationProps": { "uniqueSession": false, "admins": [ { "provenance": "", "group": "admin" }, { "provenance": "", "group": "admin" }, { "provenance": "", "group": "admin" }, { "provenance": "Local AAA", "group": "" } ], "description": "Authentication", "logoutTime": 20, "cookieName": "pronghorn_token", "brokerPrincipal": false }, "expressProps": { "express_http": { "enable": false, "port": 39200 }, "express_https": { "enable": true, "port": 31330, "key": "/opt/pronghorn/current/keys/key.pem", "cert": "/opt/pronghorn/current/keys/cert.pem", "secureProtocol": "TLSv1_2_method", "client_reneg_limit": 1, "client_reneg_window": 600, "passphrase": "deserunt aliqua culpa", "ciphers": "ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES128-GCM-SHA256" }, "description": "Express Server", "cacheControl": false, "timeout": 300000, "access_control_allow_origin": "*" }, "loggerProps": { "log_directory": "/var/log/pronghorn", "log_filename": "pronghorn.log", "log_max_file_size": 1048576, "log_max_files": 100, "log_level": "warn", "console_level": "warn", "description": "Logging", "log_timezone_offset": -5, "webserver": { "log_directory": "/var/log/pronghorn", "log_filename": "webserver.log" }, "syslog": { "level": "info", "facility": "local0", "type": "BSD", "path": "", "pid": "process.pid", "localhost": "localhost", "app_name": "", "eol": "CR" } }, "redisProps": { "host": "127.0.0.1", "port": 6379, "db": 0, "username": "admin", "password": "$ENC87eb897b507afc1796db49409dd1251c87872e85afd2469e", "maxRetriesPerRequest": 20, "maxHeartbeatWriteRetries": 20 }, "auditProps": { "audit": true, "brokerValidation": true, "description": "Audit" }, "pathProps": { "encrypted": true, "description": "Path Properties" }, "alarmProps": [ { "ip": "127.0.0.1", "community": "public", "properties": { "retries": 1, "timeout": 5000, "trapPort": 162, "version": "V1", "transport": "udp4" }, "type": "inform", "description": "Alarm" }, { "ip": "127.0.0.1", "community": "public", "properties": { "retries": 1, "timeout": 5000, "trapPort": 162, "version": "V1", "transport": "udp4" }, "type": "trap", "description": "Alarm" }, { "ip": "127.0.0.1", "community": "public", "properties": { "retries": 1, "timeout": 5000, "trapPort": 162, "version": "V1", "transport": "udp4" }, "type": "trap", "description": "Alarm" } ], "services": [ "WorkflowBuilder", "WorkflowBuilder", "WorkflowBuilder" ], "description": "An IAP Profile", "rabbitmq": { "protocol": "amqp", "hosts": "rabbitmq", "port": 32907, "username": "guest", "password": "", "locale": "en_US", "frameMax": 0, "heartbeat": 0, "vhost": "/", "eventDeduplication": { "active": false, "cacheTtl": 100, "cacheSize": 100, "cachePersistence": "memory", "messagePreservation": { "strategy": "automatic", "preserveMessages": true, "tempQueueName": "iap_event__TMP__", "shovelName": "preserve_iap_events", "shovelAckMode": "on-confirm", "shovelAddHeaders": false, "shovelPrefetchCount": 1000, "shovelReconnectDelay": 5, "maxTransferWait": 5, "transferWaitPollIncrement": 0.1 } }, "adminPort": 63460, "keyPath": "/opt/pronghorn/current/keys/key.pem", "certPath": "/opt/pronghorn/current/keys/cert.pem", "caPath": "/opt/pronghorn/current/keys/ca.crt", "passphrase": "culpa" }, "adapterStrategy": { "device": { "adapterTypes": [], "exceptions": { "runCommand": "" } } }, "systemProps": { "shutdownTimeout": 3, "servicesBlacklist": [ "Local AAA", "Local AAA", "Local AAA", "Local AAA" ], "launchDelay": 5, "launchTimeout": 60, "deadProcessCheck": true, "deadProcessCheckInterval": 5, "deadProcessMaxPeriod": 15, "externalRequestTimeout": 5 }, "integrationProps": { "threadCount": 5, "timeout": 15000 }, "retryStrategy": { "maxRetries": 10, "retryResetTimer": 60000 } } }
{ "type": "object", "properties": { "properties": { "title": "properties", "type": "object", "properties": { "applicationProps": { "$ref": "profiles-schema#/properties/applicationProps" }, "uiProps": { "$ref": "profiles-schema#/properties/uiProps" }, "authenticationProps": { "$ref": "profiles-schema#/properties/authenticationProps" }, "expressProps": { "$ref": "profiles-schema#/properties/expressProps" }, "loggerProps": { "$ref": "profiles-schema#/properties/loggerProps" }, "redisProps": { "$ref": "profiles-schema#/properties/redisProps" }, "auditProps": { "$ref": "profiles-schema#/properties/auditProps" }, "pathProps": { "$ref": "profiles-schema#/properties/pathProps" }, "alarmProps": { "$ref": "profiles-schema#/properties/alarmProps" }, "id": { "$ref": "profiles-schema#/properties/id" }, "services": { "$ref": "profiles-schema#/properties/services" }, "description": { "$ref": "profiles-schema#/properties/description" }, "rabbitmq": { "$ref": "profiles-schema#/properties/rabbitmq" }, "adapterStrategy": { "$ref": "profiles-schema#/properties/adapterStrategy" }, "systemProps": { "$ref": "profiles-schema#/properties/systemProps" }, "integrationProps": { "$ref": "profiles-schema#/properties/integrationProps" }, "retryStrategy": { "$ref": "profiles-schema#/properties/retryStrategy" } }, "required": [ "id" ] } }, "required": [ "properties" ], "additionalProperties": false }
Return
| Name | Type | Description |
|---|---|---|
| result | object | The output of the profile creation process. |
{ "status": "OK", "message": "A sample success message", "data": { "applicationProps": { "directory": "/opt/pronghorn/current/node_modules", "description": "Application" }, "uiProps": { "layout": "node_modules/@itential/pronghorn-core/ui/views/layout.jade", "home": "node_modules/@itential/pronghorn-core/ui/views/home.jade", "login": "node_modules/@itential/pronghorn-core/ui/views/login.jade", "profile": "node_modules/@itential/pronghorn-core/ui/views/profile.jade", "fav_icon": "node_modules/@itential/pronghorn-core/ui/img/favicon.ico", "description": "UI" }, "authenticationProps": { "uniqueSession": false, "admins": [ { "provenance": "Local AAA", "group": "" }, { "provenance": "Local AAA", "group": "admin" }, { "provenance": "Local AAA", "group": "admin" }, { "provenance": "Local AAA", "group": "admin" } ], "description": "Authentication", "logoutTime": 60, "cookieName": "pronghorn_token", "brokerPrincipal": false }, "expressProps": { "express_http": { "enable": false, "port": 53342 }, "express_https": { "enable": true, "port": 47077, "key": "/opt/pronghorn/current/keys/key.pem", "cert": "/opt/pronghorn/current/keys/cert.pem", "secureProtocol": "TLSv1_2_method", "client_reneg_limit": 1, "client_reneg_window": 600, "passphrase": "cupidatat voluptate eu", "ciphers": "ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES128-GCM-SHA256" }, "description": "Express Server", "cacheControl": false, "timeout": 300000, "access_control_allow_origin": "*" }, "loggerProps": { "log_directory": "/var/log/pronghorn", "log_filename": "pronghorn.log", "log_max_file_size": 1048576, "log_max_files": 100, "log_level": "spam", "console_level": "debug", "description": "Logger Settings", "log_timezone_offset": -5, "webserver": { "log_directory": "/var/log/pronghorn", "log_filename": "webserver.log" }, "syslog": { "level": "error", "facility": "local0", "type": "5424", "path": "/dev/log", "pid": "process.pid", "localhost": "", "app_name": "process.title", "eol": "" } }, "redisProps": { "host": "127.0.0.1", "port": 6379, "db": 0, "username": "admin", "password": "$ENC87eb897b507afc1796db49409dd1251c87872e85afd2469e", "maxRetriesPerRequest": 20, "maxHeartbeatWriteRetries": 20 }, "auditProps": { "audit": true, "brokerValidation": true, "description": "Audit" }, "pathProps": { "encrypted": true, "description": "Path Properties" }, "alarmProps": [ { "ip": "127.0.0.1", "community": "public", "properties": { "retries": 1, "timeout": 5000, "trapPort": 162, "version": "V1", "transport": "udp4" }, "type": "inform", "description": "Alarm" }, { "ip": "127.0.0.1", "community": "public", "properties": { "retries": 1, "timeout": 5000, "trapPort": 162, "version": "V1", "transport": "udp4" }, "type": "trap", "description": "Alarm" }, { "ip": "127.0.0.1", "community": "public", "properties": { "retries": 1, "timeout": 5000, "trapPort": 162, "version": "V1", "transport": "udp4" }, "type": "trap", "description": "Alarm" } ], "id": "profile1", "services": [ "WorkflowBuilder", "WorkflowBuilder", "WorkflowBuilder", "WorkflowBuilder" ], "description": "An IAP Profile", "rabbitmq": { "protocol": "amqp", "hosts": "rabbitmq", "port": 28217, "username": "guest", "password": "guest", "locale": "en_US", "frameMax": 0, "heartbeat": 0, "vhost": "/", "eventDeduplication": { "active": false, "cacheTtl": 100, "cacheSize": 100, "cachePersistence": "memory", "messagePreservation": { "strategy": "automatic", "preserveMessages": true, "tempQueueName": "iap_event__TMP__", "shovelName": "preserve_iap_events", "shovelAckMode": "on-confirm", "shovelAddHeaders": false, "shovelPrefetchCount": 1000, "shovelReconnectDelay": 5, "maxTransferWait": 5, "transferWaitPollIncrement": 0.1 } }, "adminPort": 51149, "keyPath": "/opt/pronghorn/current/keys/key.pem", "certPath": "/opt/pronghorn/current/keys/cert.pem", "caPath": "/opt/pronghorn/current/keys/ca.crt", "passphrase": "amet officia" }, "adapterStrategy": { "device": { "adapterTypes": [], "exceptions": { "runCommand": "" } } }, "systemProps": { "shutdownTimeout": 3, "servicesBlacklist": [ "Local AAA", "Local AAA", "Local AAA", "Local AAA", "Local AAA" ], "launchDelay": 5, "launchTimeout": 60, "deadProcessCheck": true, "deadProcessCheckInterval": 5, "deadProcessMaxPeriod": 15, "externalRequestTimeout": 5 }, "prebuiltProps": { "repoConfigs": { "@itentialopensource": { "enabled": false, "type": "gitlab", "hostname": "gitlab.com", "path": "itentialopensource/pre-built-automations", "credentials": { "token": "uTc_P4pnMAEsLbQHmyOt" } } } }, "integrationProps": { "threadCount": 5, "timeout": 15000 }, "retryStrategy": { "maxRetries": 10, "retryResetTimer": 30000 } } }
{ "title": "result", "type": "object", "properties": { "status": { "$ref": "common-schema#/definitions/status" }, "message": { "$ref": "common-schema#/definitions/message" }, "data": { "$ref": "profiles-schema" } } }