Skip to main content

Welcome

Dell Sites

Dell Technologies
Premier Sign In
Partner Program Sign In
Dell Financial Services
Support

Dell Sites

Dell Technologies
Premier Sign In
Partner Program Sign In
Dell Financial Services
Support

My Account
Order Status
Profile Settings
My Products
Make a Payment
Dell Rewards Balance

Welcome to Dell

My Account

Place orders quickly and easily
View orders and track your shipping status
Enjoy members-only rewards and discounts
Create and access a list of your products

Sign In Create an Account Premier Sign In Dell Financial Services Partner Program Sign In

Your Dell.com Carts

Products
Solutions
Services
Contact Us

Support Home
Product Support
Manuals

OpenManage Enterprise 3.10 RESTful API Guide

Notes, cautions, and warnings
Revision history
Preface
Overview
- RESTful application programming interface
- OData
- JSON data
- HTTPS communication
- OpenManage Enterprise
Key integration concepts
- Base URI
  - OEM scheme
  - Redfish scheme
- Security
- Authentication
- Authorization
- Resource addressing
- Resource operations
- Security considerations
- Performance considerations
- Limitations
- Data filtering
- Data sorting
- Data pagination
- Request headers
- Response codes
- Response headers
Application settings
- Network
- Security and user management
- Security and certificate management
- Monitoring and alert notifications
Alerts
- Alert logs
- Alert policies
- Alert definitions
Data Forwarding Service
- api/DataForwardingService
  - GET method for Data Forwarding Service
- api/DataForwardingService/Forwarders
  - Get method for Forwarders
- /api/DataForwardingService/Actions/DataForwardingService. OnDemandTransfer
  - POST method for DataForwardingService.OnDemandTransfer
- api/DataForwardingService/Forwarders({id})
  - GET method for a specific forwarder
- api/DataForwardingService/Forwarders({id})/GroupSummary
  - GET method for forwarders group summary
- api/DataForwardingService/Forwarders({id})/GroupSummary
  - POST method for forwarder settings
- api/DataForwardingService/Forwarders({id})/DataSyncHistory
  - GET method for DataSyncHistory of forwarder
- api/DataForwardingService/Forwarders({id})/DataSyncHistory({historyId})
  - GET method for specific DataSyncHistory
- api/DataForwardingService/Forwarders({id})/DataSyncConfigurations
  - GET method for Data Sync Configurations of forwarders
- api/DataForwardingService/Forwarders({id})/DataSyncConfigurations({sid})
  - GET method for specific DataSync Configurations
- api/DataForwardingService/CategoryTypes
  - GET method for Category Types
- api/DataForwardingService/Forwarders({forwarderId})/ManagedDevicesSummary
  - Get method for Managed Devices Summary
- api/DataForwardingService/Actions/DataForwardingService.ForwarderSettings
  - POST method for ForwarderSettings
Configure
- Firmware
- Template Service
- Identity pools
- Network Configuration Service
Dell Connectivity Service
- api/DellConnectivityService
  - GET method for Connectivity Service
- api/DellConnectivityService/Actions/DellConnectivityService.TestConnectivity
  - POST method for Testing Connectivity
- POST method for Registration
- api/DellConnectivityService/Actions/DellConnectivityService.Deregistration
  - POST method for Deregistration
- api/DellConnectivityService/ConnectivityStatus
  - GET method for Connectivity Status
Backup And Restore
- api/BackupRestoreService
  - GET method for BackupAndRestoreService
- api/BackupRestoreService/Backups
  - GET method for Backups
- api/BackupRestoreService/RegisteredStreamNode
  - GET method for RegisteredStreamNode
  - POST method for RegisteredRestoreDestination
- api/BackupRestoreService/AcknowledgeStreamNode
  - GET method for AcknowledgeStreamNode
- api/BackupRestoreService/Actions/BackupRestoreService.RegisterStreamNode
  - POST method for RegisterStreamNode
- api/BackupRestoreService/Actions/BackupRestoreService.CheckAndTrustCertificate
  - POST method for CheckAndTrustCertificate
- api/BackupRestoreService/Actions/BackupRestoreService.ValidateStreamNode
  - POST method for ValidateStreamNode
- api/BackupRestoreService/ApplianceState
  - GET method for ApplianceState
