Request URLs

Edit online

You can use URLs to submit resource requests through the RESTful API.

The following request URLs are defined:
Events
  • GET /v1/events[?severity=info,warning,error&after=yyyy-MM-ddTHH:mm:ssZ&before=yyyy-MM-ddTHH:mm:ssZ] – Lists events from a specific system.
Files (DS8880, only)
  • GET v1/files/performancesummary – Displays latest performance summary.
  • GET v1/files/etdata – Displays latest EasyTier data.
  • GET v1/files/sysdata – Displays latest system data.
FlashCopy
  • GET /v1/flashcopy – Lists FlashCopy volumes.
  • GET /v1/volumes/{volume_id}/flashcopy – Lists all FlashCopy copies of a specific volume.
Hosts
  • GET|POST /v1/hosts – Lists all hosts or creates a host.
  • GET|PUT|DELETE /v1/hosts/{host_name} – Lists, updates, or deletes a host.
Host mappings
  • GET|POST /v1/hosts/{host_name}/mappings – Lists or adds volumes' mappings under a host.
  • GET|DELETE /v1/hosts/{host_name}/mappings/{mapping_id} – Lists or deletes a specific volume mapping under a host.
Host ports
  • GET|POST /v1/host_ports – Lists all host ports or creates a host port.
  • GET|PUT|DELETE /v1/host_ports/{wwpn} – Lists, updates, or deletes a specific host port.
  • GET /v1/hosts/{host_name}/host_ports – Lists all host ports of a specific host.
I/O enclosures
  • GET /v1/io_enclosures – Lists all I/O enclosures.
  • GET /v1/io_enclosures/{ioenclosure_id} – Lists a specific I/O enclosure.
I/O ports
  • GET /v1/ioports – Lists all I/O ports.
  • GET /v1/ioports/{port_id} – Lists a specific I/O port.
  • GET /v1/hosts/{host_name}/ioports – Lists all I/O ports of a specific host.
LSS
  • GET /v1/lss[?type=fb|ckd] – Displays all LSSs of type FB or CKD.
  • GET /v1/lss/{lss_id} – Displays a specific LSS.
Managed arrays
  • GET /v1/marrays – Displays all managed arrays.
  • GET /v1/marrays/{marray_id} – Displays a specific managed array.
  • GET /v1/pools/{pool_id}/marrays – Displays all managed arrays of a specific pool.
Nodes
  • GET /v1/nodes – Displays all nodes.
  • GET /v1/nodes/{node_id} – Displays a specific node.
ODD files (DS8880, only)
  • GET /v1/odd – Displays generated ODD dump files on both nodes.
  • GET /v1/odd/offload – Displays status of latest ODD dump files offloading.
  • POST /v1/odd/offload/ – Sends ODD dump files to IBM.
PE package (DS8880, only)
  • GET /v1/pepackage/offload – Displays latest PE package offloading status.
  • POST /v1/pepackage/offload – Generates latest PE package(s) automatically and sends to IBM.
Pools
  • GET /v1/pools – Lists all pools.
  • GET /v1/pools/{pool_id} – Lists a specific pool.
Remote Mirror and Copy (formerly PPRC)
  • GET /v1/volumes/{volume_id}/pprc – Displays the PPRC properties of a specific volume.
  • GET /v1/pprc – Lists all PPRC relationships.
  • GET /v1/cs/pprcs?volume_id_from={volume_id}&volume_id_to={volume_id}
  • GET /v1/cs/pprcs/{pprc_id}
  • GET /v1/cs/physical_links?source_lss_id={source_lss_id}&target_lss_id={target_lss_id}&target_system_wwnn={target_system_wwnn}
  • GET /v1/cs/pprcs/paths?source_lss_id_from={source_lss_id}&source_lss_id_to={source_lss_id}
  • GET /v1/cs/pprcs/paths/{path_id}
Self upgrade
  • GET /v1/self_upgrade – Displays information on last upgrade.
  • POST /v1/self_upgrade – Upgrades API services.
Space-efficient
  • GET|PUT|DELETE /v1/pools/{pool_id}/tserep|eserep – Lists, updates, or deletes a TSE or ESE repository for a specific pool.
Statesave files (DS8880, only)
  • GET /v1/statesave – Displays all generated statesave dump files.
  • GET /v1/statesave/offload – Displays status of latest statesave dump files offloading.
  • POST /v1/statesave/offload – Sends statesave dump files to IBM.
Systems
  • GET /v1/systems – Lists all system properties.
  • GET /v1/systems/{serial_number}/performance – Lists performance from a specific system.
Users
  • GET /v1/users – Lists all system users.
  • GET /v1/users/{user_name} – Lists a specific system user.
Volumes
  • GET|PUT|DELETE /v1/volumes/{volume_id} – Lists, updates, or deletes a specific volume.
  • POST /v1/volumes – Adds a volume.
  • GET /v1/lss/{lss_id}/volumes – Displays volumes of a specific LSS.
  • GET /v1/pools/{pool_id}/volumes – Lists volumes of a specific pool.
  • GET /v1/hosts/{host_name}/volumes – Lists all volumes of a specific host.