Request URLs

You can use URLs to submit resource requests through 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 specific system
FlashCopy
  • GET /v1/flashcopy – lists FlashCopy volumes
  • GET /v1/volumes/volume_id/flashcopy – lists all FlashCopy 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 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
Nodes
  • GET /v1/nodes – displays all nodes
  • GET /v1/nodes/node_id – displays a specific node
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}
  • 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
Systems
  • GET /v1/systems – lists all system properties
  • GET /v1/systems/series_number/performanceevents[?after=yyyy-MMddTHH: mm:ssZ&before=yyyy-MM-ddTHH:mm:ssZ] - lists performance from a specific system
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