- api/BackupRestoreService/Actions/BackupRestoreService.ScheduleBackup
  - POST method for ScheduleBackup
- api/BackupRestoreService/Actions/BackupRestoreService.AbortRestore
  - POST method for AbortRestore
- api/BackupRestoreService/Actions/BackupRestoreService.InitiateRestore
  - POST method for InitiateRestore
- api/BackupRestoreService/Actions/BackupRestoreService.AbortImport
  - POST method for AbortImport
- api/BackupRestoreService/Actions/BackupRestoreService.InitiateImport
  - POST method for DeviceService
- api/BackupRestoreService/Actions/BackupRestoreService.RegisterRestoreDestination
  - GET method for RegisteredRestoreDestination
- api/BackupRestoreService/BackupPreCheck
  - GET method for BackupPreCheck
- api/BackupRestoreService/RestoreExecutionDetails
  - GET method for RestoreExecutionDetails
- api/BackupRestoreService/ImportExecutionLogs
  - GET method for ImportExecutionLogs
- api/BackupRestoreService/ScheduledBackup
  - GET method for ScheduledBackup
- api/BackupRestoreService/PrecheckCertificate
  - GET method for PrecheckCertificate
- api/BackupRestoreService/ImportReadinessReport
  - GET method for ImportReadinessReport
- api/BackupRestoreService/Actions/BackupRestoreService.InitiateStream
  - POST method for BackupRestoreService.InitiateStream
- api/BackupRestoreService/Actions/BackupRestoreService.CompleteStream
  - POST method for BackupRestoreService.CompleteStream
- api/BackupRestoreService/Actions/BackupRestoreService.InitiateExport
  - POST method for BackupAndRestoreService.InitiateExport
- api/BackupRestoreService/Actions/BackupRestoreService.AbortExport
  - POST method for BackupRestoreService.AbortExport
- api/BackupRestoreService/Actions/BackupRestoreService.ValidateDestination
  - POST method for BackupRestoreService.ValidateDestination
- api/BackupRestoreService/SourceReadinessInformation
  - GET method for SourceReadinessReport
Devices
- /api/DeviceService
  - GET method for DeviceService
- /api/DeviceService/Devices
  - GET method for Devices
- /api/DeviceService/Devices?$filter=Type eq 1000
  - GET method for device filter
- /api/DeviceService/Devices(Id)
  - GET method for Devices(Id)
- /api/DeviceService/Devices(Id)/InventoryDetails
  - GET method for InventoryDetails
    - Individual filters
- /api/DeviceService/Devices(Id)/InventoryDetails(InventoryType)
  - GET method for inventory details by inventory type
- /api/DeviceService/Devices(Device_ID)/InventoryDetails('deviceManagement')
  - GET method for device inventory details
- /api/DeviceService/Devices(Id)/Settings('ReplicableChassisConfigurations')
  - PUT method to retrieve chassis time and alert destination settings
- /api/DeviceService/Devices(DEVICE_ID)/Settings('NetworkServices')
  - PUT method for network services settings
- /api/DeviceService/Devices(Device_ID)/Settings('LocalAccessConfiguration')
  - GET method for local access configuration
  - PUT method for local access configuration
- /api/DeviceService/Devices(Id)/HardwareLogs
  - GET method for HardwareLogs
- /api/DeviceService/Devices(Id)/SubSystemHealth
  - GET method for sub system health information
- /api/DeviceService/Devices(Id)/RecentActivity
  - GET method for RecentActivity
- /api/DeviceService/Devices(Id)/InventoryTypes
  - GET method for InventoryTypes
- /api/DeviceService/Devices(Id)/LogSeverities
  - GET method for LogSeverities
- /api/DeviceService/Devices(Id)/Settings
  - GET method for Settings
- /api/DeviceService/Devices(Id)/Settings('Type')
  - GET method for device settings by type
  - PUT method for device settings by type
- /api/DeviceService/Devices(Id)/Temperature
  - GET method for Temperature
- /api/DeviceService/Devices(Id)/BlinkStatus
  - GET method for LED blink status
- /api/DeviceService/Devices(Id)/PowerUsageByDevice
  - GET method for power usage by devices
- /api/DeviceService/Devices(Id)/DeviceBladeSlots
  - GET method for device blade slots
