API Guide
Table Of Contents
- OpenManage Enterprise and OpenManage Enterprise - Modular Edition RESTful API Guide version 1.00.10
- About this document
- Overview
- Key integration concepts
- Application settings
- Network
- /api/ApplicationService/Network
- /api/ApplicationService/Network/CurrentAddressConfiguration
- /api/ApplicationService/Network/AddressConfiguration
- /api/ApplicationService/Network/WebServerConfiguration
- /api/ApplicationService/Network/TimeConfiguration
- /api/ApplicationService/Network/TimeZones
- /api/ApplicationService/Network/ProxyConfiguration
- Security and user management
- /api/AccountService
- /api/AccountService/Accounts
- /api/AccountService/Accounts(Id)
- /api/AccountService/Accounts(userId)/Permissions
- /api/AccountService/Actions/AccountService.Enable
- /api/AccountService/Actions/AccountService.Disable
- /api/AccountService/Actions/AccountService.Delete
- /api/AccountService/Roles
- /api/AccountService/Roles(Id)
- /api/AccountService/ExternalAccountProvider
- /api/AccountService/ExternalAccountProvider/DirectoryServiceType
- /api/AccountService/ExternalAccountProvider/ADAccountProvider
- /api/AccountService/ExternalAccountProvider/ADAccountProvider(Id)
- /api/AccountService/ExternalAccountProvider/Actions/ExternalAccountProvider.TestADConnection
- /api/AccountService/ExternalAccountProvider/LDAPAccountProvider
- /api/AccountService/ExternalAccountProvider/LDAPAccountProvider(Id)
- /api/AccountService/ExternalAccountProvider/Actions/ExternalAccountProvider.TestLDAPConnection
- /api/AccountService/ExternalAccountProvider/Actions/ExternalAccountProvider.SearchGroups
- /api/AccountService/ExternalAccountProvider/Actions/ExternalAccountProvider.DeleteExternalAccountProvider
- /api/AccountService/Actions/AccountService.ImportExternalAccountProvider
- Security and certificate management
- Monitoring and alert notifications
- api/AlertService/AlertDestinations/SNMPConfiguration
- api/AlertService/AlertDestinations/Actions/AlertDestinations.ApplySNMPConfig
- /api/AlertService/AlertDestinations/SyslogConfiguration
- api/AlertService/AlertDestinations/Actions/AlertDestinations.ApplySyslogConfig
- /api/AlertService/AlertDestinations/SMTPConfiguration
- /api/AlertService/AlertDestinations/Actions/AlertDestinations.SendTestTrap
- Network
- Alerts
- Alert logs
- /api/AlertService/Alerts
- /api/AlertService/Alerts(Id)
- /api/AlertService/AlertCategories
- /api/AlertService/AlertCategories('Name')
- /api/AlertService/AlertSeverities
- /api/AlertService/AlertSeverities(Id)
- /api/AlertService/AlertStatuses
- /api/AlertService/AlertStatus(Id)
- /api/AlertService/AlertCatalogs
- /api/AlertService/AlertCatalogs(Id)
- /api/AlertService/Events
- /api/AlertService/Actions/AlertService.Acknowledge
- /api/AlertService/Actions/AlertService.Unacknowledge
- /api/AlertService/Actions/AlertService.RemoveAlerts
- Alert policies
- /api/AlertService/AlertPolicies
- /api/AlertService/AlertPolicies(Id)
- /api/AlertService/AlertPolicies(Arg1)/PolicyCriteria
- /api/AlertService/AlertPolicies(Arg1)/PolicyCriteria(Arg2)
- /api/AlertService/AlertPolicies(Arg1)/PolicyActions
- /api/AlertService/AlertPolicies(Arg1)/PolicyActions(Arg2)
- /api/AlertService/AlertActionTemplates
- /api/AlertService/AlertActionTemplates(Id)
- /api/AlertService/Actions/AlertService.EnableAlertPolicies
- /api/AlertService/Actions/AlertService.DisableAlertPolicies
- /api/AlertService/Actions/AlertService.RemoveAlertPolicies
- Alert definitions
- Alert logs
- Configure
- Firmware
- /api/UpdateService/Catalogs
- /api/UpdateService/Catalogs(Id)
- api/UpdateService/Baselines
- api/UpdateService/Baselines(Id)
- /api/UpdateService/Baselines(Id)/DeviceComplianceReports
- /api/UpdateService/Baselines(Id)/DeviceComplianceReports(Id)
- /api/UpdateService/Baselines(Id)/DeviceComplianceReports(Id)/ComponentComplianceReports
- /api/UpdateService/Baselines(Id)/DeviceComplianceReports(Id)/ComponentComplianceReports(Id)
- /api/UpdateService/Actions/UpdateService.UploadFile
- /api/UpdateService/Actions/UpdateService.RemoveFile
- /api/UpdateService/Actions/UpdateService.RemoveCatalogs
- /api/UpdateService/Actions/UpdateService.RemoveBaselines
- /api/UpdateService/Actions/UpdateService.GetSingleDupDetails
- /api/UpdateService/Actions/UpdateService.GetSingleDupReport
- /api/UpdateService/Actions/UpdateService.GetBaselinesReportByDeviceids
- /api/UpdateService/Actions/UpdateService.GetCertDetails
- Deploy
- /api/TemplateService/TemplateTypes
- /api/TemplateService/TemplateViewTypes
- /api/TemplateService/Templates
- /api/TemplateService/Templates(Id)
- /api/TemplateService/Templates(Id)/Views
- /api/TemplateService/Templates(Id)/Views(Id)
- /api/TemplateService/Templates(Id)/Views(Id)/AttributeViewDetails
- /api/TemplateService/Templates(Id)/Views(Id)/AttributeViewDetails/TemplateEditInfoDetails
- /api/TemplateService/Templates(Id)/Views(Id)/DeviceAttributeViewDetails(Id)
- /api/TemplateService/Profiles
- /api/TemplateService/Profiles(Id)
- /api/TemplateService/Actions/TemplateService.AssignIdentities
- /api/TemplateService/Actions/TemplateService.GetAssignedIdentities
- /api/TemplateService/Actions/TemplateService.DetachProfile
- /api/TemplateService/Actions/TemplateService.Clone
- /api/TemplateService/Actions/TemplateService.Export
- /api/TemplateService/Actions/TemplateService.Import
- /api/TemplateService/Actions/TemplateService.Deploy
- /api/TemplateService/Actions/TemplateService.UpdateNetworkConfig
- Identity pools
- /api/IdentityPoolService/IdentityPools
- /api/IdentityPoolService/IdentityPools(Id)
- /api/IdentityPoolService/IdentityPools(Id)/UsageCounts
- /api/IdentityPoolService/IdentityPools(Id)/UsageIdentitySets
- /api/IdentityPoolService/IdentityPoolsI(Id)/UsageIdentitySets(Id)
- /api/IdentityPoolService/IdentityPools(Id)/UsageIdentitySets(Id)/Details
- /api/IdentityPoolService/IdentityStates
- /api/IdentityPoolService/IdentityStates(Id)
- /api/IdentityPoolService/Actions/IdentityPoolService.DeleteIdentityPools
- Network Configuration Service
- /api/NetworkConfigurationService/Networks
- /api/NetworkConfigurationService/Networks(Id)
- /api/NetworkConfigurationService/NetworkTypes
- /api/NetworkConfigurationService/NetworkTypes(Id)
- /api/NetworkConfigurationService/QosTypes
- /api/NetworkConfigurationService/QosTypes(Id)
- /api/NetworkConfigurationService/Actions/NetworkConfigurationService.RemoveNetworks
- Firmware
- Devices
- /api/DeviceService
- /api/DeviceService/Devices
- /api/DeviceService/Devices(Id)
- /api/DeviceService/Devices(Id)/InventoryDetails
- /api/DeviceService/Devices(Id)/InventoryDetails(InventoryType)
- /api/DeviceService/Devices(Id)/Settings('ReplicableChassisConfigurations')
- /api/DeviceService/Devices(Id)/HardwareLogs
- /api/DeviceService/Devices(Id)/SubSystemHealth
- /api/DeviceService/Devices(Id)/RecentActivity
- /api/DeviceService/Devices(Id)/InventoryTypes
- /api/DeviceService/Devices(Id)/LogSeverities
- /api/DeviceService/Devices(Id)/Settings
- /api/DeviceService/Devices(Id)/Settings('Type')
- /api/DeviceService/Devices(Id)/Temperature
- /api/DeviceService/Devices(Id)/Power
- /api/DeviceService/Devices(Id)/BlinkStatus
- /api/DeviceService/Devices(Id)/PowerUsageByDevice
- /api/DeviceService/Devices(Id)/DeviceBladeSlots
- /api/DeviceService/Devices(Id)/GraphicInfo
- /api/DeviceService/PowerStates
- /api/DeviceService/DeviceStatuses
- /api/DeviceService/DeviceType
- /api/DeviceService/DeviceSummary
- /api/DeviceService/DeviceSlotType
- /api/DeviceService/DeviceSettingsMetadata
- /api/DeviceService/GlobalExcludes
- /api/DeviceService/Actions/DeviceService.AddNetworkRange
- /api/DeviceService/Actions/DeviceService.EditNetworkRange
- /api/DeviceService/Actions/DeviceService.RemoveFromExclusion
- /api/DeviceService/Actions/DeviceService.ValidateExcludes
- Diagnostic
- Groups
- /api/GroupService/Groups
- /api/GroupService/Groups(Id)
- /api/GroupService/Groups(Id)/Devices
- /api/GroupService/Groups(Id)/GroupDevicesSummary
- /api/GroupService/Groups(Id)/SubGroups
- /api/GroupService/Groups(Id)/GroupHierarchy
- /api/GroupService/GroupTypes
- /api/GroupService/GroupTypes(Id)
- /api/GroupService/MembershipTypes
- /api/GroupService/MembershipTypes(Id)
- /api/GroupService/AllGroupsHierarchy
- /api/GroupService/Actions/GroupService.AddMemberDevices
- /api/GroupService/Actions/GroupService.GroupsPrivilegesAction
- /api/GroupService/Actions/GroupService.GroupsByPrivilegesAction
- Monitor
- Audit logs
- Jobs
- /api/JobService/Jobs
- /api/JobService/Jobs(Id)
- /api/JobService/JobStatuses
- /api/JobService/JobStatuses(Id)
- /api/JobService/JobTypes
- /api/JobService/JobTypes(Id)
- /api/JobService/Jobs(Id)/ExecutionHistories
- /api/JobService/Jobs(Id)/ExecutionHistories(Id)
- /api/JobService/Actions/JobService.EnableJobs
- /api/JobService/Actions/JobService.DisableJobs
- /api/JobService/Actions/JobService.RemoveJobs
- /api/JobService/Actions/JobService.RunJobs
- /api/JobService/Actions/JobService.StopJobs
- Reset application
- Console version
- Console capabilities
- Search
- Session
- APIs specific to OpenManage Enterprise - Modular Edition
- /api/ApplicationService/Actions/ApplicationService.GetConfiguration
- /api/ApplicationService/Actions/ApplicationService.ApplyConfiguration
- Brand
- Multichassis management
- /api/ManagementDomainService
- /api/ManagementDomainService/DiscoveredDomains
- /api/ManagementDomainService/ConfigurationTypes
- /api/ManagementDomainService/ConfigurationTypes(Id)
- /api/ManagementDomainService/Domains
- /api/ManagementDomainService/Domains(Id)
- /api/ManagementDomainService/PendingDomains
- /api/ManagementDomainService/PendingDomains(Id)
- /api/ManagementDomainService/Actions/ManagementDomainService.Domains
- /api/ManagementDomainService/Actions/ManagementDomainService.Join
- /api/ManagementDomainService/Actions/ManagementDomainService.Leave
- /api/ManagementDomainService/Actions/ManagementDomainService.Delete
- /api/ManagementDomainService/Actions/ManagementDomainService.DeleteGroup
- /api/ManagementDomainService/Actions/ManagementDomainService.ApproveJoin
- FIPS mode settings
- Fabric management
- /api/NetworkService
- /api/NetworkService/Fabrics
- /api/NetworkService/FabricDesign
- /api/NetworkService/Fabrics(Id)
- /api/NetworkService/Fabrics(Id)/FabricDesigns
- /api/NetworkService/Fabrics(Id)/ValidationErrors
- /api/NetworkService/Fabrics(Id)/Uplinks
- /api/NetworkService/Fabrics(Id)/Uplinks(Id)
- /api/NetworkService/Fabrics(Id)/Uplinks(Id)/Ports
- /api/NetworkService/Fabrics(Id)/Uplinks(Id)/Networks
- /api/NetworkService/Fabrics(Id)/Switches
- /api/NetworkService/Fabrics(Id)/Servers
- /api/NetworkService/Fabrics(Id)/ISLLinks
- /api/NetworkService/Fabrics(Id)/Topology
- /api/NetworkService/Fabrics(Id)/Topology/Nodes
- /api/NetworkService/Fabrics(Id)/Topology/Nodes(Id)
- /api/NetworkService/Fabrics(Id)/Topology/Nodes(Id)/ChildNodes
- /api/NetworkService/Actions/NetworkService.RemoveFabrics
- /api/NetworkService/Actions/NetworkService.RemoveUplinks
- /api/NetworkService/FabricDesigns(Id)/NetworkService.GetApplicableNodes
- /api/NetworkService/Fabrics(Id)/NetworkService.GetApplicableUplinkPorts
- /api/NetworkService/UplinkTypes
- /api/NetworkService/NodeTypes
- /api/NetworkService/FabricActivityTypes
- /api/NetworkService/FabricActivityStatuses
- /api/NetworkService/FabricHealthStatuses
- /api/NetworkService/MultiChassisDomain
- /api/NetworkService/MultiChassisDomain/Topology
- /api/NetworkService/MultiChassisDomain/Topology/Nodes
- /api/NetworkService/MultiChassisDomain/Topology/Nodes(Id)
- /api/NetworkService/MultiChassisDomain/Topology/Nodes(Id)/ChildNodes
- /api/NetworkService/MultiChassisDomain/ValidationErrors
- /api/NetworkService/PortAdminStatuses
- /api/NetworkService/PortStatuses
- /api/NetworkService/PortRoles
- /api/NetworkService /ServerProfiles(arg1)
- /api/NetworkService /ServerProfiles(arg1)/ServerInterfaceProfiles
- /api/NetworkService /ServerProfiles(arg1)/ServerInterfaceProfiles(arg2)
- /api/NetworkService /ServerProfiles(arg1)/ServerInterfaceProfiles(arg2)/Networks
- /api/NetworkService/Actions/NetworkService.ApplyServersInterfaceProfiles
- Port configuration in Fabrics
- Storage management
- Quick Deploy
- APIs specific to OpenManage Enterprise
- Application settings
- Console update
- Mobile
- /api/AlertService/MobileSubscriptions
- /api/AlertService/SubscriptionNotificationService
- /api/AlertService/Actions/AlertService.CreateEditMobileSubscription
- /api/AlertService/Actions/AlertService.DeleteMobileSubscription
- /api/AlertService/Actions/AlertService.EnableSubscriptionNotificationService
- /api/AlertService/Actions/AlertService.FilterAlertsByPolicy
- Troubleshoot service
- Query support service
- /api/QuerySupportService/Queries
- /api/QuerySupportService/Queries(Id)
- /api/QuerySupportService/QueryContextSummaries
- /api/QuerySupportService/QueryContextSummary(Id)
- /api/QuerySupportService/QueryContexts(Id)
- /api/QuerySupportService/QueryContexts(Id)/QuerySupportService.GetFiltersForContext
- /api/QuerySupportService/OperatorInfo
- /api/QuerySupportService/Filters
- /api/QuerySupportService/Filters(Id)
- Groups service
- /api/GroupService/Groups
- /api/GroupService/Groups(Id)/SubGroups(Id)
- /api/GroupService/Groups(Id)/DeviceStatusSummary
- /api/GroupService/Groups(Id)/EventStatusSummary
- /api/GroupService/GroupAudits
- /api/GroupService/Actions/GroupService.CreateGroup
- /api/GroupService/Actions/GroupService.UpdateGroup
- /api/GroupService/Actions/GroupService.Clone
- /api/GroupService/Actions/GroupService.DeleteGroup
- /api/GroupService/Actions/GroupService.AddMemberDevices
- /api/GroupService/Actions/GroupService.RemoveMemberDevices
- /api/GroupService/Actions/GroupService.AddUserToGroups
- Monitor
- Discovery service
- Warranty service
- Report service
- /api/ReportService/ReportDefs
- /api/ReportService/ReportDefs(Id)/ReportResults
- /api/ReportService/ReportDefs(Id)/ReportResults/ResultRows
- /api/ReportService/Actions/ReportService.RunReport
- /api/ReportService/Actions/ReportService.DownloadReport
- /api/ReportService/Actions/ReportService.DeleteReports
- /api/ReportService/Actions/ReportService.CloneReport
- MIB import service
- /api/MIBImportService/MIBS
- /api/MIBImportService/Actions/MIBImportService.Save
- /api/MIBImportService/Actions/MIBImportService.Parse
- /api/MIBImportService/Actions/MIBImportService.Delete
- /api/MIBImportService/MIBImportService/EventSeverities
- /api/MIBImportService/MIBImportService/EventCatalogs
- /api/MIBImportService/MIBImportService/EventCategories
- Application settings
- Redfish resource model

