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

List all profiles

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

Switch the active profile

Next
Built with

Authentication

AuthorizationBasic

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

Query parameters

containsstringOptional
contains
containsFieldstringOptional
containsField
equalsstringOptional
equals
equalsFieldstringOptional
equalsField
startsWithstringOptional
startsWith
startsWithFieldstringOptional
startsWithField
skipintegerOptional>=0Defaults to 0
skip
limitintegerOptional>=0Defaults to 25
limit
sortenumOptionalDefaults to name
sort
Allowed values:
orderenumOptionalDefaults to 1
order
Allowed values:

Response

Contains the data of a profile.
resultslist of objects
totalinteger>=0
The total number of documents

Errors

500
Internal Server Error