Itential Developers (DevGuides)

Updated on 10 Apr 2025

Dark

Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback!

These developer-focused guides are a knowledge resource for Itential Platform admins and operators. These articles aim to add additional usage examples, deep dive into code samples, or teach you how to use an API or feature.

A - R

Title	Description
Adapter API Routes	Expose adapter functionality using a web API
Adapter Degraded Status	Configure a degraded state for adapters that have multiple connection types
Broker Principal Config Setting	Build principal objects via broker calls to a local AAA adapter
Enumerations in Applications	Use ENUM to specify a list of constant values assigned to a type
Event System	Define the event system global service object to publish events
Events	Reference list of job events in the Platform and configuration sample for a job SLA
Integration API Routes	Deprecated feature. Legacy information and route example in an integration model
Log Class	Use log class to output errors and warnings to the console or log files
Naming Conventions	Rules around naming conventions for values inside of Itential Platform
Operations Manager Search APIs	Search APIs to support advanced query functionality for jobs and tasks
Public and Trusted Methods	How to set the protection key in pronghorn.json to support public or trusted methods
Run as Another User	How to use sudo function to run a method using the permissions of a different user

S - Z

Title	Description
Search API	How to expose database collections in custom applications to Itential Platform
Service Brokers	How to associate Itential Platform service with a broker
Service Config Property Encryption	How to configure property encryption in Hashicorp Vault for an application or adapter
Serving UI Directories	How to use the uiDirectories property to serve static files
Table Control	How to create Table Control for an Itential Platform page
URL Query Parameters	How to use URL query parameters to support queries via API function
User Account References	Best practices for user account references in the Platform
User Group References	Best practices for group references and how to query documents with referenced groups.
Using Query Parameters in API Requests	How to use query parameters to sort and filter data from APIs, or to implement pagination of large datasets

Was this article helpful?

What's Next

Adapter API Routes

Table of contents