Skip to main content
Sign Out

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
  • Manage your Dell EMC sites, products, and product-level contacts using Company Administration.
Sign In Create an Account Dell Financial Services Premier Sign In Partner Program Sign In
Contact Us

Your Dell.com Carts

Dell EMC OpenManage Enterprise 3.9 RESTful API Guide

PDF

Preface

As part of an effort to improve product lines, we periodically release revisions of software. Therefore, some functions described in this document might not be supported by all versions of the software currently in use. The product release notes provide the most up-to-date information on product features.

Contact your technical support professional if a product does not function properly or does not function as described in this document.

NOTE:This document was accurate at publication time. Go to Online Support (https://www.dell.com/support) to ensure that you are using the latest version of this document.

Purpose

This document includes conceptual information on managing OpenManage Enterprise.

Audience

This document is intended for use by administrators, device managers, and viewers who use OpenManage Enterprise for systems management and monitoring.

Related documentation

The following publications provide additional information:

  • OpenManage Enterprise Support Matrix
  • OpenManage Enterprise Release Notes
  • OpenManage Enterprise Security Configuration Guide
  • OpenManage Enterprise User's Guide
  • OpenManage Enterprise RESTful API Guide
  • OpenManage Enterprise RESTful API at https://developer.dell.com/apis.
  • OpenManage Enterprise Modular Edition Release Notes
  • OpenManage Enterprise Modular Edition RESTful API Guide

In addition to the core documents, we also provide white papers, plugin documentation and demos on YouTube.

Typographical conventions

This document uses the following style conventions:

Bold Used for names of interface elements, such as names of windows, dialog boxes, buttons, fields, tab names, key names, and menu paths (what the user specifically selects or clicks)
Italic Used for full titles of publications referenced in text
Monospace Used for:
  • System code
  • System output, such as an error message or script
  • Path names, filenames, prompts, and syntax
  • Commands and options
Monospace italic Used for variables
Monospace bold Used for user input
[ ] Square brackets enclose optional values
| Vertical bar indicates alternate selections - the bar means "or"
{ } Braces enclose content that the user must specify, such as x or y or z
... Ellipses indicate nonessential information omitted from the example

Product documentation

NOTE:For video demos and tutorials, search for the Dell EMC OpenManage Enterprise playlist on YouTube, or see the following videos for demos of the Dell EMC OpenManage Enterprise Graphical User Interface (GUI) in action:
  • For OpenManage Enterprise, go to https://www.dell.com/openmanagemanuals.

    To display the documentation of:

    • Dell EMC OpenManage Enterprise, click

      Dell OpenManage Enterprise > Dell EMC OpenManage Enterprise > Documentation.

    • Dell EMC OpenManage Mobile, click

      OpenManage Mobile > Select the required version > Documentation.

  • For OpenManage Enterprise plugins, go to https://www.dell.com/openmanagemanuals.

    To display the documentation of:

    • Dell EMC OpenManage Enterprise Services plugin, click

      OpenManage Enterprise Connected Services > OpenManage Enterprise Services > Documentation.

    • Dell EMC OpenManage Enterprise Power Manager plugin, click

      OpenManage Enterprise Power Manager > Dell EMC OpenManage Enterprise Power Manager > Documentation.

    • Dell EMC OpenManage Enterprise Update Manager plugin, click

      OpenManage Enterprise Update Manager > OpenManage Enterprise Update Manager > Documentation.

    • Dell EMC OpenManage Enterprise CloudIQ plugin, click

      OpenManage Enterprise Connected Services > OpenManage Enterprise CloudIQ > Documentation.

  • For OpenManage Enterprise APIs, go to https://developer.dell.com/products,

    To display the API documentation of:

    • Dell EMC OpenManage Enterprise, click Servers > OpenManage Enterprise API
    • Dell EMC OpenManage Enterprise Modular Edition, click Servers > OpenManage Enterprise Modular API
    • Dell EMC OpenManage Enterprise Services plugin, click Servers > OpenManage Enterprise Services API.
    • Dell EMC OpenManage Enterprise Update Manager plugin, click Servers > OpenManage Enterprise Update Manager API
    • Dell EMC OpenManage Enterprise Power Manager plugin, click Servers > OpenManage Enterprise Power Manager API
    • Dell EMC OpenManage Enterprise CloudIQ plugin, click CloudIQ Public API
  • For OpenManage Enterprise whitepapers , go to https://www.dell.com/openmanagemanuals and click

    Dell OpenManage Enterprise > Dell EMC OpenManage Enterprise > Documentation.

    The following white papers are available:

    • Dell EMC OpenManage Enterprise Scope Based Access Control (SBAC)
    • Dell EMC OpenManage Enterprise Login with PingFederate
    • Dell EMC OpenManage Enterprise Profile Management
    • Dell EMC OpenManage Enterprise Multihoming
    • Dell EMC OpenManage Enterprise Boot-from-SAN Deployment
    • Dell EMC OpenManage Enterprise Template Cloning
    • Dell EMC OpenManage Enterprise Auto-Deploy Provisioning
    • Dell EMC OpenManage Enterprise Remote Script Execution
    • Dell EMC OpenManage Enterprise Repository Manager Integration
    • Dell EMC OpenManage Enterprise Events Management
    • Dell EMC OpenManage Enterprise Scale and Performance
    • Dell EMC OpenManage Enterprise Advanced Server Configuration
    • Dell EMC OpenManage Enterprise End-to-End Automation with REST API
    • Dell EMC OpenManage Enterprise Deployment
    • Dell EMC OpenManage Enterprise Upgrade
    • Dell EMC OpenManage Enterprise Firmware Upgrade APIs
    • Dell EMC OpenManage Enterprise Firmware Baselines and Catalogs
    • Dell EMC OpenManage Enterprise Custom Groups and Reports

Product information

For documentation, release notes, software updates, or information about products, go to Online Support at https://www.dell.com/support.

Where to get help

Go to Online Support at https://www.dell.com/support and click Contact Support. To open a service request, you must have a valid support agreement. Contact your sales representative for details about obtaining a valid support agreement or with questions about your account.

NOTE:

For quick access to the content of the OpenManage Enterprise User's Guide, open the OpenManage Enterprise Online Help by clicking the ? icon in the upper-right corner of a screen in the product GUI.

Where to find the support matrix

Consult the Support Matrix on Dell OpenManage Enterprise at https://www.dell.com/openmanagemanuals and click Documentation.

Your comments

Your suggestions will help us continue to improve the accuracy, organization, and overall quality of the user publications. Send your opinions of this document to https://contentfeedback.dell.com/s.

Rate this content

Accurate
Useful
Easy to understand
Was this article helpful?
0/3000 characters
  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: <>()\