Summary
Import an artifact
Description
Imports an artifact onto an IAP environment.
Route
POST /admin/artifacts/import
Roles
admin
Parameters
DetailsExampleSchema
Name |
Type |
Required |
Description |
artifact |
object |
yes |
Contains metadata and content for the selected artifact. |
Copied to Clipboard
{
"artifact": {
"metadata": {
"name": "device-connection-health-check",
"version": "0.0.1",
"description": "Description about the functionality of an artifact",
"author": "Itential Artifacts",
"license": "Apache-2.0",
"repository": {
"type": "git",
"url": "https://gitlab.com:itentialopensource/pre-built-automations/content-workflow.git"
},
"keywords": [
"Itential",
"Itential",
"Itential",
"Itential",
"Itential"
],
"gitlabId": 17866482
},
"manifest": {
"bundleName": "Content-Workflow",
"fingerprint": "5e84f892c5eab11ec2eee16d",
"createdEpoch": "1585772690392",
"artifacts": [
{
"id": "5e5ea3bd16da51d52b4a8f9f",
"name": "device-connection-health-check",
"type": "json-forms",
"location": "/bundles/workflows/IAP Test Artifact Workflow.json"
},
{
"id": "5e5ea3bd16da51d52b4a8f9f",
"name": "device-connection-health-check",
"type": "template",
"location": "/bundles/workflows/IAP Test Artifact Workflow.json"
},
{
"id": "5e5ea3bd16da51d52b4a8f9f",
"name": "device-connection-health-check",
"type": "template",
"location": "/bundles/workflows/IAP Test Artifact Workflow.json"
},
{
"id": "5e5ea3bd16da51d52b4a8f9f",
"name": "device-connection-health-check",
"type": "forms",
"location": "/bundles/workflows/IAP Test Artifact Workflow.json"
}
]
},
"bundles": [
{
"type": "workflow"
},
{
"type": "workflow"
},
{
"type": "workflow"
},
{
"type": "workflow"
},
{
"type": "workflow"
}
],
"readme": "example of readme"
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"artifact": {
"title": "artifact",
"$ref": "artifact-schema"
}
},
"required": [
"artifact"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
Name |
Type |
Description |
result |
object |
The result of the install process contains the status of the command. |
Copied to Clipboard
{
"success": true,
"message": "in nulla non",
"created": {
"applicationProps": {
"directory": "./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": "pronghorn_admin"
},
{
"provenance": "Local AAA",
"group": "pronghorn_admin"
},
{
"provenance": "Local AAA",
"group": "pronghorn_admin"
},
{
"provenance": "Local AAA",
"group": "pronghorn_admin"
}
],
"description": "audit"
},
"expressProps": {
"express_http": {
"enable": true,
"port": 3000
},
"express_https": {
"enable": true,
"port": 3443,
"key": "./keys/key.pem",
"cert": "./keys/cert.pem",
"secureProtocol": "TLSv1_2_method",
"client_reneg_limit": 1,
"client_reneg_window": 600
},
"cacheControl": false,
"description": "Express Server"
},
"loggerProps": {
"log_max_files": 100,
"log_max_file_size": 1048576,
"log_level": "error",
"log_directory": "/var/log/pronghorn",
"log_filename": "pronghorn.log",
"console_level": "info",
"description": "Logging",
"log_timezone_offset": -5,
"syslog": {
"level": "error",
"facility": "local0",
"type": "BSD",
"host": "localhost",
"port": 514,
"protocol": "udp4",
"pid": "process.pid",
"localhost": "localhost",
"app_name": "process.title",
"eol": ""
}
},
"redisProps": {
"host": "localhost",
"port": 6379,
"db": 0,
"password": "$ENC87eb897b507afc1796db49409dd1251c87872e85afd2469e"
},
"auditProps": {
"audit": true,
"brokerValidation": true,
"description": "Audit"
},
"pathProps": {
"encrypted": false,
"description": "File Path Variables"
},
"alarmProps": {
"ip": "127.0.0.1",
"community": "public",
"properties": {
"port": 161,
"retries": 1,
"timeout": 5000,
"transport": "udp4",
"trapPort": 162,
"version": "V1"
},
"type": "trap"
},
"id": "profile1",
"services": [
"FormBuilder",
"FormBuilder",
"FormBuilder",
"WorkflowBuilder"
],
"description": "An IAP Profile",
"rabbitmq": {
"protocol": "amqp",
"hosts": "rabbitmq",
"port": 63482,
"username": "guest",
"password": "guest",
"locale": "en_US",
"frameMax": 0,
"heartbeat": 0,
"vhost": "/"
},
"adapterStrategy": {
"device": {
"adapterTypes": [],
"exceptions": {
"runCommand": ""
}
}
},
"systemProps": {
"integrationsThreadCount": 5
}
}
}