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
        • GETGet the adapter schema
        • GETGet the application schema
        • GETGet the integration schema
        • GETGet the profile schema
LogoLogo
Open sourceSupportFAQsDocs Home
ReferenceSchema

Get the profile schema

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

Search Itential Platform

Next
Built with

Authentication

AuthorizationBasic

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

Response

Contains the schema for profiles.
schemaobject
The root schema comprises the entire JSON document.
decoratorslist of objects

Errors

500
Internal Server Error