Skip to content

Latest commit

 

History

History
executable file
·
537 lines (528 loc) · 203 KB

endpoints-support.md

File metadata and controls

executable file
·
537 lines (528 loc) · 203 KB

Legend

Item Meaning
Endpoint implemented in the Python SDK and tested for this API version 🎉
✖️ Endpoint considered as 'out-of-scope' for the Python 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 API version being used, since the expected attributes for that resource might have changed.

HPE OneView

Endpoints Verb V800 V1000 V1200 V1600 V1800 V2000 V2200 V2400 V2600 V2800 V3000 V3200 V3400 V3600
Appliance Configuration Timeconfig
/rest/appliance/configuration/timeconfig/locales GET
Appliance Node Information
/rest/appliance/nodeinfo/status GET
/rest/appliance/nodeinfo/version GET
Appliance Health-Status
/rest/appliance/health-status GET
Appliance Network Interfaces
/rest/appliance/network-interfaces GET
/rest/appliance/network-interfaces POST
/rest/appliance/network-interfaces/{macAddress} GET
/rest/appliance/network-interfaces/mac-addresses GET
Appliance Proxy Configuration
/rest/appliance/proxy-config GET
/rest/appliance/proxy-config POST
/rest/appliance/proxy-config DELETE
Appliance SNMPv1 Trap Destinations
/rest/appliance/trap-destinations GET
/rest/appliance/trap-destinations/validation POST
/rest/appliance/trap-destinations/{id} POST
/rest/appliance/trap-destinations/{id} GET
/rest/appliance/trap-destinations/{id} PUT
/rest/appliance/trap-destinations/{id} DELETE
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 Users
/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/sub> GET
/rest/appliance/ssh-access/sub> PUT
Appliance Time and Locale Configuration
/rest/appliance/configuration/time-locale GET
/rest/appliance/configuration/time-locale POST
Certificates Server
/rest/certificates/servers POST
/rest/certificates/https/remote/{address} GET
/rest/certificates/servers/{aliasName} GET
/rest/certificates/servers/{aliasName} PUT
/rest/certificates/servers/{aliasName} DELETE
Connection Templates
/rest/connection-templates GET
/rest/connection-templates/defaultConnectionTemplate GET
/rest/connection-templates/{id} GET
/rest/connection-templates/{id} PUT
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
Enclosures
/rest/enclosures GET
/rest/enclosures POST
/rest/enclosures/{id} GET
/rest/enclosures/{id} PATCH
/rest/enclosures/{id} DELETE
/rest/enclosures/{id}/configuration PUT
/rest/enclosures/{id}/environmentalConfiguration GET
/rest/enclosures/{id}/environmentalConfiguration PUT
/rest/enclosures/{id}/refreshState PUT
/rest/enclosures/{id}/script GET
/rest/enclosures/{id}/sso GET
/rest/enclosures/{id}/utilization GET
/rest/enclosures/{id}/https/certificaterequest GET
/rest/enclosures/{id}/https/certificaterequest POST
/rest/enclosures/{id}/https/certificaterequest 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 POST
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 POST
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 POST
Firmware Bundles
/rest/firmware-bundles POST
/rest/firmware-bundles/addCompsig POST
/rest/firmware-bundles/resumable POST ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️
Firmware Drivers
/rest/firmware-drivers GET
/rest/firmware-drivers POST
/rest/firmware-drivers/schema GET
/rest/firmware-drivers/{id} GET
/rest/firmware-drivers/{id} DELETE
HA Nodes
/rest/appliance/ha-nodes GET
/rest/appliance/ha-nodes/{id} GET
/rest/appliance/ha-nodes/{id} PUT
/rest/appliance/ha-nodes/{id} PATCH
/rest/appliance/ha-nodes/{id} DELETE
Hypervisor Cluster Profiles
/rest/hypervisor-cluster-profiles POST
/rest/hypervisor-cluster-profiles GET
/rest/hypervisor-cluster-profiles/{id} GET
/rest/hypervisor-cluster-profiles/{id} PUT
/rest/hypervisor-cluster-profiles/{id} DELETE
/rest/hypervisor-cluster-profiles/virtualswitch-layout POST
/rest/hypervisor-cluster-profiles/{id}/compliance-preview GET
Hypervisor Managers
/rest/hypervisor-managers POST
/rest/hypervisor-managers GET
/rest/hypervisor-managers/{id} GET
/rest/hypervisor-managers/{id} PUT
/rest/hypervisor-managers/{id} DELETE
ID Pools
/rest/id-pools/schema GET
/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 Pool IPV4 Range
/rest/id-pools/ipv4/ranges POST
/rest/id-pools/ipv4/ranges/schema GET
/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}/allocator PUT
/rest/id-pools/ipv4/ranges/{id}/collector PUT
/rest/id-pools/ipv4/ranges/{id}/allocated-fragments GET
/rest/id-pools/ipv4/ranges/{id}/free-fragments GET
ID Pool IPv4 Subnets
/rest/id-pools/ipv4/subnets GET
/rest/id-pools/ipv4/subnets POST
/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
Index Resources
/rest/index/resources GET
/rest/index/resources/** GET
/rest/index/resources/aggregated GET
/rest/index/resources/aggregated GET
/rest/index/resources/aggregated GET
Interconnects
/rest/interconnects GET
/rest/interconnects/{id} GET
/rest/interconnects/{id} PATCH
/rest/interconnects/{id}/configuration PUT
/rest/interconnects/{id}/pluggableModuleInformation GET
/rest/interconnects/{id}/ports GET
/rest/interconnects/{id}/ports PUT
/rest/interconnects/{id}/ports/{portId:.+} GET
/rest/interconnects/{id}/resetportprotection PUT
/rest/interconnects/{id}/statistics GET
/rest/interconnects/{id}/statistics/{portName:.+} GET
/rest/interconnects/{id}/statistics/{portName:.+}/subport/{subPortNumber} GET
/rest/interconnects/{id}/update-ports PUT
/rest/interconnects/{interconnectsId}/nameServers GET
Interconnect Types
/rest/interconnect-types GET
/rest/interconnect-types/{id} GET
Internal Link Sets
/rest/internal-link-sets GET
/rest/internal-link-sets/{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} DELETE
/rest/logical-enclosures/{id}/configuration PUT
/rest/logical-enclosures/{id}/script GET
/rest/logical-enclosures/{id}/script PUT
/rest/logical-enclosures/{id}/support-dumps POST
/rest/logical-enclosures/{id}/updateFromGroup PUT
Logical Interconnect Groups
/rest/logical-interconnect-groups GET
/rest/logical-interconnect-groups POST
/rest/logical-interconnect-groups/defaultSettings GET
/rest/logical-interconnect-groups/{id} GET
/rest/logical-interconnect-groups/{id} PUT
/rest/logical-interconnect-groups/{id} PATCH
/rest/logical-interconnect-groups/{id} DELETE
/rest/logical-interconnect-groups/{id}/settings GET
Logical Interconnects
/rest/logical-interconnects GET
/rest/logical-interconnects/locations/interconnects POST
/rest/logical-interconnects/locations/interconnects DELETE
/rest/logical-interconnects/{id} GET
/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}/internalVlans GET
/rest/logical-interconnects/{id}/qos-aggregated-configuration GET
/rest/logical-interconnects/{id}/qos-aggregated-configuration PUT
/rest/logical-interconnects/{id}/settings PUT
/rest/logical-interconnects/{id}/snmp-configuration GET
/rest/logical-interconnects/{id}/snmp-configuration PUT
/rest/logical-interconnects/{id}/support-dumps POST ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️
/rest/logical-interconnects/{id}/unassignedPortsForPortMonitor GET
/rest/logical-interconnects/{id}/unassignedUplinkPortsForPortMonitor GET
/rest/logical-interconnects/{id}/configuration PUT
/rest/logical-interconnects/{id}/port-monitor GET
/rest/logical-interconnects/{id}/port-monitor PUT
/rest/logical-interconnects/{id}/telemetry-configurations/{tcId} GET
/rest/logical-interconnects/{id}/telemetry-configurations/{tcId} PUT
/rest/logical-interconnects/compliance POST ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️
/rest/logical-interconnects/{id} PATCH
/rest/logical-interconnects/{id}/igmpSettings GET
/rest/logical-interconnects/{id}/igmpSettings PUT
/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} PATCH
/rest/logical-switch-groups/{id} PUT
/rest/logical-switch-groups/{id} DELETE
Managed SANs
/rest/fc-sans/managed-sans GET
/rest/fc-sans/managed-sans/{id} GET
/rest/fc-sans/managed-sans/{id} PUT
/rest/fc-sans/managed-sans/{id}/endpoints GET
/rest/fc-sans/managed-sans/{id}/endpoints POST
/rest/fc-sans/managed-sans/{id}/issues POST
/rest/fc-sans/managed-sans/WWN+ GET
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}/withoutEthernet GET
/rest/network-sets/{id} PATCH
OS Deployment Plans
/rest/os-deployment-plans/ GET
/rest/os-deployment-plans/{id} GET
Repositories
/rest/repositories GET
/rest/repositories POST
/rest/repositories/{repositoryId} GET
/rest/repositories/{id} PATCH
/rest/repositories/{id} DELETE
Restores
/rest/restores GET
/rest/restores/{id} GET
/rest/restores POST
/rest/restores/failure GET
SAS Interconnect Types
/rest/sas-interconnect-types GET
/rest/sas-interconnect-types/{id} GET
SAS Interconnects
/rest/sas-interconnects GET
/rest/sas-interconnects/{id} GET
/rest/sas-interconnects/{id} PATCH
/rest/sas-interconnects/{id}/refreshState PUT
SAS Logical Interconnect Groups
/rest/sas-logical-interconnect-groups POST
/rest/sas-logical-interconnect-groups GET
/rest/sas-logical-interconnect-groups/{id} GET
/rest/sas-logical-interconnect-groups/{id} PUT
/rest/sas-logical-interconnect-groups/{id} DELETE
SAS Logical Interconnects
/rest/sas-logical-interconnects GET
/rest/sas-logical-interconnects/{id} GET
/rest/sas-logical-interconnects/{id}/firmware GET
/rest/sas-logical-interconnects/{id}/firmware PUT
/rest/sas-logical-interconnects/compliance PUT
/rest/sas-logical-interconnects/{id}/compliance PUT
/rest/sas-logical-interconnects/{lsId}/configuration PUT
/rest/sas-logical-interconnects/{id}/replaceDriveEnclosure POST
Scopes
/rest/scopes GET
/rest/scopes/{id} GET
/rest/scopes POST
/rest/scopes/{id} PUT
/rest/scopes/{id} DELETE
/rest/scopes/{id} PATCH
Server Hardware
/rest/server-hardware GET
/rest/server-hardware POST
/rest/server-hardware/{id} GET
/rest/server-hardware/{id} DELETE
/rest/server-hardware/{id}/bios GET
/rest/server-hardware/{id}/environmentalConfiguration GET
/rest/server-hardware/{id}/environmentalConfiguration PUT
/rest/server-hardware/{id}/iloSsoUrl GET
/rest/server-hardware/{id}/javaRemoteConsoleUrl GET
/rest/server-hardware/{id}/mpFirmwareVersion PUT
/rest/server-hardware/{id}/physicalServerHardware GET
/rest/server-hardware/{id}/powerState PUT
/rest/server-hardware/{id}/refreshState PUT
/rest/server-hardware/{id}/remoteConsoleUrl GET
/rest/server-hardware/{id}/utilization GET
/rest/server-hardware/{id} PATCH
/rest/server-hardware/*/firmware GET
/rest/server-hardware/{id}/firmware GET
/rest/server-hardware/discovery POST
/rest/server-hardware/{id}/localStorageV2 POST
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} PATCH
/rest/server-profile-templates/{id} DELETE
/rest/server-profile-templates/{id}/new-profile GET
/rest/server-profile-templates/{id}/transformation GET
/rest/server-profile-templates/available-networks GET
Server Profiles
/rest/server-profiles GET
/rest/server-profiles POST
/rest/server-profiles DELETE
/rest/server-profiles/available-networks GET
/rest/server-profiles/available-servers GET
/rest/server-profiles/available-storage-system GET
/rest/server-profiles/available-storage-systems GET
/rest/server-profiles/available-targets GET
/rest/server-profiles/profile-ports GET
/rest/server-profiles/{id} GET
/rest/server-profiles/{id} PUT
/rest/server-profiles/{id} DELETE
/rest/server-profiles/{id} PATCH
/rest/server-profiles/{id}/compliance-preview GET
/rest/server-profiles/{id}/new-profile-template GET
/rest/server-profiles/{id}/messages GET
/rest/server-profiles/{id}/transformation GET
Storage Pools
/rest/storage-pools GET
/rest/storage-pools POST
/rest/storage-pools/reachable-storage-pools GET
/rest/storage-pools/{id} GET
/rest/storage-pools/{id} PUT
/rest/storage-pools/{id} DELETE
Storage Systems
/rest/storage-systems GET
/rest/storage-systems POST
/rest/storage-systems/host-types GET
/rest/storage-systems/{arrayId}/storage-pools GET
/rest/storage-systems/{id} GET
/rest/storage-systems/{id} PUT
/rest/storage-systems/{id} DELETE
/rest/storage-systems/{id}/managedPorts GET
/rest/storage-systems/{id}/managedPorts/{portId} GET
/rest/storage-systems/{id}/reachable-ports GET
/rest/storage-systems/{id}/templates GET
Storage Volumes
/rest/storage-volumes GET
/rest/storage-volumes POST
/rest/storage-volumes/attachable-volumes GET
/rest/storage-volumes/from-existing POST
/rest/storage-volumes/from-snapshot POST
/rest/storage-volumes/repair GET
/rest/storage-volumes/repair POST
/rest/storage-volumes/{id} GET
/rest/storage-volumes/{id} PUT
/rest/storage-volumes/{id} DELETE
/rest/storage-volumes/{id}/snapshots GET
/rest/storage-volumes/{id}/snapshots POST
/rest/storage-volumes/{id}/snapshots/{snapshotId} GET
/rest/storage-volumes/{id}/snapshots/{snapshotId} DELETE
Storage Volume Attachments
/rest/storage-volume-attachments GET
/rest/storage-volume-attachments/{id} GET
/rest/storage-volume-attachments/repair GET
/rest/storage-volume-attachments/repair POST
/rest/storage-volume-attachments/{attachmentId}/paths GET
/rest/storage-volume-attachments/{attachmentId)/paths/{id} GET
Storage Volume Templates
/rest/storage-volume-templates GET
/rest/storage-volume-templates POST
/rest/storage-volume-templates/connectable-volume-templates GET
/rest/storage-volume-templates/reachable-volume-templates GET
/rest/storage-volume-templates/{id} GET
/rest/storage-volume-templates/{id} PUT
/rest/storage-volume-templates/{id} DELETE
/rest/storage-volume-templates/{id}/compatible-systems GET
Switch Types
/rest/switch-types GET
/rest/switch-types/{id} GET
Tasks
/rest/tasks GET
/rest/tasks/{id} GET
/rest/tasks/{id} PATCH
Uplink Sets
/rest/uplink-sets GET
/rest/uplink-sets POST
/rest/uplink-sets/{id} GET
/rest/uplink-sets/{id} PUT
/rest/uplink-sets/{id} DELETE
Users
/rest/users GET
/rest/users POST
/rest/users POST {multiple user}
/rest/users PUT
/rest/users/role/{userName} GET
/rest/users/validateLoginName/{userName} POST
/rest/users/validateUserName/{fullName} POST
/rest/users DELETE
/rest/users/administrator/resetPassword PUT ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️
/rest/users/changePassword POST
/rest/users/roles DELETE
/rest/users/roles/users/{role} GET
/rest/users/{userName} GET
/rest/users/{userName} DELETE
/rest/users/{userName}/roles POST
/rest/users/{userName}/roles PUT
Version
/rest/version GET