- /api/DeviceService/Devices(Id)/GraphicInfo
  - GET method for GraphicInfo
- /api/DeviceService/Devices(Id)/DeployRequired
  - GET method for deployment by device IDs
- /api/DeviceService/Devices(Id)/SystemUpTime
  - GET method for /api/DeviceService/Devices(Id)/SystemUpTime
- /api/DeviceService/Actions/DeviceService/Devices(Id)Actions/DeviceService.UploadFSDCertificate
  - POST method for uploading FSD certificate
- /api/DeviceService/PowerStates
  - GET method for PowerStates
- /api/DeviceService/DeviceStatuses
  - GET method for DeviceStatuses
- /api/DeviceService/DeviceType
  - GET method for DeviceType
- /api/DeviceService/Actions/DeviceService/Devices(Id)Actions/DeviceService.SetTermState
  - POST method for setting term state
- /api/DeviceService/Actions/DeviceService/Devices(Id)Actions/DeviceService.GetTermState
  - POST method for getting term state
- /api/DeviceService/Actions/DeviceService/Devices(Id)Actions/DeviceService.GetComputeIPs
  - POST method for /api/DeviceService/Actions/DeviceService/Devices(Id)Actions/DeviceService.GetComputeIPs
- /api/DeviceService/DeviceSummary
  - GET method for DeviceSummary
- /api/DeviceService/DeviceSummary(Type)
  - GET method for /api/DeviceService/DeviceSummary(Type)
- api/DeviceService/Actions/DeviceService.DevicesPrivilegesAction
  - POST method for api/DeviceService/Actions/DeviceService.DevicesPrivilegesAction
- /api/DeviceService/Actions/DeviceService.DevicesByPrivilegesAction
  - POST method for device privileges action
- /api/DeviceService/Actions/DeviceService.ExecuteAction
  - POST method /api/DeviceService/Actions/DeviceService.ExecuteAction
- /api/DeviceService/DeviceSlotType
  - GET method for DeviceSlotType
- /api/DeviceService/DeviceSettingsMetadata
  - GET method for DeviceSettingsMetadata
- /api/DeviceService/GlobalExcludes
  - GET method for GlobalExcludes
  - POST method for GlobalExcludes
- /api/DeviceService/Actions/DeviceService.AddNetworkRange
  - POST method for DeviceService.AddNetworkRange
- /api/DeviceService/Actions/DeviceService.EditNetworkRange
  - POST method for DeviceService.EditNetworkRange
- /api/DeviceService/Actions/DeviceService.RemoveFromExclusion
  - POST method for DeviceService.RemoveFromExclusion
- /api/DeviceService/Actions/DeviceService.ValidateExcludes
  - POST method for DeviceService.ValidateExcludes
- /api/DeviceService/Actions/DeviceService.RemoveDevices
  - POST method for DeviceService.RemoveDevices
- DeviceService_/api/ConnectionStateReasons
  - GET method for ConnectionStateReasons
- DeviceService_/api/ConnectionStateReasons(arg1)
  - GET method for ConnectionStateReasons(arg1)
Troubleshooting
- api/TroubleshootService
  - GET method for Troubleshoot Service
- /api/TroubleshootService/ProtocolTypes
  - GET method for ProtocolTypes
  - GET method for ProtocolTypes(arg)
- api /TroubleshootService/Files
  - GET method for Troubleshooting Files
- api/TroubleshootService/Actions/TroubleshootService.DeleteArchivedConsoleLogs
  - POST method to delete archived console logs
- api/TroubleshootService/Actions/TroubleshootService.DownloadFSDDatFile
  - POST method to download an FSD DAT file
- api/TroubleshootService/Actions/TroubleshootService.GetArchivedConsoleLogs
  - POST method for Service logs
- api/TroubleshootService/Actions/TroubleshootService.GetTroubleshootDocument
  - POST method for Troubleshooting Document
- api/TroubleshootService/Actions/TroubleshootService.GrantFSDFiles
  - POST method for Granting signed FSD files
- api/TroubleshootService/Actions/TroubleshootService.UploadFSDDatFile
  - POST method to upload FSD DAT file
- /api/TroubleshootService/Actions/TroubleshootService.DisableFSD
  - POST method to disable FSD
