-
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
-
addDevicesToGroupByName
Add device(s) to a group
POST /configuration_manager/deviceGroups/devicesThis API call will add device(s) to a device group
-
addDevicesToNode
Add Devices to Node
POST /configuration_manager/configs/:treeId/:version/:nodePath(*)/devicesAdd devices to a node in a Golden Config tree
-
backUpDevice
Backup device configuration
POST /configuration_manager/devices/backupsBackup device configuration in mongo
-
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
-
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
-
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
-
deleteDevicesFromGroup
Delete device(s) from a group
DELETE /configuration_manager/deviceGroups/devicesThis API call will delete device(s) from a device group
-
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.
-
deleteVariables
Deletes one or more variables
DELETE /configuration_manager/configs/variables/:treeId/:versionVerifies and deletes the requested deletion variables
-
exportGoldenConfigTree
Export a Golden Config tree.
POST /configuration_manager/export/goldenconfigsExports the specified Golden Config tree.
-
getBackups
Get Device Backup List
POST /configuration_manager/backupsFetches backups, requires an options payload. An empty option payload will return the first 25 documents
-
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 /configuration_manager/compliance_reports/batch/:batchId -
getComplianceReportsDetail
Get details of a particular set of compliance checks.
POST /configuration_manager/compliance_reports/detailsGet details of a particular set of compliance checks.
-
getComplianceReportTreeSummary
Summarize Compliance Reports for a Tree.
GET /configuration_manager/compliance_reports/tree/:treeIdSummarize Compliance Reports for a Tree.
-
getConfigSpec
Get a Config Spec document.
GET /configuration_manager/config_specs/:idGet the details 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
-
getDeviceConfigFormat
Get formatted device config
GET /configuration_manager/devices/:name/configuration/:formatGet device configuration in a given format
-
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
-
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.
-
getTopIssues
Get the top issues from compliance reports
POST /configuration_manager/compliance_reports/topissuesGet the top most offending issues from all latest compliance reports
-
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.
-
importBackup
Import backup documents
POST /configuration_manager/import/backupsInsert backup documents into the ucm_configs 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
-
isAlive
Check if device is connected
GET /configuration_manager/devices/:name/isAliveGet connection status of device
-
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
-
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
-
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.
-
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.
-
searchDeviceGroups
Search all Device Groups
POST /configuration_manager/deviceGroups/searchGets a list of all device groups that match the search criteria
-
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.
-
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
2019.3
- API REFERENCE
- USER
- ADMIN
- DEVELOPER
- PRODUCT NOTICES