HPE Synergy Image Streamer

Endpoints Verb V800 V1000 V1020 V1600 V2000 V2010 V2020
Artifact Bundles
/rest/artifact-bundles GET
/rest/artifact-bundles POST {create}
/rest/artifact-bundles POST {upload}
/rest/artifact-bundles/backups GET
/rest/artifact-bundles/backups POST
/rest/artifact-bundles/backups/archive POST
/rest/artifact-bundles/backups/archive/{id} GET
/rest/artifact-bundles/backups/{id} GET
/rest/artifact-bundles/backups/{id} PUT
/rest/artifact-bundles/download/{id} GET
/rest/artifact-bundles/{id} GET
/rest/artifact-bundles/{id} PUT {update}
/rest/artifact-bundles/{id} PUT {extract}
/rest/artifact-bundles/{id} DELETE
/rest/artifact-bundles/{id}/stopArtifactCreate PUT
Deployment Groups
/rest/deployment-groups GET
/rest/deployment-groups/{id} GET
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
/rest/deployment-plans/{id}/usedby GET
/rest/deployment-plans/{id}/osdp GET
Golden Images
/rest/golden-images POST(create)
/rest/golden-images POST(upload)
/rest/golden-images GET
/rest/golden-images/{id} GET
/rest/golden-images/archive/{id} GET
/rest/golden-images/download/{id} GET
/rest/golden-images/{id} PUT
/rest/golden-images/{id} DELETE
OS Build Plan
/rest/build-plans POST
/rest/build-plans GET
/rest/build-plans/{id} GET
/rest/build-plans/{id} PUT
/rest/build-plans/{id} DELETE
OS Volumes
/rest/os-volumes GET
/rest/os-volumes/{id} GET
/rest/os-volumes/archive/{name} GET
/rest/os-volumes/{id}/storage GET
Plan Scripts
/rest/plan-scripts POST
/rest/plan-scripts/differences/{id} POST
/rest/plan-scripts GET
/rest/plan-scripts/{id} GET
/rest/plan-scripts/{id} PUT
/rest/plan-scripts/{id} DELETE
/rest/plan-scripts/{id}/usedby/readonly GET