- api/TroubleshootService/Actions/TroubleshootService.UploadSSHPublicKey
  - POST method for SSH public key
- /api/TroubleshootService/Actions/TroubleshootService.InvokeDebugCap
  - POST method to Invoke Debug Cap
- api/TroubleshootService/Actions/TroubleshootService.TestDeviceConnection
  - POST method for TroubleshootService.TestDeviceConnection
- /api/TroubleshootService/Actions/TroubleshootService.TestApplianceConnection
  - POST method for TroubleshootService.TestApplianceConnection
- /api/TroubleshootService/ApplianceConnections
  - GET method for Appliance Connections
  - GET method for specific ApplianceConnections
Diagnostic
- /api/ApplicationService/Actions/ApplicationService.TestShareConnectivity
  - GET method for ApplicationService.TestShareConnectivity
- /api/DeviceService/Devices(Id)/Actions/DeviceService.Diagnostic
  - POST method for DeviceService.Diagnostic
Groups
- /api/GroupService/Groups
  - GET method for Groups
- /api/GroupService/Groups(Id)
  - GET method for Groups(Id)
  - PUT method for Groups(Id)
  - DELETE method for Groups(Id)
- /api/GroupService/Groups(Id)/Devices
  - GET method for Devices
- /api/GroupService/Groups(Id)/GroupDevicesSummary
  - GET method for GroupDevicesSummary
- /api/GroupService/Groups(Id)/SubGroups
  - GET method for SubGroups
- /api/GroupService/Groups(Id)/GroupHierarchy
  - GET method for GroupHierarchy
- /api/GroupService/GroupTypes
  - GET method for GroupTypes
- /api/GroupService/GroupTypes(Id)
  - GET method for GroupTypes(Id)
- /api/GroupService/MembershipTypes
  - GET method for MembershipTypes
- /api/GroupService/MembershipTypes(Id)
  - GET method for MembershipTypes(Id)
- /api/GroupService/AllGroupsHierarchy
  - GET method for AllGroupsHierarchy
- /api/GroupService/Actions/GroupService.AddMemberDevices
  - POST method for GroupService.AddMemberDevices
- /api/GroupService/Actions/GroupService.GroupsPrivilegesAction
  - POST method for GroupService.GroupsPrivilegesAction
- /api/GroupService/Actions/GroupService.GroupsByPrivilegesAction
  - POST method for GroupService.GroupsByPrivilegesAction
- GroupService_/api/Groups/Devices(arg1)
  - GET method for GroupService/Groups/Devices(arg1)
- GroupService_/api/Groups/AllLeaveDevices(arg1)
  - GET method for AllLeafDevice(arg1)
- GroupService_/api/Groups/AllLeafDevicesSummary(arg1)
  - GET method for AllLeafDevicesSummary
- api/ /GroupService/Actions/GroupService.DeleteGroupAttributes
  - POST method for GroupService.DeleteGroupAttributes
- api/GroupService/Actions/GroupService.DeleteUserToGroups
  - POST method for GroupService.DeleteUserToGroups
- api/GroupService/Actions/GroupService.GroupsByPrivilegesAction
  - POST method for GroupService.GroupsByPrivilegeAction
- api/GroupService/Actions/GroupService.LoadValidationContext
  - POST method for GroupService.LoadValidationContext
- api/GroupService/Groups(arg1)/InventoryDetails?$top=1&$skip=0
  - GET method for Inventory Details
Monitor
- Audit logs
  - /api/ApplicationService/AuditLogs
    - GET method for AuditLogs
    - /api/ApplicationService/AuditLogCategories
      - GET method for /api/ApplicationService/AuditLogCategories
  - /api/ApplicationService/AuditLogs(Id)
    - GET method for AuditLogs(Id)
- Jobs
Reset application
- /api/ApplicationService/Actions/ApplicationService.ResetApplication
  - POST method for ResetApplication
- api/ApplicationService/Actions/ApplicationService.SetSecurityPolicyMessage
  - POST method for SetSecurityPolicyMessage
- api/ApplicationService/Actions/ApplicationService.GetSecurityPolicyMessage
  - POST method for GetSecurityPolicyMessage
Console version
- /api/ApplicationService/Info
  - GET method for Info