Table 88. Attributes (continued)
Attribute name Description
Link
Devices Group link to list group devices.
AllLeafDevices Group link to list all group sub groups devices.
GroupHierarchy Group link to list the group hierarchy.
SubGroup Group link to display the list of sub groups of this group.
GroupDevicesSummary Group link to display a summary of all group devices.
Table 89. Filters
Attribute name Description
Top Top records to return. Default value is 100.
Skip Max records to skip. Default value is 0.
Name Filter by group name.
Description Filter by group description.
Type Filter by group type.
MembershipType Filter by group membership type.
GlobalStatus Filter by group global status.
DefinitionId Filter by group definition ID.
DefinitionDescription Filter by group definition description.
Visible Filter by group visibility.
CreatedBy Filter by the entity that created the group.
UpdatedBy Filter by the entity that updated the group.
CreationTimeBegin Filter by the start-time when the group was created.
CreationTimeEnd Filter by the end-time when the group was created.
UpdatedTimeBegin Filter by the start-time when the group was updated.
UpdatedTimeEnd Filter by the end-time when the group was updated.
/api/GroupService/Groups(Id)
This URI represents a specific group within the collection.
GET method for Groups(Id)
This method returns the details of a group within the collection.
Description
Returns the details of a group
Privilege VIEW
HTTP response
codes
200
Example
Input:
Output:
Groups 217