IBM Cloud Object Storage System Version 3.14.1 Device API Developer Guide

IBM Cloud Object Storage System™ Version 3.14.1 Device API Developer Guide


IBM Cloud Object Storage System Version 3.14.1 Device API Developer Guide - cover page
Brand
IBM
Category
Storage
Document type
Programming Manual
Language
English
Pages
59
File format
PDF
File size
1011 KB
Published
29 November, 2023
Updated
29 November, 2023
MD5 checksum
483C1A14625E4ABED20E36BC0D860373

About this manual

This IBM Device API Developer Guide covers the Device API for IBM Cloud Object Storage System Version 3.14.1. The APIs provide health and statistics data for devices as JSON, and the feature must be enabled through the editSystemDeviceLevelAPIConfiguration API or the Administration tab in IBM Cloud Object Storage Manager.

The reference describes the state API, which gives an overall view of the current device state, including SNMP status, process status, drive health and temperature, fan health, CPU temperature, and voltage levels. The document also includes a Statistic section, response parameters, and notices.

What's inside

  • Document Information
  • Device API reference
  • Overview
  • State
  • Request
  • Response
  • Statistic
  • Notices
  • Trademarks
  • Homologation statement

Specifications

Response formatJSON
State API HTTP methodGET /state
Default API port8192

Frequently asked questions

What does the Device API provide?

It provides health and statistics data for IBM Cloud Object Storage System devices.

What format does the Device API return data in?

The device API returns data as JSON.

How can the Device API feature be enabled?

It can be enabled through the editSystemDeviceLevelAPIConfiguration API or the Administration tab in the IBM Cloud Object Storage Manager UI.

What does the state API show?

It gives an overall view of the current device state, including SNMP status, process status, drive health and temperature, fan health, CPU temperature, and voltage levels.

Download PDF (1011 KB)

More IBM Manuals


View all IBM manuals →