Console capabilities
- /api/ApplicationService/Capabilities
  - GET method for Capabilities
Search
- /api/SearchService/Actions/SearchService.Search
  - POST method for SearchService.Search
Session
- /api/SessionService
  - GET method for SessionService
- /api/SessionService/Sessions
  - GET method for Sessions
  - POST method for Sessions
- /api/SessionService/Sessions(Id)
  - GET method for Sessions(Id)
  - DELETE method for Sessions(Id)
- /api/SessionService/CurrentUser
  - GET method for session details of current user
- /api/SessionService/SessionConfiguration
  - GET method for SessionConfiguration
- /api/SessionService/Actions/SessionService.SessionConfigurationUpdate
  - POST method for SessionService.SessionConfigurationUpdate
- /api/SessionService/Actions/SessionService.Logoff
  - POST method for session service log off
Application settings
- Console update
- Mobile
- Console Preferences
- Alerts
- Incoming Alerts
  - https://<IP>/api/ApplicationService/Settings
    - POST method for Jobs
- Warranty
  - https://<IP>/api/ApplicationService/Settings
    - POST method for Warranty settings
- Network Configuration
- Configuration compliance
- Troubleshoot service
- Query support service
- Groups service
- Profiles
- Devices
- Auto deploy
- Monitor
- Plugin Manager
- Power Metrics
Remote Management Service
- api/RemoteManagementService/AccessControlSettings
- api/RemoteManagementService/RemoteManagementHistory
  - GET method for RemoteManagementHistory
  - GET method for RemoteManagementHistory
Redfish resource model
- Redfish—ServiceRoot
- Redfish—SessionService
- Redfish—Account Service
- Redfish—Message Registry
- Redfish—Chassis
  - /redfish/v1/Chassis
- Redfish—Systems
- Redfish—CompositionService
- Redfish—EventService
- Redfish—OpenManage Enterprise License Manager
- Redfish—Telemetry
- Redfish—Managers
- Redfish—OpenID Connect Provider

PDF

Loading, Please wait

GET method for ProtocolTypes(arg)

Description

Returns the details for the indicated protocol.

Privilege

VIEW

HTTP response codes

200

Example response body

{
    "@odata.context": "/api/$metadata#TroubleshootService.ProtocolType",
    "@odata.type": "#TroubleshootService.ProtocolType",
    "@odata.id": "/api/TroubleshootService/ProtocolTypes(1)",
    "Id": 1,
    "Name": "SNMP",
    "Description": "Protocol definition for SNMP"
}

Data is not available for the Topic

Rate this content

All fields are required unless marked otherwise.

Accurate

not accurate

somewhat accurate

mostly accurate

accurate

very accurate

Useful

not useful

somewhat useful

mostly useful

useful

very useful

Easy to understand

not easy

somewhat easy

mostly easy

easy

very-easy

Was this article helpful?

Yes

No

Send us feedback (Optional)

0/3000 characters

Comments cannot contain these special characters: <>()\

Sorry, our feedback system is currently down. Please try again later.

Thank you for your feedback.

Please provide ratings (1-5 stars).

Please provide ratings (1-5 stars).

Please provide ratings (1-5 stars).

Please select whether the article was helpful or not.

Comments cannot contain these special characters: <>()\

Account

My Account
Order Status
Profile Settings
My Products
Make a Payment
Dell Rewards Balance

Support

Support Home
Contact Technical Support
Returns

Connect with Us

Community
Contact Us
X (Twitter)
LinkedIn
Instagram
YouTube

Our Offerings

Artificial Intelligence
Products
Solutions
Services
Deals

Our Company

Who We Are
Careers
Dell Technologies Capital
Investors
Newsroom
Recycling
Corporate Impact
Customer Stories

Our Partners

Find a Partner
Find a Reseller
OEM Solutions
Partner Program

Resources

Blog
Dell Rewards
Events
Email Sign-Up
Specialty Product Collections
Privacy Center
Security & Trust Center
Trial Software Downloads

Dell Technologies
Dell Premier for Business
Dell Financial Services

Copyright © 2025 Dell Inc.
Terms of Sale
Privacy Statement
Do Not Sell or Share My Personal Information
Cookies, Ads & Emails
Legal & Regulatory
Accessibility
Anti-Slavery, Human Trafficking & Child Labor