For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Open source Support FAQs Docs Home

Documentation API reference Release notes

Documentation API reference Release notes

Introduction
- Overview
- Authentication
Guides
Reference

Overview
Authentication
Operations Manager search APIs
Search API
URL query parameters
Use query parameters in API requests
List available adapter model types
Create a new adapter
Delete an adapter
Export a single adapter
Get a mapping between brokers and adapters
Get adapter
Import a new adapter
List all adapters
List changelogs
Restart an adapter
Start an adapter
Stop an adapter
Update an adapter
Update the log levels
Update the properties of an adapter
Clear a stale discovery lock
Discover actions on one IAG adapter
Get the current pronghorn model stored in redis
List all adapters in all clusters
Merge discovered actions from all IAG adapters
Remove discovered actions from all IAG adapters
Remove discovered actions from one IAG adapter
Receive a tool execution result
Run an agent
Create a new FlowAI project
Create an agent in a FlowAI project
Delete a FlowAI project
Delete an agent from a FlowAI project
Delete any agent project as an admin
Export a FlowAI project
Get a FlowAI project by ID
Get a provider profile by ID
Get an agent by ID
Get an operable agent by ID
Import a FlowAI project
List accessible agent names
List all agent projects as an admin
List FlowAI projects
List operable agent names
List operable agents
List provider profiles
Update a FlowAI project
Update an agent in a FlowAI project
Update any agent project as an admin
Delete a session
Get a session by ID
Get a single raw message by event ID
Get distinct trigger source options
Get messages for a session
List all sessions
Run an agent in your workflow
Start a new agent session
Update session state
Get application
List all applications
List changelogs
Restart an application
Start an application
Stop an application
Update an application
Update the log levels
Update the properties of an application
Download a public file from Itential Platform
Get authentication metadata
Get session time-to-live
Get system server ID
Get the authorization data for the logged in user
Get the principal document for the active user
Get the session document for the active user
Get the user profile for the active user
Get version
Get whether or not single sign on is enabled
List all application configs
Log in and create a session in Itential Platform
Log in using single sign-on
Log out of Itential Platform
SAML identity provider callback
Test SSO login configuration
Update the user profile for the active user
Create a group
Create a role
Delete a group
Delete a role
Extract CSV data of accounts, groups, and roles
Force a user to log out
Get a list of groups
Get a list of methods
Get a list of roles
Get a list of views
Get a simplified list of groups
Get an individual account
Get an individual group
Get an individual role
List all accounts
Update a group
Update a role
Update an account
Add one or more components to project
Create a new component group document
Create a new project
Create a new template document
Create a new workflow document
Delete a component group document
Delete a project and any components it contains
Delete a template document
Discover referenced resources
Export a template document
Export project as JSON document
Get a list of all the apps and adapters
Get a page of component group documents
Get a page of template documents
Get a page of workflow documents
Get a project's thumbnail
Get component group document
Get details of a workflow
Get project
Get references to a particular document
Get task details
Get task details
Get template document
Import a new component group document
Import a new template document
Import a new workflow document
Import a project document from a JSON document
List all available rest calls
Remove a component from a project
Replace a component group document
Replace a template document
Replace a workflow document
Search projects
Set a project's thumbnail image
Update an existing project
Validate a workflow
Add a new Golden Config tree
Add a new Golden Config tree
Add device groups to node
Add device(s) to a group
Add devices to node
Add new devices to the group
Add node(s) to a compliance plan
Add or remove a pinned item
Add tasks to node
Alters a device configuration
Alters a device configuration
Apply a device config
Apply a device config template
Back up device configuration
Build a config spec from raw config
Call adapter method
Check if CM is a maintenance version
Check if device is connected
Compliance reports totals for a backup
Compliance reports totals for a device
Compliance reports totals for a task instance
Convert a config spec into a readable string
Convert patch data to native config
Create a compliance plan
Create a config parser
Create a config spec
Create a device group
Create a device template
Create a JSON spec
Create a task instance
Create Golden Config node
Delete a config parser
Delete a Golden Config tree
Delete a Golden Config tree
Delete compliance plans
Delete device groups
Delete device groups
Delete device(s) from a group
Delete Golden Config node
Delete Golden Config trees
Delete one or more config parsers by ID
Delete one or more device backups by ID
Delete one or more device template(s) by ID
Delete one or more variables
Delete pinned items
Delete task instance(s)
Delete the cache for OS types
Diff two strings from a lookup
Export a Golden Config tree
Fetch a compliance plan
Fetch all the devices that exist on a tree
Fetch devices to store into the cache
Fetch OS types to store into the cache
Fetch the OS types stored in the cache
Find devices
Find trees which contain the specified device
Get a config parser
Get a config spec document
Get a config spec template
Get a device template
Get a JSON spec document
Get a JSON spec document with inheritance
Get a list of all backed up devices
Get a list of all Golden Config trees
Get a list of pinned items
Get a summary of compliance plans
Get average scores for a compliance plan over a period
Get backup history for a device
Get compliance check details
Get compliance details for a device across its compliance plans
Get compliance report
Get compliance report metadata for a batch
Get compliance report metadata for a batch
Get compliance report node summary
Get compliance scores from reports grouped by plan over a period
Get connection audit history for a device
Get connection info for a device
Get data for a specific adapter task
Get data for all adapters with tasks
Get details of a Golden Config tree version
Get device backup
Get device backup list
Get device configuration
Get device details
Get device group by ID
Get device group by name
Get device groups for a device
Get distinct field values for device filters
Get distinct field values for devices in a compliance plan
Get formatted device config
Get graded compliance reports for a node
Get historical graded compliance reports
Get historical graded compliance reports
Get JSON compliance report
Get list of device errors
Get operational data for a device
Get summary of a Golden Config tree
Get summary of a Golden Config tree
Get summary of devices information
Get summary of devices information
Get summary of devices information for a compliance plan
Get summary of devices information for a specific compliance plan
Get task instance(s)
Get the top issues from compliance reports
Get the top issues from JSON compliance reports
Grade report
Import backup documents
Import compliance plan documents
Import device config template documents
Import device group documents
Import Golden Config tree documents
Import parser documents
List all config parsers
List all device groups
List compliance plan runs
List compliance plan runs by plans
List historical compliance reports
Remove device groups from node
Remove devices from a group
Remove devices from node
Remove node(s) from a compliance plan
Remove tasks from node
Render a Jinja2 template
Run a compliance plan
Run a task instance
Run an adapter task
Run compliance reports
Run compliance reports
Run compliance reports on backups
Search all compliance plan instances
Search all compliance plans
Search all device groups
Search and filter devices
Search device groups
Search for task instance(s)
Summarize compliance reports for a tree
Update a compliance plan
Update a config parser
Update a config spec
Update a device backup by ID
Update a device template
Update a JSON spec
Update a task instance
Update device groups
Update Golden Config node
Update Golden Config rule set
Update node configuration
Update properties of a compliance plan instance
Update properties of a Golden Config tree
Update properties of a Golden Config tree version
Get banner
Update the banner
Get device count history
Refresh device count history
Delete a link
Get an individual link
List all links
Update a link
Update a link
Add group to form
Delete a form by ID
Export form
Get an element definition
Get details of form by ID
Get details of form by name
Get service instance data
Import form
List all elements usable in forms
List all form names
List groups for a form
Overwrite groups for a form
Preserve incoming form data format
Remove a group from a form
Remove all authorization restriction for a form
Save a generated form
Search forms
Get the Gateway configuration
Update the Gateway feature configuration
Add a new certificate
Check if a specific Gateway connection is healthy
Create a new Gateway
Create a new service group
Delete a certificate by ID
Delete a Gateway by ID
Delete service group
Execute code on a Gateway
Export a Gateway configuration
Get a certificate by its ID
Get Gateway by ID
Get information about a specific service on a Gateway
Get service group by ID
Get the Gateway Manager version
Import a Gateway configuration
Inspect a Gateway cluster
List all actively connected gateways
List all certificates
List all gateways
List all service groups
List all services
Run a Gateway service
Simple health check
Update a certificate by ID
Update Gateway
Update service group
Create a Git repository
Create a new branch in a repository
Initialize a project in Git
List the available branches for a repository
Retrieve a project from Git
Update a project in Git
Create a group mapping
Delete a group mapping
Get an individual group mapping
List all group mappings
Update a group mapping
Get status
Get the health of a single adapter
Get the health of a single application
Get the health of all the adapters
Get the health of all the applications
Get the health of the server
Get the health of the system
Generate documentation for adapters
Generate documentation for applications
Generate documentation for brokers
Generate OpenAPI v3 document
Create a collection's indexes in mongo
Get collection index status
Get index status for all collections
List all pre-defined indexes
Create a new integration model
Delete an integration model
Export an integration model
Get a specific integration model
Get an integration model's security schemes
List all integration models
Update an integration model
Validate an integration model
Create a new integration
Delete an integration
Get integration
List all integrations
Post an access token with an authorization code
Update an integration
Update the properties of an integration
Build inventory filter structure
Bulk load inventory nodes
Clear all nodes from an inventory
Create a new inventory
Create a new inventory action
Delete an inventory
Delete an inventory action
Expand node identifiers to full documents
Find inventories and nodes by tags
Get inventory action by identifier
Get inventory by identifier
Get inventory manager overview statistics
Get node by identifier
Get tag by identifier
Get tags from accessible inventories
Get usage statistics for a tag
Inventory manager health check
List all actions for a specific inventory
List all inventories with filtering and pagination
List all nodes for a specific inventory
List all nodes with filtering and pagination
List all tags for a specific inventory
List all tags with filtering and pagination
List inventory actions
Convert YANG to JSON schema
Create a JSON form
Decode an encoded JSON schema
Delete a forms
Find a form
Import form documents
Return all forms
Update a form
Validate data against a schema
Validate form data against its schema
Cancel an action execution
Create a new instance group
Create a new resource model
Delete a resource model
Delete an instance group
Export a resource instance
Export a resource model
Get a resource model based on ID
Get action execution record
Get instance group
Get multiple instance groups
Get resource instance
Import a resource model
Import an instance into a resource
Perform edits to a resource model
Run a resource action
Run a resource action against multiple instances
Search resource action history documents
Search resource instances
Search resource models
Update a instance group
Update a resource model
Update resource instance
Validate the actions defined on a resource model
Create a provider profile
Delete a provider profile
Fetch models from a provider
Get a provider definition
Get a provider profile
List available gateways
List available providers
List provider profiles
Preview agents impacted by profile deletion
Update a provider profile
Create a command template
Create an analytic template
Delete a command template
Delete an analytic template
Export template
Find the diff of two config strings
Get a command template by name
Get all analytic templates
Get all command templates
Get an analytic template by name
Get filtered devices
Get filtered devices
Get filtered devices with detailed query results
Import template
MOP diff array
MOP get boot flash
MOP passthrough
Retry a task automatically
Run a command against a device
Run a command against devices
Run an analytics template
Run an analytics template for devices
Run command template
Run single command from template
Update a command template
Update an analytic template
Create a service account in the database
Delete a service account in the database
Get service accounts from the database
Regenerate client secret
Retrieve a JWT from a client's credentials
Update a service account in the database
Add GBAC to a job
Add watchers to a job
Assign a task to a user
Bulk delete root jobs
Cancel jobs
Claim a task
Clone automation
Continue a job from a specified task
Create automation
Create trigger
Delete a root job and all related items
Delete automation
Delete root jobs and related items
Delete trigger
Delete triggers by action ID
Export automation
Export large data for a job or task variable
Export trigger
Finish a manual task
Get a job
Get a task by ID
Get automation
Get automation types
Get automations
Get event definition
Get jobs
Get manual task controller
Get tasks
Get trigger
Get triggers
Import automations
Import triggers
Pauses jobs
Release a currently assigned task
Remove all GBAC from a job
Remove GBAC from a job
Replace all GBAC from a job with the provided list
Resume jobs
Retry a task
Revert a job
Run endpoint trigger with POST
Run manual trigger
Search system events
Start a job
Unwatch job
Unwatch jobs
Update automation
Update trigger
Validate automation
Validate trigger
Watch a job
Watch jobs
Export a prebuilt
Get prebuilt
Import a prebuilt
List all the prebuilts
Remove a prebuilt
Update a prebuilt
Validate the data structure of a prebuilt
Create repository configuration
Delete repository configuration
Get repository configurations
List all prebuilts
Update repository configuration
Create a new profile
Delete a profile
Export a single profile
Get profile
Import a new profile
List all profiles
Switch the active profile
Update a profile
Get prometheus metrics
Get Raygun config
Get the adapter schema
Get the application schema
Get the integration schema
Get the profile schema
Search Itential Platform
Get a list of toggles
Get Itential Platform configuration property
Get the full Itential Platform configuration
Activate an SSO configuration
Create an SSO configuration
Delete an SSO configuration
Get SSO configuration
List all SSO configurations
Update an SSO configuration
Clone existing tag
Create many new tags
Create new tag
Create/Update references for tags
Delete existing tag
Find tags by name
Get tag details given an ID
Get tag refs by content ids
Get tags by content ID
List all tags
Reference a tag to a peice of content
Updating existing tag
Apply a template to text
Apply templates to text
Parse a template
Render jinja template
Render Jinja2 context with data cast
Get a tool execution
Search tool executions
Clone a decorator by ID
Create a decorator for a tool
Create tools from Platform assets
Delete a tool decorator
Export all decorators
Get a single decorator by ID
Get a single tool by referenceId
Import decorators in bulk
List all decorators for a tool
List all tools
List tools by referenceId
Create a single transformation
Delete a single transformation document
Get transformation document by ID
Import a single transformation
Run a transformation
Search for transformation documents
Update a single transformation
Get the user settings for the active user
Update the user settings for the active user
Assign a work item to a user
Cancel a pending work item
Cancel all pending work items for a given app and execution ID
Claim a work item for the authenticated user
Complete a work item by submitting the operator response
Count pending work items
Create a new work item
Get a work item by ID
Get chronological history of work items for a context
Get resolved incoming variables for a work item
Release ownership of a work item
Search work items with filtering, sorting, and pagination
Add group to workflow
Add workflow
Calculate workflow schemas
Delete all groups for a workflow
Delete workflow
Export workflow
Get task details
Get tasks
Import workflow
List groups for a workflow
Overwrite groups for a workflow
Remove a group from a workflow
Rename workflow
Activate task worker
Activate the job worker
Check staterator state
Create task mock
Deactivate task worker
Deactivate the job worker
Delete a task mock
diff to HTML
Evaluation
Evaluation group
Get aggregate job metrics
Get aggregate task metrics
Get task mock
Get the current task rate limit settings
Get worker status
Query data using 'json-query' format
Replace a task mock
Return a list of all IANA defined timezones
Search task mocks
Update the task rate limit settings at runtime

Open source Support FAQs Docs Home

Reference Authentication

Log in and create a session in Itential Platform

POST

https://example.itential.io/login

POST

/login

$ curl -X POST https://example.itential.io/login \
>      -H "Content-Type: application/json" \
>      -d '{}'

1 "MTQ4ZmMzMGMxOTQ2MTg4N2ZjMDhiMTY0MzlkYTgwZmM="

Logs in to Itential Platform.

Request

credentials

userobjectOptional

Response

The session token for a logged in user

Errors

500

Internal Server Error

Was this page helpful?

Log in using single sign-on