Export a single profile

GET

https://example.itential.io/profiles/:id/export

GET

/profiles/:id/export

$ curl https://example.itential.io/profiles/id/export \
>      -u "<username>:<password>"

1 {
2   "uiProps": {
3     "description": "UI",
4     "layout": "node_modules/@itential/pronghorn-core/ui/views/layout.jade",
5     "home": "node_modules/@itential/pronghorn-core/ui/views/home.jade",
6     "login": "node_modules/@itential/pronghorn-core/ui/views/login.jade",
7     "profile": "node_modules/@itential/pronghorn-core/ui/views/profile.jade",
8     "fav_icon": "node_modules/@itential/pronghorn-core/ui/img/favicon.ico"
9   },
10   "authenticationProps": {
11     "description": "Authentication",
12     "logoutTime": 20,
13     "principalTimeout": 20,
14     "relayStateTimeout": 600,
15     "uniqueSession": false,
16     "admins": [
17       {
18         "provenance": "Local AAA",
19         "group": "admin"
20       }
21     ],
22     "cookieName": "pronghorn_token",
23     "brokerPrincipal": false
24   },
25   "expressProps": {
26     "description": "Express Server",
27     "cacheControl": false,
28     "timeout": 300000,
29     "access_control_allow_origin": "*",
30     "express_http": {
31       "enable": false,
32       "port": 1
33     },
34     "express_https": {
35       "enable": true,
36       "port": 1,
37       "key": "/opt/pronghorn/current/keys/key.pem",
38       "passphrase": "string",
39       "cert": "/opt/pronghorn/current/keys/cert.pem",
40       "secureProtocol": "TLSv1_2_method",
41       "tlsMinVersion": "TLSv1.3",
42       "tlsMaxVersion": "TLSv1.3",
43       "ciphers": "ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES128-GCM-SHA256",
44       "client_reneg_limit": 1,
45       "client_reneg_window": 600
46     },
47     "allowedHttpOptionalVerbs": [
48       "ACL"
49     ]
50   },
51   "loggerProps": {
52     "description": "Logging",
53     "log_directory": "/var/log/pronghorn",
54     "log_filename": "pronghorn.log",
55     "log_max_file_size": 1048576,
56     "log_max_files": 100,
57     "log_level": "error",
58     "console_level": "error",
59     "log_format_json": false,
60     "console_format_json": false,
61     "webserver": {
62       "log_directory": "/var/log/pronghorn",
63       "log_filename": "webserver.log"
64     },
65     "syslog": {
66       "level": "debug",
67       "host": "localhost",
68       "port": 514,
69       "protocol": "udp4",
70       "facility": "local0",
71       "type": "5424",
72       "path": "/dev/log",
73       "pid": "process.pid",
74       "localhost": "localhost",
75       "app_name": "process.title",
76       "eol": "CR",
77       "format_json": false
78     }
79   },
80   "redisProps": {
81     "host": "127.0.0.1",
82     "port": 6379
83   },
84   "auditProps": {
85     "description": "Audit",
86     "audit": true,
87     "brokerValidation": true
88   },
89   "pathProps": {
90     "description": "string",
91     "encrypted": true
92   },
93   "alarmProps": [
94     {
95       "description": "string",
96       "ip": "127.0.0.1",
97       "community": "public",
98       "properties": {
99         "retries": 1,
100         "timeout": 5000,
101         "transport": "udp4",
102         "trapPort": 162,
103         "version": "V1"
104       },
105       "type": "trap"
106     }
107   ],
108   "id": "profile1",
109   "services": [
110     "WorkflowBuilder"
111   ],
112   "description": "An IAP Profile",
113   "adapterStrategy": {
114     "device": {
115       "adapterTypes": [
116         "NSO"
117       ],
118       "exceptions": {
119         "runCommand": "string"
120       }
121     }
122   },
123   "systemProps": {
124     "shutdownTimeout": 3,
125     "servicesBlacklist": [
126       "Local AAA"
127     ],
128     "launchDelay": 5,
129     "launchTimeout": 60,
130     "serviceHealthCheckInterval": 1,
131     "serviceHealthCheckUnhealthyThreshold": 1,
132     "deadProcessCheck": false,
133     "deadProcessCheckInterval": 5,
134     "deadProcessMaxPeriod": 15,
135     "externalRequestTimeout": 5,
136     "deviceCountPollingInterval": 24,
137     "serverIdStrategy": "mac:port",
138     "eventWorkerCount": 3,
139     "transformationWorkerCount": 3,
140     "taskWorkerThreadCount": 1,
141     "taskWorkerRateLimit": 0,
142     "taskWorkerRateLimitPeriod": 1
143   },
144   "prebuiltProps": {
145     "repoConfigs": {
146       "@itentialopensource": {
147         "enabled": true,
148         "type": "gitlab",
149         "hostname": "gitlab.com",
150         "path": "itentialopensource/pre-built-automations",
151         "credentials": {
152           "token": "uTc_P4pnMAEsLbQHmyOt"
153         }
154       }
155     }
156   },
157   "integrationProps": {
158     "threadCount": 5,
159     "timeout": 15000
160   },
161   "retryStrategy": {
162     "maxRetries": 5,
163     "retryResetTimer": 30000
164   },
165   "serviceDirectory": "string"
166 }

Exports a single profile in the current Itential Platform.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

idstringRequiredformat: "^[^\/]+$"

Contains the id for the selected profile.

Response

Contains the metadata and data of a profile.

uiPropsobjectOptional

authenticationPropsobjectOptional

expressPropsobjectOptional

loggerPropsobjectOptional

redisPropsobjectOptional

auditPropsobjectOptional

pathPropsobjectOptional

alarmPropslist of objectsOptional

idstringOptionalformat: "^[^\/]+$"

serviceslist of stringsOptional

descriptionstringOptional

adapterStrategyobjectOptional

systemPropsobjectOptional

Properties used to configure IAP process.

prebuiltPropsobjectOptional

integrationPropsobjectOptional

retryStrategyobjectOptional

Properties used to configure the strategy services use on crash.

serviceDirectorystringOptional

Directory at which to find additional services.

Errors

500

Internal Server Error