-
adapterProxy
Call Adapter Method
GET /configuration_manager/devices/actions/:device&:origin&:actionPerform south bound specific logic via direct adapter call(s)
-
addDevicesToGroup
Adds new devices to the group
POST /configuration_manager/deviceGroups/:id/devicesAdds devices to a group
-
addDevicesToNode
Add Devices to Node
POST /configuration_manager/configs/:treeId/:version/:nodePath(*)/devicesAdd devices to a node in a Golden Config tree
-
addGroupsToNode
Add Device Groups to Node
POST /configuration_manager/configs/devices/groupsAdd device groups to a node in a Golden Config tree
-
addNodesToCompliancePlan
Adds node(s) to a compliance plan
POST /configuration_manager/compliance_plans/nodesAdds new node(s) to an already existing compliance plan
-
addTasksToNode
Add Tasks to Node
POST /configuration_manager/configs/node/tasksAdd Tasks to a node in a Golden Config tree
-
advancedAutoRemediation
Auto remediate with additional options.
No Northbound API AvailablePatch device configuration automatically from compliance report.
-
advancedPatchDeviceConfiguration
Alters a device configuration
POST /configuration_manager/patch_device/advanced/:deviceNameApply specified changes to a device configuration with additional options
-
applyDeviceConfig
Apply a device config
POST /configuration_manager/devices/:deviceName/configurationThis API call will apply a configuration to a specified device
-
applyDeviceTemplate
Apply a device config template
POST /configuration_manager/templates/applyThis API call will apply a configuration template to a specified device
-
backUpDevice
Backup device configuration
POST /configuration_manager/devices/backupsBackup device configuration in mongo
-
buildSpecLines
Builds a config spec from raw config.
POST /configuration_manager/generate/config_specTakes raw native config and builds a configuration spec.
-
cacheOSTypes
Fetches OS Types to store into the cache.
POST /configuration_manager/cache/devices/ostypeGathers all the device OS Types in the current evnironment and stores them in the cache.
-
convertChangesToConfig
Converts patch data to native config.
POST /configuration_manager/changes/convertConverts the config patch data into a readable native config.
-
createCompliancePlan
Creates a compliance plan
POST /configuration_manager/compliance_plansCreates a compliance plan which can be used to execute compliance reports
-
createConfigParser
Create a config parser.
POST /configuration_manager/configurations/parserCreate rules for a parser for breaking down configs in GC.
-
createConfigSpec
Create a new Config Spec.
POST /configuration_manager/config_specsCreate a new Config Spec.
-
createDeviceGroup
Creates a device group
POST /configuration_manager/devicegroupCreates a new device group in pronghorn
-
createDeviceTemplate
Creates a device template
POST /configuration_manager/templatesCreates a new device template in pronghorn
-
createGoldenConfigNode
Create a new node in a Golden Config tree.
POST /configuration_manager/configs/:treeId/:version/:parentNodePath(*)Create a new node in the specified Golden Config tree.
-
createGoldenConfigTree
Adds a new Golden Config tree
POST /configuration_manager/configsAdds a new Golden Config tree
-
createGoldenConfigTreeVersion
Adds a new Golden Config tree
POST /configuration_manager/configs/:treeIdAdds a new Golden Config tree
-
createJSONSpec
Create a new JSON Spec.
POST /configuration_manager/json_specs/createCreate a new JSON Spec.
-
createTaskInstance
Create a task instance.
POST /configuration_manager/tasks/instanceCreate an instance of a task and save it to the database.
-
deleteCompliancePlans
Delete compliance plans
DELETE /configuration_manager/compliance_plansDelete the specified compliance plans
-
deleteConfigParser
Delete a config parser.
DELETE /configuration_manager/configurations/parserPermanently delete a configuration parser.
-
deleteConfigParsers
Delete one or more config parsers by Id
DELETE /configuration_manager/configurations/parsersThis API call will delete config parsers based on given Ids
-
deleteDeviceBackups
Delete one or more device backups by Id
DELETE /configuration_manager/backupsThis API call will delete device backups based on given Ids
-
deleteDeviceGroups
Delete device groups
DELETE /configuration_manager/deviceGroupsDelete specified device groups
-
deleteDeviceGroupsByName
Delete device groups
DELETE /configuration_manager/name/deviceGroupsDelete specified device groups
-
deleteDeviceTemplates
Delete one or more device template(s) by Id
DELETE /configuration_manager/templatesThis API call will delete device templates based on given Ids
-
deleteGoldenConfigNode
Delete a node in a Golden Config tree.
DELETE /configuration_manager/configs/:treeId/:version/:nodePath(*)Permanently delete the specified node in the Golden Config tree. Not reversible.
-
deleteGoldenConfigTree
Delete a Golden Config tree.
DELETE /configuration_manager/configs/:treeIdDeletes the specified Golden Config tree.
-
deleteGoldenConfigTrees
Delete one or more golden configuration trees by tree id
DELETE /configuration_manager/configsThis API call will delete golden configuration trees based on given tree ids
-
deleteGoldenConfigTreeVersion
Delete a Golden Config tree.
DELETE /configuration_manager/configs/:treeId/:versionDeletes the specified Golden Config tree.
-
deleteOSTypeCache
Deletes the cache for os types.
DELETE /configuration_manager/cache/devices/ostypeRemoves the cache in the database for os type values.
-
deletePins
Deletes pinned items.
DELETE /configuration_manager/pinsDeletes the pinned items permanently from the database.
-
deleteTaskInstances
Delete task instance(s).
DELETE /configuration_manager/tasks/instanceDelete task instance(s) from the database.
-
deleteVariables
Deletes one or more variables
DELETE /configuration_manager/configs/variables/:treeId/:versionVerifies and deletes the requested deletion variables
-
DiffViewer
Diff Viewer (manual workflow task)
/configuration_manager/task/DiffViewer -
exportGoldenConfigTree
Export a Golden Config tree.
POST /configuration_manager/export/goldenconfigsExports the specified Golden Config tree.
-
getAdapterTask
Get data for a specific adapter task.
POST /configuration_manager/adaptertasksFetch method/task metadata for an adapter task.
-
getAdapterTasks
Get data for all adapters with tasks.
POST /configuration_manager/adaptertasks/searchFetch method/task metadata for all adapters that have it.
-
getBackups
Get Device Backup List
POST /configuration_manager/backupsFetches backups, requires an options payload. An empty option payload will return the first 25 documents
-
getCachedOSTypes
Fetches the OSTypes stored in the cache.
GET /configuration_manager/cache/devices/ostypeGathers all the device OS Types in the current cache.
-
getCompliancePlan
Fetches a compliance plan
GET /configuration_manager/compliance_plans/:planIdFetches a compliance plan with the provided ID
-
getComplianceReportBackupHistory
Compliance Reports totals for a Backup.
POST /configuration_manager/compliance_reports/history/backupsCompliance Reports totals for a Backup.
-
getComplianceReportDetail
Get Compliance Report
GET /configuration_manager/compliance_reports/details/:reportIdGet the details of a particular compliance report
-
getComplianceReportDeviceHistory
Compliance Reports totals for a Device.
POST /configuration_manager/compliance_reports/historyCompliance Reports totals for a Device.
-
getComplianceReportNodeSummary
Summarize Compliance Reports for a Node.
GET /configuration_manager/compliance_reports/node/:treeId/:nodePath(*)Summarize Compliance Reports for a Node.
-
getComplianceReportsByBatch
Get compliance report metadata for a batch.
GET /configuration_manager/compliance_reports/batch/:batchIdGet compliance report metadata by batch ID.
-
getComplianceReportsDetail
Get details of a particular set of compliance checks.
POST /configuration_manager/compliance_reports/detailsGet details of a particular set of compliance checks.
-
getComplianceReportTaskHistory
Compliance Reports totals for a Task Instance.
POST /configuration_manager/json_compliance_reports/historyCompliance Reports totals for a Task Instance.
-
getComplianceReportTreeSummary
Summarize Compliance Reports for a Tree.
GET /configuration_manager/compliance_reports/tree/:treeIdSummarize Compliance Reports for a Tree.
-
getConfigParser
Get a config parser.
POST /configuration_manager/configurations/parser/searchGet a defined Config Parser from the database.
-
getConfigParsers
Get all config parsers.
GET /configuration_manager/configurations/parserGets a list of all known config parsers.
-
getConfigSpec
Get a Config Spec document.
GET /configuration_manager/config_specs/:idGet the details of the specified Config Spec.
-
getConfigTemplate
Get a Config Spec template.
POST /configuration_manager/config_templateGet the template of the specified Config Spec
-
getDevice
Get Device Details
GET /configuration_manager/devices/:nameGet detailed information for a specific device, based on its device name
-
getDeviceBackupById
Get Device Backup
GET /configuration_manager/backups/:idRetrieves single backup document by id
-
getDeviceConfig
Get Device Configuration
GET /configuration_manager/devices/:name/configurationGet configuration for a specific device
-
getDeviceGroupById
Get Device Group by ID
GET /configuration_manager/deviceGroups/:idGet Device Group by ID
-
getDeviceGroupByName
Get Device Group by Name
GET /configuration_manager/name/devicegroupsRetrieves a single group document by name
-
getDeviceGroups
Get all Device Groups
GET /configuration_manager/deviceGroupsGets a list of all known device groups
-
getDevicesFiltered
Find Devices
POST /configuration_manager/devicesGets a specific subset of devices for based on given options
-
getDevicesOnTree
Fetches all the devices that exist on a tree.
POST /configuration_manager/devices/treeSearch through a GC Tree to find all the devices that exist on it.
-
getDeviceTemplates
Gets a device template
POST /configuration_manager/templates/searchGets a new device template in pronghorn
-
getGoldenConfigTree
Get summary of a Golden Config tree.
GET /configuration_manager/configs/:treeIdGet summary of the specified Golden Config tree.
-
getGoldenConfigTrees
Get a list of all Golden Config trees.
GET /configuration_manager/configsGet a list of all Golden Config trees.
-
getGoldenConfigTreeVersion
Get details of a Golden Config tree version.
GET /configuration_manager/configs/:treeId/:versionGet a detailed view of the specified Golden Config tree version.
-
getGroupsForDevice
Gets device groups for a device
GET /configuration_manager/groups/device/:deviceNameFinds all the device groups that contain the specified device
-
getJSONComplianceReportDetail
Get JSON Compliance Report
GET /configuration_manager/json_compliance_reports/details/:reportIdGet the details of a particular JSON compliance report
-
getJSONComplianceReportsByBatch
Get compliance report metadata for a batch.
GET /configuration_manager/json_compliance_reports/batch/:batchIdGet compliance report metadata by batch ID.
-
getJSONSpec
Get a JSON Spec document.
GET /configuration_manager/json_specs/:idGet the details of the specified JSON Spec.
-
getJSONSpecWithInheritance
Get a JSON Spec document with inheritance.
POST /configuration_manager/json_specsGet the details of the specified JSON Spec with inheritance.
-
getPins
Get a list of pinned items.
POST /configuration_manager/pins/fetchFetches a list of pinned items based on the input parameters. The list of pinned items are specific to the current user or actor. This api supports pagination.
-
getTaskInstances
Get task instance(s).
POST /configuration_manager/tasks/instancesGet instance(s) of a task.
-
getTopIssues
Get the top issues from compliance reports
POST /configuration_manager/compliance_reports/topissuesGet the top most offending issues from all latest compliance reports
-
getTopIssuesJson
Get the top issues from JSON compliance reports
POST /configuration_manager/json_compliance_reports/topissuesGet the top most offending issues from all latest JSON compliance reports
-
getTreesForDevice
Find trees which contain the specified device.
POST /configuration_manager/devices/device/treesSearch through all GC Trees to find all locations where a device exists.
-
gradeComplianceReport
Grade Report
POST /configuration_manager/compliance_reports/grade/singleGet graded compliance report
-
gradeComplianceReports
Get graded compliance reports for a node.
POST /configuration_manager/compliance_reports/gradeGet a set of graded and scored compliance reports for a node.
-
gradeDeviceComplianceHistory
Get historical graded compliance reports.
POST /configuration_manager/compliance_reports/grade/historyGet historical graded compliance reports for a device on a node.
-
gradeTaskComplianceHistory
Get historical graded compliance reports.
POST /configuration_manager/json_compliance_reports/grade/historyGet historical graded compliance reports for a task instance on a node.
-
handlePin
Add an item to pins or remove from if it already exists
POST /configuration_manager/pinsAdd an item to pins or remove from if it already exists
-
importBackup
Import backup documents
POST /configuration_manager/import/backupsInsert backup documents into the ucm_configs collection
-
importCompliancePlan
Import compliance plan documents
POST /configuration_manager/import/plansInsert compliance plan documents into the ucm_compliance_plans collection
-
importDeviceTemplates
Import device config template documents
POST /configuration_manager/import/templatesInsert device config template documents into the device_templates collection
-
importGoldenConfigTree
Import golden config tree documents
POST /configuration_manager/import/goldenconfigsInsert golden config documents into the golden config collection
-
importGroup
Import device group documents
POST /configuration_manager/import/groupsInsert device group documents into the device_groups collection
-
importParsers
Import parser documents
POST /configuration_manager/import/parsersInsert parser documents into the ucm_configs collection
-
isAlive
Check if device is connected
GET /configuration_manager/devices/:name/isAliveGet connection status of device
-
isMaintenance
Checks if the current version of CM is maintenance or not.
GET /configuration_manager/ismaintenanceReturns a boolean reflecting whether the current Configuration Manager bundle is a maintenance bundle.
-
lookupDiff
Diff two strings from a lookup.
PUT /configuration_manager/lookup_diffLookup two strings and return a diff.
-
ManualRemediation
Manual Remediation Task (manual workflow task)
/configuration_manager/task/ManualRemediation -
ManualRemediationResults
Manual Remediation Results Task (manual workflow task)
/configuration_manager/task/ManualRemediationResults -
patchDeviceConfiguration
Alters a device configuration
POST /configuration_manager/patch_device/:deviceNameApply specified changes to a device configuration
-
queryGradedComplianceHistory
Get historical graded compliance reports with pagination support.
POST /configuration_manager/compliance_reports/query/historyGet historical graded compliance reports for a device on a node with pagination support.
-
removeDevicesFromGroup
Removes devices from a group
DELETE /configuration_manager/deviceGroups/:id/devicesRemoves devices from a device group
-
removeDevicesFromNode
Remove Devices from Node
DELETE /configuration_manager/configs/:treeId/:version/:nodePath(*)/devicesRemove devices from a node in a Golden Config tree
-
removeGroupsFromNode
Remove Device Groups from Node
DELETE /configuration_manager/configs/devices/groupsRemove device groups from a node in a Golden Config tree
-
removeNodesFromCompliancePlan
Removes node(s) from a compliance plan
DELETE /configuration_manager/compliance_plans/nodesRemoves new node(s) from an already existing compliance plan
-
removeTasksFromNode
Remove Tasks from Node
DELETE /configuration_manager/configs/node/tasksRemove Tasks from a node in a Golden Config tree
-
renderJinja2
Renders a jinja2 template.
POST /configuration_manager/jinja2Takes a jinja2 template a renders output text.
-
runAdapterTask
Run an adapter task.
POST /configuration_manager/tasks/runRun an adapter task.
-
runAutoRemediation
Auto Fix
No Northbound API AvailablePatch device configuration automatically from compliance report
-
runCompliance
Run Compliance Reports.
POST /configuration_manager/compliance_reportsKick off one or more compliance checks for devices in a specified Golden Config tree.
-
runComplianceForDevice
Run Compliance Report
No Northbound API AvailableBegin a compliance report run for a device.
-
runComplianceForDeviceGroup
Run Compliance Reports.
No Northbound API AvailableBegin a compliance report run for a device group.
-
runComplianceForNode
Run Compliance Reports (Node)
No Northbound API AvailableBegin a compliance report run for a Golden Config tree node.
-
runComplianceForTree
Run Compliance Reports (Tree)
No Northbound API AvailableBegin a compliance report run for a Golden Config tree.
-
runComplianceOnBackups
Run Compliance Reports on Backups.
POST /configuration_manager/compliance_reports/backupsKick off one or more compliance checks for backups in a specified Golden Config tree.
-
runCompliancePlan
Runs a compliance plan
POST /configuration_manager/compliance_plans/runThis API call will create WF job that will execute the compliance plan
-
runConfigCompliance
Run Compliance Reports.
POST /configuration_manager/compliance_reports/configKick off one or more compliance checks for devices in a specified Golden Config tree.
-
runTaskInstance
Run a task instance.
POST /configuration_manager/tasks/instance/runRun an instance of a task and save it to the database.
-
searchCompliancePlanInstances
Search all Compliance Plan instances
POST /configuration_manager/search/compliance_plan_instancesGets a list of all Compliance Plan Instances that match the search criteria
-
searchCompliancePlans
Search all Compliance Plans
POST /configuration_manager/search/compliance_plansGets a list of all Compliance Plans that match the search criteria
-
searchDeviceGroups
Search all Device Groups
POST /configuration_manager/deviceGroups/searchGets a list of all device groups that match the search criteria
-
searchGoldenConfigTrees
Get summary of a Golden Config tree.
POST /configuration_manager/search/configsGet summary of the specified Golden Config tree.
-
searchGroups
Search device groups
POST /configuration_manager/deviceGroups/queryReturns device groups that match the specified input
-
searchTaskInstances
Search for task instance(s).
POST /configuration_manager/tasks/instances/searchSearch for task instance(s) using varies options parameters.
-
translateConfigSpec
Convert a config spec into a readable string.
POST /configuration_manager/translate/config_specConverts a object like config into a human-readable config string.
-
updateCompliancePlan
Updates a compliance plan
PUT /configuration_manager/compliance_plansUpdates a compliance plan that already exists
-
updateConfigParser
Update a config parser.
PUT /configuration_manager/configurations/parserUpdate rules for a parser for breaking down configs in GC.
-
updateConfigSpec
Update a Config Spec.
PUT /configuration_manager/config_specs/:idUpdate content of the Config Spec.
-
updateDeviceBackupById
Update a device backup by Id
PUT /configuration_manager/backups/:idThis API call will update the metadata of a device backup by ID
-
updateDeviceGroups
Update device groups
PUT /configuration_manager/deviceGroups/:idUpdates the device group's details and devices.
-
updateDeviceTemplate
Updates a device template
PUT /configuration_manager/templatesUpdates a new device template in pronghorn
-
updateGoldenConfigNode
Update properties of a node in a Golden Config tree.
PUT /configuration_manager/configs/:treeId/:version/:nodePath(*)Update properties of the specified Golden Config node.
-
updateGoldenConfigTree
Updates properties of a Golden Config tree
PUT /configuration_manager/configs/:treeIdUpdates properties of the specified Golden Config tree
-
updateGoldenConfigTreeVersion
Updates properties of a Golden Config tree version
PUT /configuration_manager/configs/:treeId/:versionUpdates properties of the specified Golden Config tree version
-
updateJSONConfigRules
Updates the config rule set of a JSON Golden Config tree version
PUT /configuration_manager/configurations/rulesUpdates the config rule set of a JSON Golden Config tree version
-
updateJSONSpec
Update a JSON Spec
PUT /configuration_manager/json_specs/:idUpdate content of the JSON Spec.
-
updateNodeConfig
Update node configuration.
PUT /configuration_manager/node/configUpdates the configuration for a specified node.
-
updateTaskInstance
Update a task instance.
PUT /configuration_manager/tasks/instanceUpdate an instance of a task and save it to the database.
2023.2 (latest)