Skip to content

Latest commit

 

History

History
executable file
·
340 lines (333 loc) · 158 KB

endpoints-support.md

File metadata and controls

executable file
·
340 lines (333 loc) · 158 KB

Legend

Item Meaning
Endpoint implemented in the GO SDK and tested for this API version 🎉
✖️ Endpoint considered as 'out-of-scope' for the GO SDK.
Endpoint not available for this API Version

Notes

  • If an endpoint is marked as implemented in a previous version of the API, it will likely already be working for newer API versions, however in these cases it is important to:
  1. Specify the 'type' of the resource when using an untested API, as it will not get set by default
  2. If an example is not working, verify the HPE OneView REST API Documentation for the respective API version being used, since the expected attributes for that resource might have changed.

HPE OneView

Endpoints Verb V1200 V1600 V1800 V2000 V2200 V2400 V2600 V2800 V3000 V3200 V3400 V3600 V3800 v4000 v4200
Appliance Configuration Timeconfig
/rest/appliance/configuration/timeconfig/locales GET
Appliance SNMPv1 Trap Destinations
/rest/appliance/trap-destinations GET
/rest/appliance/trap-destinations POST
/rest/appliance/trap-destinations/validation POST
/rest/appliance/trap-destinations/{id}} GET
/rest/appliance/trap-destinations/{id} PUT
/rest/appliance/trap-destinations/{id} DELETE
Appliance Time and Locale Configuration
/rest/appliance/configuration/time-locale GET
/rest/appliance/configuration/time-locale POST
Appliance SNMPv3 Trap Destinations
/rest/appliance/snmpv3-trap-forwarding/destinations GET
/rest/appliance/snmpv3-trap-forwarding/destinations POST
/rest/appliance/snmpv3-trap-forwarding/destinations/validation POST
/rest/appliance/snmpv3-trap-forwarding/destinations/{id}} GET
/rest/appliance/snmpv3-trap-forwarding/destinations/{id} PUT
/rest/appliance/snmpv3-trap-forwarding/destinations/{id} DELETE
Appliance SNMPv3 User
/rest/appliance/snmpv3-trap-forwarding/users GET
/rest/appliance/snmpv3-trap-forwarding/users POST
/rest/appliance/snmpv3-trap-forwarding/users/{id}} GET
/rest/appliance/snmpv3-trap-forwarding/users/{id} PUT
/rest/appliance/snmpv3-trap-forwarding/users/{id} DELETE
/rest/appliance/snmpv3-trap-forwarding/users DELETE
Appliance SSH Access
/rest/appliance/ssh-access GET
/rest/appliance/ssh-access PUT
Connection Templates
/rest/connection-templates GET
/rest/connection-templates/defaultConnectionTemplate GET
/rest/connection-templates/{id} GET
/rest/connection-templates/{id} PUT
Email Notifications
/rest/appliance/notifications/email-config GET
/rest/appliance/notifications/email-config POST
/rest/appliance/notifications/email-config/filters GET
/rest/appliance/notifications/send-email POST
/rest/appliance/notifications/test-email POST
/rest/appliance/notifications/test-email-config GET
Enclosures
/rest/enclosures GET ✖️ ✖️
/rest/enclosures POST ✖️ ✖️
/rest/enclosures/{id} GET ✖️ ✖️
/rest/enclosures/{id} PATCH ✖️ ✖️
/rest/enclosures/{id} DELETE ✖️ ✖️
Enclosure Groups
/rest/enclosure-groups GET ✖️
/rest/enclosure-groups POST ✖️
/rest/enclosure-groups/{id} GET ✖️
/rest/enclosure-groups/{id} PUT ✖️
/rest/enclosure-groups/{id} DELETE ✖️
/rest/enclosure-groups/{id}/script GET ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️
/rest/enclosure-groups/{id}/script PUT ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️
Ethernet Networks
/rest/ethernet-networks GET
/rest/ethernet-networks POST
/rest/ethernet-networks/bulk POST
/rest/ethernet-networks/{id} GET
/rest/ethernet-networks/{id} PUT
/rest/ethernet-networks/{id} PATCH
/rest/ethernet-networks/{id} DELETE
/rest/ethernet-networks/{id}/associatedProfiles GET
/rest/ethernet-networks/{id}/associatedUplinkGroups GET
/rest/ethernet-networks/bulk-delete DELETE
FC Networks
/rest/fc-networks GET
/rest/fc-networks POST
/rest/fc-networks/{id} GET
/rest/fc-networks/{id} PATCH ✖️
/rest/fc-networks/{id} PUT
/rest/fc-networks/{id} DELETE
/rest/fc-networks/bulk-delete DELETE
FCoE Networks
/rest/fcoe-networks GET
/rest/fcoe-networks POST
/rest/fcoe-networks/{id} GET
/rest/fcoe-networks/{id} PATCH ✖️
/rest/fcoe-networks/{id} PUT
/rest/fcoe-networks/{id} DELETE
/rest/fcoe-networks/bulk-delete DELETE
Firmware Drivers
/rest/firmware-drivers GET
/rest/firmware-drivers POST
/rest/firmware-drivers/{id} GET
/rest/firmware-drivers/{id} DELETE
Hypervisor Cluster Profiles
/rest/hypervisor-cluster-profiles GET
/rest/hypervisor-cluster-profiles POST
/rest/hypervisor-cluster-profiles/virtual-switch-layout POST
/rest/hypervisor-cluster-profiles/{id} GET
/rest/hypervisor-cluster-profiles/{id} PUT
/rest/hypervisor-cluster-profiles/{id} DELETE
/rest/hypervisor-cluster-profiles/compliance-preview GET
Hypervisor Managers
/rest/hypervisor-managers GET
/rest/hypervisor-managers POST
/rest/hypervisor-managers/{id} GET
/rest/hypervisor-managers/{id} PUT
/rest/hypervisor-managers/{id} DELETE
ID Pools
/rest/id-pools/{poolType} GET
/rest/id-pools/{poolType} PUT
/rest/id-pools/{poolType}/allocator PUT
/rest/id-pools/{poolType}/checkrangeavailability GET
/rest/id-pools/{poolType}/collector PUT
/rest/id-pools/{poolType}/generate GET
/rest/id-pools/{poolType}/validate GET
/rest/id-pools/{poolType}/validate PUT
Id Pools Ipv4 Ranges
/rest/id-pools/ipv4/ranges POST
/rest/id-pools/ipv4/ranges/{id} GET
/rest/id-pools/ipv4/ranges/{id} PUT
/rest/id-pools/ipv4/ranges/{id} DELETE
/rest/id-pools/ipv4/ranges/{id}/allocated-fragments GET
/rest/id-pools/ipv4/ranges/{id}/free-fragments GET
/rest/id-pools/ipv4/ranges/{id}/allocator PUT
/rest/id-pools/ipv4/ranges/{id}/collector PUT
Id Pools Ipv4 Subnets
/rest/id-pools/ipv4/subnets POST
/rest/id-pools/ipv4/subnets GET
/rest/id-pools/ipv4/subnets/{id} GET
/rest/id-pools/ipv4/subnets/{id} PUT
/rest/id-pools/ipv4/subnets/{id}/allocator PUT
/rest/id-pools/ipv4/subnets/{id}/collector PUT
/rest/id-pools/ipv4/subnets/{id} DELETE
Interconnects
/rest/interconnects GET ✖️ ✖️ ✖️
/rest/interconnects/{id} GET ✖️ ✖️ ✖️
Interconnect Types
/rest/interconnect-types GET
/rest/interconnect-types/{id} GET
Labels
/rest/labels GET
rest/labels/resources POST
rest/labels/resources/{resourceUri} GET
rest/labels/resources/{resourceUri} PUT
rest/labels/resources/{resourceUri} DELETE
rest/labels/{id} GET
Logical Enclosures
/rest/logical-enclosures GET ✖️ ✖️
/rest/logical-enclosures POST ✖️ ✖️
/rest/logical-enclosures/{id} GET ✖️ ✖️
/rest/logical-enclosures/{id} PUT ✖️ ✖️
/rest/logical-enclosures/{id} PATCH ✖️ ✖️
/rest/logical-enclosures/{id}/updateFromGroup PUT ✖️ ✖️ ✖️
/rest/logical-enclosures/{id} DELETE ✖️ ✖️
/rest/logical-enclosures/{id}/support-dumps POST
Logical Interconnect Groups
/rest/logical-interconnect-groups GET ✖️ ✖️
/rest/logical-interconnect-groups POST ✖️ ✖️
/rest/logical-interconnect-groups/{id} GET ✖️ ✖️
/rest/logical-interconnect-groups/defaultSettings GET ✖️ ✖️ ✖️ ✖️
/rest/logical-interconnect-groups/{id} PUT ✖️ ✖️
/rest/logical-interconnect-groups/{id} PATCH ✖️
/rest/logical-interconnect-groups/{id} DELETE ✖️ ✖️
Logical Interconnects
/rest/logical-interconnects GET ✖️ ✖️ ✖️ ✖️
/rest/logical-interconnects/bulk-inconsistency-validation POST
/rest/logical-interconnects/compliance PUT ✖️ ✖️ ✖️ ✖️
/rest/logical-interconnects/{id} GET ✖️ ✖️ ✖️ ✖️
/rest/logical-interconnects/{id} PATCH ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️
/rest/logical-interconnects/compliance PUT ✖️ ✖️ ✖️ ✖️
/rest/logical-interconnects/{id}/compliance PUT ✖️ ✖️ ✖️ ✖️
/rest/logical-interconnects/{id}/ethernetSettings GET ✖️ ✖️ ✖️ ✖️
/rest/logical-interconnects/{id}/ethernetSettings PUT ✖️ ✖️ ✖️ ✖️
/rest/logical-interconnects/{id}/firmware GET ✖️ ✖️ ✖️ ✖️
/rest/logical-interconnects/{id}/firmware PUT ✖️ ✖️ ✖️ ✖️
/rest/logical-interconnects/{id}/forwarding-information-base GET ✖️ ✖️ ✖️ ✖️
/rest/logical-interconnects/{id}/forwarding-information-base POST ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️
/rest/logical-interconnects/{id}/forwarding-information-base/{dumpFileName}.{suffix} GET ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️
/rest/logical-interconnects/{id}/internalNetworks PUT ✖️ ✖️ ✖️ ✖️
/rest/logical-interconnects/{id}/internalNetworks GET ✖️ ✖️ ✖️ ✖️
/rest/logical-interconnects/{id}/internalVlans GET ✖️ ✖️ ✖️ ✖️
/rest/logical-interconnects/{id}/qos-aggregated-configuration GET ✖️ ✖️ ✖️ ✖️
/rest/logical-interconnects/{id}/qos-aggregated-configuration PUT ✖️ ✖️ ✖️ ✖️
/rest/logical-interconnects/{id}/snmp-configuration GET ✖️ ✖️ ✖️ ✖️
/rest/logical-interconnects/{id}/snmp-configuration PUT ✖️ ✖️ ✖️ ✖️
/rest/logical-interconnects/{id}/unassignedPortsForPortMonitor GET ✖️ ✖️ ✖️ ✖️
/rest/logical-interconnects/{id}/unassignedUplinkPortsForPortMonitor GET ✖️ ✖️ ✖️ ✖️
/rest/logical-interconnects/{lsId}/configuration PUT ✖️ ✖️ ✖️ ✖️
/rest/logical-interconnects/{lsId}/port-monitor GET ✖️ ✖️ ✖️ ✖️
/rest/logical-interconnects/{lsId}/port-monitor PUT ✖️ ✖️ ✖️ ✖️
/rest/logical-interconnects/{lsId}/telemetry-configurations/{tcId} GET ✖️ ✖️ ✖️ ✖️
/rest/logical-interconnects/{lsId}/telemetry-configurations/{tcId} GET ✖️ ✖️ ✖️ ✖️
/rest/logical-interconnects/{Id}/portFlapSettings PUT ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️
Logical Switch Groups
/rest/logical-switch-groups GET ✖️ ✖️ ✖️ ✖️ ✖️
/rest/logical-switch-groups POST ✖️ ✖️ ✖️ ✖️ ✖️:
/rest/logical-switch-groups/{id} GET ✖️ ✖️ ✖️ ✖️ ✖️:
/rest/logical-switch-groups/{id} PUT ✖️ ✖️ ✖️ ✖️ ✖️
/rest/logical-switch-groups/{id} DELETE ✖️ ✖️ ✖️ ✖️ ✖️
Logical Switches
/rest/logical-switches GET ✖️ ✖️ ✖️
/rest/logical-switches POST ✖️ ✖️ ✖️
/rest/logical-switches/{id} GET ✖️ ✖️ ✖️
/rest/logical-switches/{id} PUT ✖️ ✖️ ✖️
/rest/logical-switches/{id} DELETE ✖️ ✖️ ✖️
/rest/logical-switches/{id}/refresh PUT ✖️ ✖️ ✖️
Network Sets
/rest/network-sets GET ✖️ ✖️
/rest/network-sets POST ✖️ ✖️
/rest/network-sets/withoutEthernet GET ✖️ ✖️ ✖️
/rest/network-sets/{id} GET ✖️ ✖️ ✖️
/rest/network-sets/{id} PUT ✖️ ✖️
/rest/network-sets/{id} DELETE ✖️ ✖️
/rest/network-sets/{id} PATCH ✖️ ✖️
OS Deployment Plans
/rest/os-deployment-plans/ GET ✖️ ✖️ ✖️ ✖️
/rest/os-deployment-plans/{id} GET ✖️ ✖️ ✖️ ✖️
Power Devices
/rest/power-devices GET ✖️ ✖️ ✖️
/rest/power-devices/{id} GET ✖️ ✖️ ✖️ ✖️
SAN Managers
/rest/fc-sans/device-managers GET ✖️ ✖️ ✖️ ✖️
/rest/fc-sans/device-managers/{id} GET ✖️ ✖️
/rest/fc-sans/device-managers/{id} PUT ✖️ ✖️ ✖️ ✖️
/rest/fc-sans/device-managers/{id} DELETE ✖️ ✖️ ✖️ ✖️:
/rest/fc-sans/providers/{id}/device-managers POST ✖️ ✖️ ✖️ ✖️
Scope
/rest/scope GET
/rest/scope/{id} GET
/rest/scope/{id} PUT
/rest/scope POST
/rest/scope/{id} DELETE
/rest/scopes/resources/** GET
/rest/scopes/resources/** PUT
Server Certificates
/rest/certificates/https/remote/{address} GET
/rest/certificates/servers POST
/rest/certificates/servers/{aliasName} GET
/rest/certificates/servers/{aliasName} PUT
/rest/certificates/servers/{aliasName} DELETE
Server Hardware
/rest/server-hardware GET
/rest/server-hardware/{id} GET
/rest/server-hardware/{id}/powerState PUT
/rest/server-hardware/{id}/firmware GET ✖️ ✖️
/rest/server-hardware POST
/rest/server-hardware/discovery POST
/rest/server-hardware/{id}/refreshState PUT
/rest/server-hardware/{id}/mpFirmwareVersion PUT
/rest/server-hardware/*/firmware GET
/rest/server-hardware/{id} PATCH
Server Hardware Types
/rest/server-hardware-types GET ✖️
/rest/server-hardware-types/{id} GET ✖️
/rest/server-hardware-types/{id} PUT ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️
/rest/server-hardware-types/{id} DELETE ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️
Server Profile Templates
/rest/server-profile-templates GET ✖️
/rest/server-profile-templates POST ✖️
/rest/server-profile-templates/{id} GET ✖️
/rest/server-profile-templates/{id} PUT ✖️
/rest/server-profile-templates/{id} DELETE ✖️
Server Profiles
/rest/server-profiles GET ✖️
/rest/server-profiles POST ✖️
/rest/server-profiles/{id} GET ✖️
/rest/server-profiles DELETE ✖️
/rest/server-profiles PUT ✖️
/rest/server-profiles PATCH ✖️ ✖️ ✖️
Storage Pools
/rest/storage-pools GET ✖️ ✖️
/rest/storage-pools/{id} GET ✖️ ✖️
/rest/storage-pools/{id} PUT ✖️ ✖️
Storage Systems
/rest/storage-systems GET
/rest/storage-systems/{id} GET
/rest/storage-systems/{id}/reachable-ports GET
/rest/storage-systems POST
/rest/storage-systems DELETE
/rest/storage-systems/{id} PUT
/rest/storage-systems/{id}/storage-volume-sets GET
Storage Volume Attachments
/rest/storage-volume-attachments GET ✖️ ✖️ ✖️
/rest/storage-volume-attachments/{id} GET ✖️ ✖️ ✖️
Storage Volume Templates
/rest/storage-volume-templates GET ✖️ ✖️ ✖️
/rest/storage-volume-templates/{id} GET ✖️ ✖️ ✖️
/rest/storage-volume-templates POST ✖️ ✖️ ✖️
/rest/storage-volume-templates DELETE ✖️ ✖️ ✖️
/rest/storage-volume-templates/{id} PUT ✖️ ✖️ ✖️
Switch Types
/rest/switch-types GET ✖️ ✖️ ✖️ ✖️
/rest/switch-types/{id} GET ✖️ ✖️ ✖️ ✖️
Tasks
/rest/tasks GET
/rest/tasks/{id} GET
/rest/tasks/{id} GET{Tree View}
/rest/tasks/{id} GET{Aggregated Task list}
/rest/tasks/{id} GET{Flat Array}
/rest/tasks/{id} PATCH
Version
/rest/version GET
Uplink Sets
/rest/uplink-sets GET
/rest/uplink-sets/{id} GET
/rest/uplink-sets POST
/rest/uplink-sets/{id} PUT
/rest/uplink-sets/{id} DELETE
Volumes
/rest/storage-volumes GET
/rest/storage-volumes/{id} GET
/rest/storage-volumes POST
/rest/storage-volumes/{id} PUT
/rest/storage-volumes/{id} DELETE

HPE Synergy Image Streamer

Endpoints Verb V300 V500 V600 V800 V1000 V1020 V1600 V2000 V2010 V2020
Deployment Plans
/rest/deployment-plans POST ✖️
/rest/deployment-plans GET ✖️
/rest/deployment-plans/{id} GET ✖️
/rest/deployment-plans/{id} PUT ✖️
/rest/deployment-plans/{id} DELETE ✖️