A newer release of this product is available.
GetAPI
Contributors
Suggest changes
PDFs
You can use the GetAPI method to get a list of all the API methods and supported API endpoints that can be used in the system.
Parameters
This method has no input parameters.
Return values
This method has the following return values:
| Name | Description | Type |
|---|---|---|
<version> |
A list of all supported API methods for this software version, where <version> is the current software version this system is running. |
string array |
currentVersion |
The current version of the storage cluster software. |
string |
supportedVersions |
A list of all API endpoints supported by the system. |
string array |
Request example
Requests for this method are similar to the following example:
{
"method": "GetAPI",
"params": {},
"id" : 1
}
Response example
This method returns a response similar to the following example:
{
"id": 1,
"result": {
"12.0": [
"AbortSnapMirrorRelationship",
"AddAccount",
"AddClusterAdmin",
"AddDrives",
"AddIdpClusterAdmin",
"AddInitiatorsToVolumeAccessGroup",
"AddKeyServerToProviderKmip",
"AddLdapClusterAdmin",
"AddNodes",
"AddVirtualNetwork",
"AddVolumesToVolumeAccessGroup",
"BreakSnapMirrorRelationship",
"BreakSnapMirrorVolume",
"CancelClone",
"CancelGroupClone",
"CheckPingOnVlan",
"CheckProposedCluster",
"CheckProposedNodeAdditions",
"ClearClusterFaults",
"CloneMultipleVolumes",
"CloneVolume",
"CompleteClusterPairing",
"CompleteVolumePairing",
"CopyVolume",
"CreateBackupTarget",
"CreateClusterInterfacePreference",
"CreateClusterSupportBundle",
"CreateGroupSnapshot",
"CreateIdpConfiguration",
"CreateInitiators",
"CreateKeyProviderKmip",
"CreateKeyServerKmip",
"CreatePublicPrivateKeyPair",
"CreateQoSPolicy",
"CreateSchedule",
"CreateSnapMirrorEndpoint",
"CreateSnapMirrorEndpointUnmanaged",
"CreateSnapMirrorRelationship",
"CreateSnapMirrorVolume",
"CreateSnapshot",
"CreateStorageContainer",
"CreateSupportBundle",
"CreateVolume",
"CreateVolumeAccessGroup",
"DeleteAllSupportBundles",
"DeleteAuthSession",
"DeleteAuthSessionsByClusterAdmin",
"DeleteAuthSessionsByUsername",
"DeleteClusterInterfacePreference",
"DeleteGroupSnapshot",
"DeleteIdpConfiguration",
"DeleteInitiators",
"DeleteKeyProviderKmip",
"DeleteKeyServerKmip",
"DeleteQoSPolicy",
"DeleteSnapMirrorEndpoints",
"DeleteSnapMirrorRelationships",
"DeleteSnapshot",
"DeleteStorageContainers",
"DeleteVolume",
"DeleteVolumeAccessGroup",
"DeleteVolumes",
"DisableAutoip",
"DisableBmcColdReset",
"DisableClusterSsh",
"DisableEncryptionAtRest",
"DisableIdpAuthentication",
"DisableLdapAuthentication",
"DisableSnmp",
"EnableAutoip",
"EnableBmcColdReset",
"EnableClusterSsh",
"EnableEncryptionAtRest",
"EnableFeature",
"EnableIdpAuthentication",
"EnableLdapAuthentication",
"EnableSnmp",
"GetAccountByID",
"GetAccountByName",
"GetAccountEfficiency",
"GetActiveTlsCiphers",
"GetAsyncResult",
"GetBackupTarget",
"GetBinAssignmentProperties",
"GetClientCertificateSignRequest",
"GetClusterCapacity",
"GetClusterConfig",
"GetClusterFullThreshold",
"GetClusterHardwareInfo",
"GetClusterInfo",
"GetClusterInterfacePreference",
"GetClusterMasterNodeID",
"GetClusterSshInfo",
"GetClusterState",
"GetClusterStats",
"GetClusterStructure",
"GetClusterVersionInfo",
"GetCompleteStats",
"GetConfig",
"GetCurrentClusterAdmin",
"GetDefaultQoS",
"GetDriveHardwareInfo",
"GetDriveStats",
"GetFeatureStatus",
"GetFipsReport",
"GetHardwareConfig",
"GetHardwareInfo",
"GetIdpAuthenticationState",
"GetIpmiConfig",
"GetIpmiInfo",
"GetKeyProviderKmip",
"GetKeyServerKmip",
"GetLdapConfiguration",
"GetLimits",
"GetLldpInfo",
"GetLoginBanner",
"GetLoginSessionInfo",
"GetNetworkConfig",
"GetNetworkInterface",
"GetNodeFipsDrivesReport",
"GetNodeHardwareInfo",
"GetNodeStats",
"GetNtpInfo",
"GetNvramInfo",
"GetOntapVersionInfo",
"GetOrigin",
"GetPendingOperation",
"GetProtectionDomainLayout",
"GetQoSPolicy",
"GetRawStats",
"GetRemoteLoggingHosts",
"GetSSLCertificate",
"GetSchedule",
"GetSnapMirrorClusterIdentity",
"GetSnmpACL",
"GetSnmpInfo",
"GetSnmpState",
"GetSnmpTrapInfo",
"GetStorageContainerEfficiency",
"GetSupportedTlsCiphers",
"GetSystemStatus",
"GetVirtualVolumeCount",
"GetVolumeAccessGroupEfficiency",
"GetVolumeAccessGroupLunAssignments",
"GetVolumeCount",
"GetVolumeEfficiency",
"GetVolumeStats",
"InitializeSnapMirrorRelationship",
"ListAccounts",
"ListActiveAuthSessions",
"ListActiveNodes",
"ListActivePairedVolumes",
"ListActiveVolumes",
"ListAllNodes",
"ListAsyncResults",
"ListAuthSessionsByClusterAdmin",
"ListAuthSessionsByUsername",
"ListBackupTargets",
"ListBulkVolumeJobs",
"ListClusterAdmins",
"ListClusterFaults",
"ListClusterInterfacePreferences",
"ListClusterPairs",
"ListDeletedVolumes",
"ListDriveHardware",
"ListDriveStats",
"ListDrives",
"ListEvents",
"ListFibreChannelPortInfo",
"ListFibreChannelSessions",
"ListGroupSnapshots",
"ListISCSISessions",
"ListIdpConfigurations",
"ListInitiators",
"ListKeyProvidersKmip",
"ListKeyServersKmip",
"ListNetworkInterfaces",
"ListNodeFibreChannelPortInfo",
"ListNodeStats",
"ListPendingActiveNodes",
"ListPendingNodes",
"ListProtectionDomainLevels",
"ListProtocolEndpoints",
"ListQoSPolicies",
"ListSchedules",
"ListServices",
"ListSnapMirrorAggregates",
"ListSnapMirrorEndpoints",
"ListSnapMirrorLuns",
"ListSnapMirrorNetworkInterfaces",
"ListSnapMirrorNodes",
"ListSnapMirrorPolicies",
"ListSnapMirrorRelationships",
"ListSnapMirrorSchedules",
"ListSnapMirrorVolumes",
"ListSnapMirrorVservers",
"ListSnapshots",
"ListStorageContainers",
"ListSyncJobs",
"ListTests",
"ListUtilities",
"ListVirtualNetworks",
"ListVirtualVolumeBindings",
"ListVirtualVolumeHosts",
"ListVirtualVolumeTasks",
"ListVirtualVolumes",
"ListVolumeAccessGroups",
"ListVolumeStats",
"ListVolumeStatsByAccount",
"ListVolumeStatsByVirtualVolume",
"ListVolumeStatsByVolume",
"ListVolumeStatsByVolumeAccessGroup",
"ListVolumes",
"ListVolumesForAccount",
"ModifyAccount",
"ModifyBackupTarget",
"ModifyClusterAdmin",
"ModifyClusterFullThreshold",
"ModifyClusterInterfacePreference",
"ModifyGroupSnapshot",
"ModifyInitiators",
"ModifyKeyServerKmip",
"ModifyQoSPolicy",
"ModifySchedule",
"ModifySnapMirrorEndpoint",
"ModifySnapMirrorEndpointUnmanaged",
"ModifySnapMirrorRelationship",
"ModifySnapshot",
"ModifyStorageContainer",
"ModifyVirtualNetwork",
"ModifyVolume",
"ModifyVolumeAccessGroup",
"ModifyVolumeAccessGroupLunAssignments",
"ModifyVolumePair",
"ModifyVolumes",
"PurgeDeletedVolume",
"PurgeDeletedVolumes",
"QuiesceSnapMirrorRelationship",
"RemoveAccount",
"RemoveBackupTarget",
"RemoveClusterAdmin",
"RemoveClusterPair",
"RemoveDrives",
"RemoveInitiatorsFromVolumeAccessGroup",
"RemoveKeyServerFromProviderKmip",
"RemoveNodes",
"RemoveSSLCertificate",
"RemoveVirtualNetwork",
"RemoveVolumePair",
"RemoveVolumesFromVolumeAccessGroup",
"ResetDrives",
"ResetNetworkConfig",
"ResetNode",
"ResetSupplementalTlsCiphers",
"RestartNetworking",
"RestartServices",
"RestoreDeletedVolume",
"ResumeSnapMirrorRelationship",
"ResyncSnapMirrorRelationship",
"RollbackToGroupSnapshot",
"RollbackToSnapshot",
"SecureEraseDrives",
"SetClusterConfig",
"SetClusterStructure",
"SetConfig",
"SetDefaultQoS",
"SetLoginBanner",
"SetLoginSessionInfo",
"SetNetworkConfig",
"SetNtpInfo",
"SetProtectionDomainLayout",
"SetRemoteLoggingHosts",
"SetSSLCertificate",
"SetSnmpACL",
"SetSnmpInfo",
"SetSnmpTrapInfo",
"SetSupplementalTlsCiphers",
"Shutdown",
"SnmpSendTestTraps",
"StartBulkVolumeRead",
"StartBulkVolumeWrite",
"StartClusterPairing",
"StartVolumePairing",
"TestAddressAvailability",
"TestConnectEnsemble",
"TestConnectMvip",
"TestConnectSvip",
"TestDrives",
"TestHardwareConfig",
"TestKeyProviderKmip",
"TestKeyServerKmip",
"TestLdapAuthentication",
"TestLocalConnectivity",
"TestLocateCluster",
"TestNetworkConfig",
"TestPing",
"TestRemoteConnectivity",
"UpdateBulkVolumeStatus",
"UpdateIdpConfiguration",
"UpdateSnapMirrorRelationship"
],
"currentVersion": "12.0",
"supportedVersions": [
"1.0",
"2.0",
"3.0",
"4.0",
"5.0",
"5.1",
"6.0",
"7.0",
"7.1",
"7.2",
"7.3",
"7.4",
"8.0",
"8.1",
"8.2",
"8.3",
"8.4",
"8.5",
"8.6",
"8.7",
"9.0",
"9.1",
"9.2",
"9.3",
"9.4",
"9.5",
"9.6",
"10.0",
"10.1",
"10.2",
"10.3",
"10.4",
"10.5",
"10.6",
"10.7",
"11.0",
"11.1",
"11.3",
"11.5",
"11.7",
"11.8",
"12.0"
]
}
}