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
    • 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

Get profile

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

Import a new profile

Next
Built with

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.
metadataobject
profileobject
The root schema comprises the entire JSON document.

Errors

500
Internal Server Error