For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Open sourceSupportFAQsDocs Home
DocumentationAPI ReferenceRelease notes
DocumentationAPI ReferenceRelease notes
  • Introduction
    • Overview
    • Authentication
  • Guides
    • Integration API routes
    • Operations Manager search APIs
    • Search API
    • URL query parameters
    • Use query parameters in API requests
  • Reference
        • POSTCreate a new profile
        • DELDelete a profile
        • GETExport a single profile
        • GETGet profile
        • POSTImport a new profile
        • GETList all profiles
        • PUTSwitch the active profile
        • PUTUpdate a profile
LogoLogo
Open sourceSupportFAQsDocs Home
ReferenceProfiles

Update a profile

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

Get prometheus metrics

Next
Built with

Authentication

AuthorizationBasic

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

Path parameters

idstringRequiredformat: "^[^\/]+$"
Contains the id for the selected profile.

Request

request body
propertiesobjectOptional

Response

The output of the update process.
statusenum
The status of the API request.
Allowed values:
messagestring
Message containing either confirmation of the operation or the reason for the failure of the operation.
dataobject
The root schema comprises the entire JSON document.

Errors

500
Internal Server Error