Skip to content

README.md

Latest commit

 

History

History
886 lines (858 loc) · 89.2 KB

README.md

File metadata and controls

886 lines (858 loc) · 89.2 KB
Raw

Go API client for gopureclient

OpenAPI specification for FlashBlade REST API, developed by Everpure, Inc. (https://www.everpuredata.com/).

Overview

This API client was generated by the OpenAPI Generator project.

  • API version: 2.15
  • Package version: FB_2_15

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get github.com/stretchr/testify/require
go get golang.org/x/crypto
go get golang.org/x/sys
go get github.com/golang-jwt/jwt/v5

Put the package under your project folder and add the following in import:

import gopureclient "github.com/PureStorage-OpenConnect/go-pure-client/flashblade/FB_2_15"

Configuration

To build configuration use configuration builder.

An example for OAuth authentication where user is pureuser, issuer is go-test, key id is 123e4567-e89b-12d3-a456-426614174000, client id is 123e4567-e89b-12d3-a456-426614174000, privateKeyBytes contains RSA private key protected by password pwd123:

configuration, err := openapiclient.NewConfigurationBuilder("[ARRAY_URL]").
	OAuth("pureuser", "go-test", "123e4567-e89b-12d3-a456-426614174000", "123e4567-e89b-12d3-a456-426614174000", "pwd123", privateKeyBytes).
	DisableSSLVerification().
	Build()

An example for API token authentication:

configuration, err := openapiclient.NewConfigurationBuilder("[ARRAY_URL]").
	APIToken(apiToken).
	DisableSSLVerification().
	Build()

An example for anonymous authentication:

configuration, err := openapiclient.NewConfigurationBuilder("[ARRAY_URL]").
	DisableSSLVerification().
	Build()

Builder methods:

Method Description
UserAgent Sets custom user agent
DisableSSLVerification Disables verification of certificate chain
DebugMode Enables debug mode
HTTPClient Sets custom HTTPClient
Timeout Sets request timeout of the default HTTP client
OAuthWithRawTokenID Sets OAuth authentication with raw ID token
OAuth Sets OAuth authentication with private key
APIToken Sets API token authentication

By default requests time out after 90 seconds, including reading the response body. Use Timeout to change this, or Timeout(0) to disable it. When you bring your own client via HTTPClient, set the timeout on that client instead; combining it with Timeout is rejected by Build, as is DisableSSLVerification.

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
APIClientsAPI ApiClientsDelete Delete /api/2.15/api-clients DELETE api-clients
APIClientsAPI ApiClientsGet Get /api/2.15/api-clients GET api-clients
APIClientsAPI ApiClientsPatch Patch /api/2.15/api-clients PATCH api-clients
APIClientsAPI ApiClientsPost Post /api/2.15/api-clients POST api-clients
ActiveDirectoryAPI ActiveDirectoryDelete Delete /api/2.15/active-directory DELETE active-directory
ActiveDirectoryAPI ActiveDirectoryGet Get /api/2.15/active-directory GET active-directory
ActiveDirectoryAPI ActiveDirectoryPatch Patch /api/2.15/active-directory PATCH active-directory
ActiveDirectoryAPI ActiveDirectoryPost Post /api/2.15/active-directory POST active-directory
ActiveDirectoryAPI ActiveDirectoryTestGet Get /api/2.15/active-directory/test GET active-directory/test
AdministratorsAPI AdminsAPITokensDelete Delete /api/2.15/admins/api-tokens DELETE admins/api-tokens
AdministratorsAPI AdminsAPITokensGet Get /api/2.15/admins/api-tokens GET admins/api-tokens
AdministratorsAPI AdminsAPITokensPost Post /api/2.15/admins/api-tokens POST admins/api-tokens
AdministratorsAPI AdminsCacheDelete Delete /api/2.15/admins/cache DELETE admins/cache
AdministratorsAPI AdminsCacheGet Get /api/2.15/admins/cache GET admins/cache
AdministratorsAPI AdminsDelete Delete /api/2.15/admins DELETE admins
AdministratorsAPI AdminsGet Get /api/2.15/admins GET admins
AdministratorsAPI AdminsPatch Patch /api/2.15/admins PATCH admins
AdministratorsAPI AdminsPost Post /api/2.15/admins POST admins
AdministratorsAPI AdminsSettingsGet Get /api/2.15/admins/settings List global admin settings
AdministratorsAPI AdminsSettingsPatch Patch /api/2.15/admins/settings Update global admin settings
AlertWatchersAPI AlertWatchersDelete Delete /api/2.15/alert-watchers DELETE alert-watchers
AlertWatchersAPI AlertWatchersGet Get /api/2.15/alert-watchers GET alert-watchers
AlertWatchersAPI AlertWatchersPatch Patch /api/2.15/alert-watchers PATCH alert-watchers
AlertWatchersAPI AlertWatchersPost Post /api/2.15/alert-watchers POST alert-watchers
AlertWatchersAPI AlertWatchersTestGet Get /api/2.15/alert-watchers/test GET alert-watchers/test
AlertsAPI AlertsGet Get /api/2.15/alerts GET alerts
AlertsAPI AlertsPatch Patch /api/2.15/alerts PATCH alerts
ArrayConnectionsAPI ArrayConnectionsConnectionKeyGet Get /api/2.15/array-connections/connection-key GET array-connections/connection-key
ArrayConnectionsAPI ArrayConnectionsConnectionKeyPost Post /api/2.15/array-connections/connection-key POST array-connections/connection-key
ArrayConnectionsAPI ArrayConnectionsDelete Delete /api/2.15/array-connections DELETE array-connections
ArrayConnectionsAPI ArrayConnectionsGet Get /api/2.15/array-connections GET array-connections
ArrayConnectionsAPI ArrayConnectionsPatch Patch /api/2.15/array-connections PATCH array-connections
ArrayConnectionsAPI ArrayConnectionsPathGet Get /api/2.15/array-connections/path GET array-connections/path
ArrayConnectionsAPI ArrayConnectionsPerformanceReplicationGet Get /api/2.15/array-connections/performance/replication GET array-connections/performance/replication
ArrayConnectionsAPI ArrayConnectionsPost Post /api/2.15/array-connections POST array-connections
ArraysAPI ArraysEulaGet Get /api/2.15/arrays/eula GET arrays/eula
ArraysAPI ArraysEulaPatch Patch /api/2.15/arrays/eula PATCH arrays/eula
ArraysAPI ArraysFactoryResetTokenDelete Delete /api/2.15/arrays/factory-reset-token Delete a factory reset token
ArraysAPI ArraysFactoryResetTokenGet Get /api/2.15/arrays/factory-reset-token List factory reset tokens
ArraysAPI ArraysFactoryResetTokenPost Post /api/2.15/arrays/factory-reset-token Create a factory reset token
ArraysAPI ArraysGet Get /api/2.15/arrays GET arrays
ArraysAPI ArraysHttpSpecificPerformanceGet Get /api/2.15/arrays/http-specific-performance GET arrays/http-specific-performance
ArraysAPI ArraysNfsSpecificPerformanceGet Get /api/2.15/arrays/nfs-specific-performance GET arrays/nfs-specific-performance
ArraysAPI ArraysPatch Patch /api/2.15/arrays PATCH arrays
ArraysAPI ArraysPerformanceGet Get /api/2.15/arrays/performance GET arrays/performance
ArraysAPI ArraysPerformanceReplicationGet Get /api/2.15/arrays/performance/replication GET arrays/performance/replication
ArraysAPI ArraysS3SpecificPerformanceGet Get /api/2.15/arrays/s3-specific-performance GET arrays/s3-specific-performance
ArraysAPI ArraysSpaceGet Get /api/2.15/arrays/space GET arrays/space
ArraysAPI ArraysSupportedTimeZonesGet Get /api/2.15/arrays/supported-time-zones GET arrays/supported-time-zones
AuditsAPI AuditsGet Get /api/2.15/audits GET audits
AuthorizationAPI ApiAPIVersionGet Get /api/api_version GET api_version
AuthorizationAPI ApiLoginBannerGet Get /api/login-banner GET login_banner
AuthorizationAPI ApiLoginPost Post /api/login POST login
AuthorizationAPI ApiLogoutPost Post /api/logout POST logout
AuthorizationAPI Oauth210TokenPost Post /oauth2/1.0/token Get access token
BladesAPI BladesGet Get /api/2.15/blades GET blades
BucketReplicaLinksAPI BucketReplicaLinksDelete Delete /api/2.15/bucket-replica-links DELETE bucket-replica-links
BucketReplicaLinksAPI BucketReplicaLinksGet Get /api/2.15/bucket-replica-links GET bucket-replica-links
BucketReplicaLinksAPI BucketReplicaLinksPatch Patch /api/2.15/bucket-replica-links PATCH bucket-replica-links
BucketReplicaLinksAPI BucketReplicaLinksPost Post /api/2.15/bucket-replica-links POST bucket-replica-links
BucketsAPI BucketsBucketAccessPoliciesDelete Delete /api/2.15/buckets/bucket-access-policies DELETE buckets/bucket-access-policies
BucketsAPI BucketsBucketAccessPoliciesGet Get /api/2.15/buckets/bucket-access-policies GET buckets/bucket-access-policies
BucketsAPI BucketsBucketAccessPoliciesPost Post /api/2.15/buckets/bucket-access-policies POST buckets/bucket-access-policies
BucketsAPI BucketsBucketAccessPoliciesRulesDelete Delete /api/2.15/buckets/bucket-access-policies/rules DELETE buckets/bucket-access-policies/rules
BucketsAPI BucketsBucketAccessPoliciesRulesGet Get /api/2.15/buckets/bucket-access-policies/rules GET buckets/bucket-access-policies/rules
BucketsAPI BucketsBucketAccessPoliciesRulesPost Post /api/2.15/buckets/bucket-access-policies/rules POST buckets/bucket-access-policies/rules
BucketsAPI BucketsCrossOriginResourceSharingPoliciesDelete Delete /api/2.15/buckets/cross-origin-resource-sharing-policies DELETE buckets/cross-origin-resource-sharing-policies
BucketsAPI BucketsCrossOriginResourceSharingPoliciesGet Get /api/2.15/buckets/cross-origin-resource-sharing-policies GET buckets/cross-origin-resource-sharing-policies
BucketsAPI BucketsCrossOriginResourceSharingPoliciesPost Post /api/2.15/buckets/cross-origin-resource-sharing-policies POST buckets/cross-origin-resource-sharing-policies
BucketsAPI BucketsCrossOriginResourceSharingPoliciesRulesDelete Delete /api/2.15/buckets/cross-origin-resource-sharing-policies/rules DELETE buckets/cross-origin-resource-sharing-policies/rules
BucketsAPI BucketsCrossOriginResourceSharingPoliciesRulesGet Get /api/2.15/buckets/cross-origin-resource-sharing-policies/rules GET buckets/cross-origin-resource-sharing-policies/rules
BucketsAPI BucketsCrossOriginResourceSharingPoliciesRulesPost Post /api/2.15/buckets/cross-origin-resource-sharing-policies/rules POST buckets/cross-origin-resource-sharing-policies/rules
BucketsAPI BucketsDelete Delete /api/2.15/buckets DELETE buckets
BucketsAPI BucketsGet Get /api/2.15/buckets GET buckets
BucketsAPI BucketsPatch Patch /api/2.15/buckets PATCH buckets
BucketsAPI BucketsPerformanceGet Get /api/2.15/buckets/performance GET buckets/performance
BucketsAPI BucketsPost Post /api/2.15/buckets POST buckets
BucketsAPI BucketsS3SpecificPerformanceGet Get /api/2.15/buckets/s3-specific-performance GET buckets/s3-specific-performance
CertificateGroupsAPI CertificateGroupsCertificatesDelete Delete /api/2.15/certificate-groups/certificates DELETE certificate-groups/certificates
CertificateGroupsAPI CertificateGroupsCertificatesGet Get /api/2.15/certificate-groups/certificates GET certificate-groups/certificates
CertificateGroupsAPI CertificateGroupsCertificatesPost Post /api/2.15/certificate-groups/certificates POST certificate-groups/certificates
CertificateGroupsAPI CertificateGroupsDelete Delete /api/2.15/certificate-groups DELETE certificate-groups
CertificateGroupsAPI CertificateGroupsGet Get /api/2.15/certificate-groups GET certificate-groups
CertificateGroupsAPI CertificateGroupsPost Post /api/2.15/certificate-groups POST certificate-groups
CertificateGroupsAPI CertificateGroupsUsesGet Get /api/2.15/certificate-groups/uses GET certificate-groups/uses
CertificatesAPI CertificatesCertificateGroupsDelete Delete /api/2.15/certificates/certificate-groups DELETE certificates/certificate-groups
CertificatesAPI CertificatesCertificateGroupsGet Get /api/2.15/certificates/certificate-groups GET certificates/certificate-groups
CertificatesAPI CertificatesCertificateGroupsPost Post /api/2.15/certificates/certificate-groups POST certificates/certificate-groups
CertificatesAPI CertificatesDelete Delete /api/2.15/certificates DELETE certificates
CertificatesAPI CertificatesGet Get /api/2.15/certificates GET certificates
CertificatesAPI CertificatesPatch Patch /api/2.15/certificates PATCH certificates
CertificatesAPI CertificatesPost Post /api/2.15/certificates POST certificates
CertificatesAPI CertificatesUsesGet Get /api/2.15/certificates/uses GET certificates/uses
ClientsAPI ArraysClientsPerformanceGet Get /api/2.15/arrays/clients/performance GET clients-performance
DNSAPI DnsGet Get /api/2.15/dns GET dns
DNSAPI DnsPatch Patch /api/2.15/dns PATCH dns
DirectoryServicesAPI DirectoryServicesGet Get /api/2.15/directory-services GET directory-services
DirectoryServicesAPI DirectoryServicesPatch Patch /api/2.15/directory-services PATCH directory-services
DirectoryServicesAPI DirectoryServicesRolesDelete Delete /api/2.15/directory-services/roles DELETE directory-service/roles
DirectoryServicesAPI DirectoryServicesRolesGet Get /api/2.15/directory-services/roles GET directory-service/roles
DirectoryServicesAPI DirectoryServicesRolesPatch Patch /api/2.15/directory-services/roles PATCH directory-service/roles
DirectoryServicesAPI DirectoryServicesRolesPost Post /api/2.15/directory-services/roles POST directory-service/roles
DirectoryServicesAPI DirectoryServicesTestGet Get /api/2.15/directory-services/test GET directory-services/test
DirectoryServicesAPI DirectoryServicesTestPatch Patch /api/2.15/directory-services/test PATCH directory-service/test
DrivesAPI DrivesGet Get /api/2.15/drives GET drives
FileSystemReplicaLinksAPI FileSystemReplicaLinksDelete Delete /api/2.15/file-system-replica-links DELETE file-system-replica-links
FileSystemReplicaLinksAPI FileSystemReplicaLinksGet Get /api/2.15/file-system-replica-links GET file-system-replica-links
FileSystemReplicaLinksAPI FileSystemReplicaLinksPoliciesDelete Delete /api/2.15/file-system-replica-links/policies DELETE file-system-replica-links/policies
FileSystemReplicaLinksAPI FileSystemReplicaLinksPoliciesGet Get /api/2.15/file-system-replica-links/policies GET file-system-replica-links/policies
FileSystemReplicaLinksAPI FileSystemReplicaLinksPoliciesPost Post /api/2.15/file-system-replica-links/policies POST file-system-replica-links/policies
FileSystemReplicaLinksAPI FileSystemReplicaLinksPost Post /api/2.15/file-system-replica-links POST file-system-replica-links
FileSystemReplicaLinksAPI FileSystemReplicaLinksTransferGet Get /api/2.15/file-system-replica-links/transfer GET file-system-replica-links/transfer
FileSystemSnapshotsAPI FileSystemSnapshotsDelete Delete /api/2.15/file-system-snapshots DELETE file-system-snapshots
FileSystemSnapshotsAPI FileSystemSnapshotsGet Get /api/2.15/file-system-snapshots GET file-system-snapshots
FileSystemSnapshotsAPI FileSystemSnapshotsPatch Patch /api/2.15/file-system-snapshots PATCH file-system-snapshots
FileSystemSnapshotsAPI FileSystemSnapshotsPoliciesDelete Delete /api/2.15/file-system-snapshots/policies DELETE file-system-snapshots/policies
FileSystemSnapshotsAPI FileSystemSnapshotsPoliciesGet Get /api/2.15/file-system-snapshots/policies GET file-system-snapshots/policies
FileSystemSnapshotsAPI FileSystemSnapshotsPost Post /api/2.15/file-system-snapshots POST file-system-snapshots
FileSystemSnapshotsAPI FileSystemSnapshotsTransferDelete Delete /api/2.15/file-system-snapshots/transfer DELETE file-system-snapshots/transfer
FileSystemSnapshotsAPI FileSystemSnapshotsTransferGet Get /api/2.15/file-system-snapshots/transfer GET file-system-snapshots/transfer
FileSystemsAPI FileSystemsAuditPoliciesDelete Delete /api/2.15/file-systems/audit-policies DELETE file-systems/audit-policies
FileSystemsAPI FileSystemsAuditPoliciesGet Get /api/2.15/file-systems/audit-policies GET file-systems/audit-policies
FileSystemsAPI FileSystemsAuditPoliciesPost Post /api/2.15/file-systems/audit-policies POST file-systems/audit-policies
FileSystemsAPI FileSystemsDelete Delete /api/2.15/file-systems DELETE file-systems
FileSystemsAPI FileSystemsGet Get /api/2.15/file-systems GET file-systems
FileSystemsAPI FileSystemsGroupsPerformanceGet Get /api/2.15/file-systems/groups/performance GET file-systems/groups/performance
FileSystemsAPI FileSystemsLocksClientsGet Get /api/2.15/file-systems/locks/clients Get a list of clients that hold active file locks
FileSystemsAPI FileSystemsLocksDelete Delete /api/2.15/file-systems/locks Invalidate file locks
FileSystemsAPI FileSystemsLocksGet Get /api/2.15/file-systems/locks Get a list of active file locks
FileSystemsAPI FileSystemsLocksNlmReclamationsPost Post /api/2.15/file-systems/locks/nlm-reclamations Initiate NLM reclamation.
FileSystemsAPI FileSystemsPatch Patch /api/2.15/file-systems PATCH file-systems
FileSystemsAPI FileSystemsPerformanceGet Get /api/2.15/file-systems/performance GET file-systems/performance
FileSystemsAPI FileSystemsPoliciesAllGet Get /api/2.15/file-systems/policies-all GET file-systems/policies-all
FileSystemsAPI FileSystemsPoliciesDelete Delete /api/2.15/file-systems/policies DELETE file-systems/policies
FileSystemsAPI FileSystemsPoliciesGet Get /api/2.15/file-systems/policies GET file-systems/policies
FileSystemsAPI FileSystemsPoliciesPost Post /api/2.15/file-systems/policies POST file-systems/policies
FileSystemsAPI FileSystemsPost Post /api/2.15/file-systems POST file-systems
FileSystemsAPI FileSystemsSessionsDelete Delete /api/2.15/file-systems/sessions Delete sessions
FileSystemsAPI FileSystemsSessionsGet Get /api/2.15/file-systems/sessions Get a list of active sessions
FileSystemsAPI FileSystemsUsersPerformanceGet Get /api/2.15/file-systems/users/performance GET file-systems/users/performance
FileSystemsAPI FileSystemsWormDataPoliciesGet Get /api/2.15/file-systems/worm-data-policies GET file-systems/worm-data-policies
HardwareAPI HardwareGet Get /api/2.15/hardware GET hardware
HardwareAPI HardwarePatch Patch /api/2.15/hardware PATCH hardware
HardwareConnectorsAPI HardwareConnectorsGet Get /api/2.15/hardware-connectors GET hardware-connectors
HardwareConnectorsAPI HardwareConnectorsPatch Patch /api/2.15/hardware-connectors PATCH hardware-connectors
HardwareConnectorsAPI HardwareConnectorsPerformanceGet Get /api/2.15/hardware-connectors/performance GET hardware-connectors/performance
KMIPAPI KmipDelete Delete /api/2.15/kmip Delete a KMIP server configuration
KMIPAPI KmipGet Get /api/2.15/kmip List KMIP server configurations
KMIPAPI KmipPatch Patch /api/2.15/kmip Modify a KMIP server configuration
KMIPAPI KmipPost Post /api/2.15/kmip Create a KMIP server configuration
KMIPAPI KmipTestGet Get /api/2.15/kmip/test Displays KMIP server test results
KeytabsAPI KeytabsDelete Delete /api/2.15/keytabs DELETE keytabs
KeytabsAPI KeytabsDownloadGet Get /api/2.15/keytabs/download GET keytabs/download
KeytabsAPI KeytabsGet Get /api/2.15/keytabs GET keytabs
KeytabsAPI KeytabsPost Post /api/2.15/keytabs POST keytabs
KeytabsAPI KeytabsUploadPost Post /api/2.15/keytabs/upload POST keytabs/upload
LifecycleRulesAPI LifecycleRulesDelete Delete /api/2.15/lifecycle-rules DELETE lifecycle-rules
LifecycleRulesAPI LifecycleRulesGet Get /api/2.15/lifecycle-rules GET lifecycle-rules
LifecycleRulesAPI LifecycleRulesPatch Patch /api/2.15/lifecycle-rules PATCH lifecycle-rules
LifecycleRulesAPI LifecycleRulesPost Post /api/2.15/lifecycle-rules POST lifecycle-rules
LinkAggregationGroupsAPI LinkAggregationGroupsDelete Delete /api/2.15/link-aggregation-groups DELETE link-aggregation-groups
LinkAggregationGroupsAPI LinkAggregationGroupsGet Get /api/2.15/link-aggregation-groups GET link-aggregation-groups
LinkAggregationGroupsAPI LinkAggregationGroupsPatch Patch /api/2.15/link-aggregation-groups PATCH link-aggregation-groups
LinkAggregationGroupsAPI LinkAggregationGroupsPost Post /api/2.15/link-aggregation-groups POST link-aggregation-groups
LogsAPI LogsAsyncDownloadGet Get /api/2.15/logs-async/download GET logs-async/download
LogsAPI LogsAsyncGet Get /api/2.15/logs-async GET logs-async
LogsAPI LogsAsyncPatch Patch /api/2.15/logs-async PATCH logs-async
LogsAPI LogsGet Get /api/2.15/logs GET logs
NetworkInterfacesAPI NetworkInterfacesDelete Delete /api/2.15/network-interfaces DELETE network-interfaces
NetworkInterfacesAPI NetworkInterfacesGet Get /api/2.15/network-interfaces GET network-interfaces
NetworkInterfacesAPI NetworkInterfacesPatch Patch /api/2.15/network-interfaces PATCH network-interfaces
NetworkInterfacesAPI NetworkInterfacesPingGet Get /api/2.15/network-interfaces/ping GET network-interfaces/ping
NetworkInterfacesAPI NetworkInterfacesPost Post /api/2.15/network-interfaces POST network-interfaces
NetworkInterfacesAPI NetworkInterfacesTraceGet Get /api/2.15/network-interfaces/trace GET network-interfaces/trace
ObjectStoreAccessKeysAPI ObjectStoreAccessKeysDelete Delete /api/2.15/object-store-access-keys DELETE object-store-access-keys
ObjectStoreAccessKeysAPI ObjectStoreAccessKeysGet Get /api/2.15/object-store-access-keys GET object-store-access-keys
ObjectStoreAccessKeysAPI ObjectStoreAccessKeysPatch Patch /api/2.15/object-store-access-keys PATCH object-store-access-keys
ObjectStoreAccessKeysAPI ObjectStoreAccessKeysPost Post /api/2.15/object-store-access-keys POST object-store-access-keys
ObjectStoreAccountsAPI ObjectStoreAccountsDelete Delete /api/2.15/object-store-accounts DELETE object-store-accounts
ObjectStoreAccountsAPI ObjectStoreAccountsGet Get /api/2.15/object-store-accounts GET object-store-accounts
ObjectStoreAccountsAPI ObjectStoreAccountsPatch Patch /api/2.15/object-store-accounts PATCH object-store-accounts
ObjectStoreAccountsAPI ObjectStoreAccountsPost Post /api/2.15/object-store-accounts POST object-store-accounts
ObjectStoreRemoteCredentialsAPI ObjectStoreRemoteCredentialsDelete Delete /api/2.15/object-store-remote-credentials DELETE object-store-remote-credentials
ObjectStoreRemoteCredentialsAPI ObjectStoreRemoteCredentialsGet Get /api/2.15/object-store-remote-credentials GET object-store-remote-credentials
ObjectStoreRemoteCredentialsAPI ObjectStoreRemoteCredentialsPatch Patch /api/2.15/object-store-remote-credentials PATCH object-store-remote-credentials
ObjectStoreRemoteCredentialsAPI ObjectStoreRemoteCredentialsPost Post /api/2.15/object-store-remote-credentials POST object-store-remote-credentials
ObjectStoreUsersAPI ObjectStoreUsersDelete Delete /api/2.15/object-store-users DELETE object-store-users
ObjectStoreUsersAPI ObjectStoreUsersGet Get /api/2.15/object-store-users GET object-store-users
ObjectStoreUsersAPI ObjectStoreUsersObjectStoreAccessPoliciesDelete Delete /api/2.15/object-store-users/object-store-access-policies DELETE object-store-users/object-store-access-policies
ObjectStoreUsersAPI ObjectStoreUsersObjectStoreAccessPoliciesGet Get /api/2.15/object-store-users/object-store-access-policies GET object-store-users/object-store-access-policies
ObjectStoreUsersAPI ObjectStoreUsersObjectStoreAccessPoliciesPost Post /api/2.15/object-store-users/object-store-access-policies POST object-store-users/object-store-access-policies
ObjectStoreUsersAPI ObjectStoreUsersPost Post /api/2.15/object-store-users POST object-store-users
ObjectStoreVirtualHostsAPI ObjectStoreVirtualHostsDelete Delete /api/2.15/object-store-virtual-hosts DELETE object-store-virtual-hosts
ObjectStoreVirtualHostsAPI ObjectStoreVirtualHostsGet Get /api/2.15/object-store-virtual-hosts GET object-store-virtual-hosts
ObjectStoreVirtualHostsAPI ObjectStoreVirtualHostsPost Post /api/2.15/object-store-virtual-hosts POST object-store-virtual-hosts
PoliciesAllAPI PoliciesAllGet Get /api/2.15/policies-all GET policies-all
PoliciesAllAPI PoliciesAllMembersGet Get /api/2.15/policies-all/members GET policies-all/members
PoliciesAuditForFileSystemsAPI AuditFileSystemsPoliciesDelete Delete /api/2.15/audit-file-systems-policies DELETE audit-file-systems-policies
PoliciesAuditForFileSystemsAPI AuditFileSystemsPoliciesGet Get /api/2.15/audit-file-systems-policies GET audit-file-systems-policies
PoliciesAuditForFileSystemsAPI AuditFileSystemsPoliciesMembersDelete Delete /api/2.15/audit-file-systems-policies/members DELETE audit-file-systems-policies/members
PoliciesAuditForFileSystemsAPI AuditFileSystemsPoliciesMembersGet Get /api/2.15/audit-file-systems-policies/members GET audit-file-systems-policies/members
PoliciesAuditForFileSystemsAPI AuditFileSystemsPoliciesMembersPost Post /api/2.15/audit-file-systems-policies/members POST audit-file-systems-policies/members
PoliciesAuditForFileSystemsAPI AuditFileSystemsPoliciesPatch Patch /api/2.15/audit-file-systems-policies PATCH audit-file-systems-policies
PoliciesAuditForFileSystemsAPI AuditFileSystemsPoliciesPost Post /api/2.15/audit-file-systems-policies POST audit-file-systems-policies
PoliciesNFSAPI NfsExportPoliciesDelete Delete /api/2.15/nfs-export-policies DELETE nfs-export-policies
PoliciesNFSAPI NfsExportPoliciesGet Get /api/2.15/nfs-export-policies GET nfs-export-policies
PoliciesNFSAPI NfsExportPoliciesPatch Patch /api/2.15/nfs-export-policies PATCH nfs-export-policies
PoliciesNFSAPI NfsExportPoliciesPost Post /api/2.15/nfs-export-policies POST nfs-export-policies
PoliciesNFSAPI NfsExportPoliciesRulesDelete Delete /api/2.15/nfs-export-policies/rules DELETE nfs-export-policies/rules
PoliciesNFSAPI NfsExportPoliciesRulesGet Get /api/2.15/nfs-export-policies/rules GET nfs-export-policies/rules
PoliciesNFSAPI NfsExportPoliciesRulesPatch Patch /api/2.15/nfs-export-policies/rules PATCH nfs-export-policies/rules
PoliciesNFSAPI NfsExportPoliciesRulesPost Post /api/2.15/nfs-export-policies/rules POST nfs-export-policies/rules
PoliciesNetworkAccessAPI NetworkAccessPoliciesGet Get /api/2.15/network-access-policies GET network-access-policies
PoliciesNetworkAccessAPI NetworkAccessPoliciesMembersGet Get /api/2.15/network-access-policies/members GET network-access-policies/members
PoliciesNetworkAccessAPI NetworkAccessPoliciesPatch Patch /api/2.15/network-access-policies PATCH network-access-policies
PoliciesNetworkAccessAPI NetworkAccessPoliciesRulesDelete Delete /api/2.15/network-access-policies/rules DELETE network-access-policies/rules
PoliciesNetworkAccessAPI NetworkAccessPoliciesRulesGet Get /api/2.15/network-access-policies/rules GET network-access-policies/rules
PoliciesNetworkAccessAPI NetworkAccessPoliciesRulesPatch Patch /api/2.15/network-access-policies/rules PATCH network-access-policies/rules
PoliciesNetworkAccessAPI NetworkAccessPoliciesRulesPost Post /api/2.15/network-access-policies/rules POST network-access-policies/rules
PoliciesObjectStoreAccessAPI ObjectStoreAccessPoliciesDelete Delete /api/2.15/object-store-access-policies DELETE object-store-access-policies
PoliciesObjectStoreAccessAPI ObjectStoreAccessPoliciesGet Get /api/2.15/object-store-access-policies GET object-store-access-policies
PoliciesObjectStoreAccessAPI ObjectStoreAccessPoliciesObjectStoreUsersDelete Delete /api/2.15/object-store-access-policies/object-store-users DELETE object-store-access-policies/object-store-users
PoliciesObjectStoreAccessAPI ObjectStoreAccessPoliciesObjectStoreUsersGet Get /api/2.15/object-store-access-policies/object-store-users GET object-store-access-policies/object-store-users
PoliciesObjectStoreAccessAPI ObjectStoreAccessPoliciesObjectStoreUsersPost Post /api/2.15/object-store-access-policies/object-store-users POST object-store-access-policies/object-store-users
PoliciesObjectStoreAccessAPI ObjectStoreAccessPoliciesPatch Patch /api/2.15/object-store-access-policies PATCH object-store-access-policies
PoliciesObjectStoreAccessAPI ObjectStoreAccessPoliciesPost Post /api/2.15/object-store-access-policies POST object-store-access-policies
PoliciesObjectStoreAccessAPI ObjectStoreAccessPoliciesRulesDelete Delete /api/2.15/object-store-access-policies/rules DELETE object-store-access-policies-rules
PoliciesObjectStoreAccessAPI ObjectStoreAccessPoliciesRulesGet Get /api/2.15/object-store-access-policies/rules GET object-store-access-policies-rules
PoliciesObjectStoreAccessAPI ObjectStoreAccessPoliciesRulesPatch Patch /api/2.15/object-store-access-policies/rules PATCH object-store-access-policies-rules
PoliciesObjectStoreAccessAPI ObjectStoreAccessPoliciesRulesPost Post /api/2.15/object-store-access-policies/rules POST object-store-access-policies-rules
PoliciesObjectStoreAccessAPI ObjectStoreAccessPolicyActionsGet Get /api/2.15/object-store-access-policy-actions GET object-store-access-policy-actions
PoliciesSMBClientAPI SmbClientPoliciesDelete Delete /api/2.15/smb-client-policies DELETE smb-client-policies
PoliciesSMBClientAPI SmbClientPoliciesGet Get /api/2.15/smb-client-policies GET smb-client-policies
PoliciesSMBClientAPI SmbClientPoliciesPatch Patch /api/2.15/smb-client-policies PATCH smb-client-policies
PoliciesSMBClientAPI SmbClientPoliciesPost Post /api/2.15/smb-client-policies POST smb-client-policies
PoliciesSMBClientAPI SmbClientPoliciesRulesDelete Delete /api/2.15/smb-client-policies/rules DELETE smb-client-policies/rules
PoliciesSMBClientAPI SmbClientPoliciesRulesGet Get /api/2.15/smb-client-policies/rules GET smb-client-policies/rules
PoliciesSMBClientAPI SmbClientPoliciesRulesPatch Patch /api/2.15/smb-client-policies/rules PATCH smb-client-policies/rules
PoliciesSMBClientAPI SmbClientPoliciesRulesPost Post /api/2.15/smb-client-policies/rules POST smb-client-policies/rules
PoliciesSMBShareAPI SmbSharePoliciesDelete Delete /api/2.15/smb-share-policies DELETE smb-share-policies
PoliciesSMBShareAPI SmbSharePoliciesGet Get /api/2.15/smb-share-policies GET smb-share-policies
PoliciesSMBShareAPI SmbSharePoliciesPatch Patch /api/2.15/smb-share-policies PATCH smb-share-policies
PoliciesSMBShareAPI SmbSharePoliciesPost Post /api/2.15/smb-share-policies POST smb-share-policies
PoliciesSMBShareAPI SmbSharePoliciesRulesDelete Delete /api/2.15/smb-share-policies/rules DELETE smb-share-policies/rules
PoliciesSMBShareAPI SmbSharePoliciesRulesGet Get /api/2.15/smb-share-policies/rules GET smb-share-policies/rules
PoliciesSMBShareAPI SmbSharePoliciesRulesPatch Patch /api/2.15/smb-share-policies/rules PATCH smb-share-policies/rules
PoliciesSMBShareAPI SmbSharePoliciesRulesPost Post /api/2.15/smb-share-policies/rules POST smb-share-policies/rules
PoliciesSSHCertificateAuthorityAPI AdminsSshCertificateAuthorityPoliciesDelete Delete /api/2.15/admins/ssh-certificate-authority-policies DELETE admins/ssh-certificate-authority-policies
PoliciesSSHCertificateAuthorityAPI AdminsSshCertificateAuthorityPoliciesGet Get /api/2.15/admins/ssh-certificate-authority-policies GET admins/ssh-certificate-authority-policies
PoliciesSSHCertificateAuthorityAPI AdminsSshCertificateAuthorityPoliciesPost Post /api/2.15/admins/ssh-certificate-authority-policies POST admins/ssh-certificate-authority-policies
PoliciesSSHCertificateAuthorityAPI ArraysSshCertificateAuthorityPoliciesDelete Delete /api/2.15/arrays/ssh-certificate-authority-policies DELETE admins/settings/ssh-certificate-authority-policies
PoliciesSSHCertificateAuthorityAPI ArraysSshCertificateAuthorityPoliciesGet Get /api/2.15/arrays/ssh-certificate-authority-policies GET admins/settings/ssh-certificate-authority-policies
PoliciesSSHCertificateAuthorityAPI ArraysSshCertificateAuthorityPoliciesPost Post /api/2.15/arrays/ssh-certificate-authority-policies POST admins/settings/ssh-certificate-authority-policies
PoliciesSSHCertificateAuthorityAPI SshCertificateAuthorityPoliciesAdminsDelete Delete /api/2.15/ssh-certificate-authority-policies/admins DELETE ssh-certificate-authority-policies/admins
PoliciesSSHCertificateAuthorityAPI SshCertificateAuthorityPoliciesAdminsGet Get /api/2.15/ssh-certificate-authority-policies/admins GET ssh-certificate-authority-policies/admins
PoliciesSSHCertificateAuthorityAPI SshCertificateAuthorityPoliciesAdminsPost Post /api/2.15/ssh-certificate-authority-policies/admins POST ssh-certificate-authority-policies/admins
PoliciesSSHCertificateAuthorityAPI SshCertificateAuthorityPoliciesArraysDelete Delete /api/2.15/ssh-certificate-authority-policies/arrays DELETE ssh-certificate-authority-policies/arrays
PoliciesSSHCertificateAuthorityAPI SshCertificateAuthorityPoliciesArraysGet Get /api/2.15/ssh-certificate-authority-policies/arrays GET ssh-certificate-authority-policies/arrays
PoliciesSSHCertificateAuthorityAPI SshCertificateAuthorityPoliciesArraysPost Post /api/2.15/ssh-certificate-authority-policies/arrays POST ssh-certificate-authority-policies/arrays
PoliciesSSHCertificateAuthorityAPI SshCertificateAuthorityPoliciesDelete Delete /api/2.15/ssh-certificate-authority-policies Delete SSH Certificate Authority configurations
PoliciesSSHCertificateAuthorityAPI SshCertificateAuthorityPoliciesGet Get /api/2.15/ssh-certificate-authority-policies List SSH Certificate Authority configurations
PoliciesSSHCertificateAuthorityAPI SshCertificateAuthorityPoliciesMembersGet Get /api/2.15/ssh-certificate-authority-policies/members GET ssh-certificate-authority-policies/members
PoliciesSSHCertificateAuthorityAPI SshCertificateAuthorityPoliciesPatch Patch /api/2.15/ssh-certificate-authority-policies Modify SSH Certificate Authority configurations
PoliciesSSHCertificateAuthorityAPI SshCertificateAuthorityPoliciesPost Post /api/2.15/ssh-certificate-authority-policies Create SSH Certificate Authority configurations
PoliciesSnapshotAPI PoliciesDelete Delete /api/2.15/policies DELETE policies
PoliciesSnapshotAPI PoliciesFileSystemReplicaLinksDelete Delete /api/2.15/policies/file-system-replica-links DELETE policies/file-system-replica-links
PoliciesSnapshotAPI PoliciesFileSystemReplicaLinksGet Get /api/2.15/policies/file-system-replica-links GET policies/file-system-replica-links
PoliciesSnapshotAPI PoliciesFileSystemReplicaLinksPost Post /api/2.15/policies/file-system-replica-links POST policies/file-system-replica-links
PoliciesSnapshotAPI PoliciesFileSystemSnapshotsDelete Delete /api/2.15/policies/file-system-snapshots DELETE policies/file-system-snapshots
PoliciesSnapshotAPI PoliciesFileSystemSnapshotsGet Get /api/2.15/policies/file-system-snapshots GET policies/file-system-snapshots
PoliciesSnapshotAPI PoliciesFileSystemsDelete Delete /api/2.15/policies/file-systems DELETE policies/file-systems
PoliciesSnapshotAPI PoliciesFileSystemsGet Get /api/2.15/policies/file-systems GET policies/file-systems
PoliciesSnapshotAPI PoliciesFileSystemsPost Post /api/2.15/policies/file-systems POST policies/file-systems
PoliciesSnapshotAPI PoliciesGet Get /api/2.15/policies GET policies
PoliciesSnapshotAPI PoliciesMembersGet Get /api/2.15/policies/members GET policies/members
PoliciesSnapshotAPI PoliciesPatch Patch /api/2.15/policies PATCH policies
PoliciesSnapshotAPI PoliciesPost Post /api/2.15/policies POST policies
PoliciesWORMDataAPI WormDataPoliciesDelete Delete /api/2.15/worm-data-policies DELETE worm-data-policies
PoliciesWORMDataAPI WormDataPoliciesGet Get /api/2.15/worm-data-policies GET worm-data-policies
PoliciesWORMDataAPI WormDataPoliciesMembersGet Get /api/2.15/worm-data-policies/members GET worm-data-policies/members
PoliciesWORMDataAPI WormDataPoliciesPatch Patch /api/2.15/worm-data-policies PATCH worm-data-policies
PoliciesWORMDataAPI WormDataPoliciesPost Post /api/2.15/worm-data-policies POST worm-data-policies
PublicKeysAPI PublicKeysDelete Delete /api/2.15/public-keys Delete public key configurations
PublicKeysAPI PublicKeysGet Get /api/2.15/public-keys List public key configurations
PublicKeysAPI PublicKeysPost Post /api/2.15/public-keys Create public key configurations
PublicKeysAPI PublicKeysUsesGet Get /api/2.15/public-keys/uses GET public-keys/uses
QuotasAPI QuotasGroupsDelete Delete /api/2.15/quotas/groups DELETE quotas/groups
QuotasAPI QuotasGroupsGet Get /api/2.15/quotas/groups GET quotas/groups
QuotasAPI QuotasGroupsPatch Patch /api/2.15/quotas/groups PATCH quotas/groups
QuotasAPI QuotasGroupsPost Post /api/2.15/quotas/groups POST quotas/groups
QuotasAPI QuotasSettingsGet Get /api/2.15/quotas/settings GET quotas-settings
QuotasAPI QuotasSettingsPatch Patch /api/2.15/quotas/settings PATCH quotas-settings
QuotasAPI QuotasUsersDelete Delete /api/2.15/quotas/users DELETE quotas/users
QuotasAPI QuotasUsersGet Get /api/2.15/quotas/users GET quotas/users
QuotasAPI QuotasUsersPatch Patch /api/2.15/quotas/users PATCH quotas/users
QuotasAPI QuotasUsersPost Post /api/2.15/quotas/users POST quotas/users
RDLAPI RapidDataLockingGet Get /api/2.15/rapid-data-locking Get the status of the Rapid Data Locking feature.
RDLAPI RapidDataLockingPatch Patch /api/2.15/rapid-data-locking Modifies the Rapid Data Locking feature.
RDLAPI RapidDataLockingRotatePost Post /api/2.15/rapid-data-locking/rotate Rotates the external keys on the associated EKM appliance.
RDLAPI RapidDataLockingTestGet Get /api/2.15/rapid-data-locking/test Displays Rapid Data Locking test results.
RolesAPI RolesGet Get /api/2.15/roles GET roles
SAML2SSOAPI SsoSaml2IdpsDelete Delete /api/2.15/sso/saml2/idps Delete SAML2 SSO configurations
SAML2SSOAPI SsoSaml2IdpsGet Get /api/2.15/sso/saml2/idps List SAML2 SSO configurations
SAML2SSOAPI SsoSaml2IdpsPatch Patch /api/2.15/sso/saml2/idps Modify SAML2 SSO configurations
SAML2SSOAPI SsoSaml2IdpsPost Post /api/2.15/sso/saml2/idps Create SAML2 SSO configurations
SMTPAPI SmtpServersGet Get /api/2.15/smtp-servers GET smtp-servers
SMTPAPI SmtpServersPatch Patch /api/2.15/smtp-servers PATCH smtp-servers
SNMPAgentsAPI SnmpAgentsGet Get /api/2.15/snmp-agents GET snmp-agents
SNMPAgentsAPI SnmpAgentsMibGet Get /api/2.15/snmp-agents/mib GET snmp-agents-mib
SNMPAgentsAPI SnmpAgentsPatch Patch /api/2.15/snmp-agents PATCH snmp-agents
SNMPManagersAPI SnmpManagersDelete Delete /api/2.15/snmp-managers DELETE snmp-managers
SNMPManagersAPI SnmpManagersGet Get /api/2.15/snmp-managers GET snmp-managers
SNMPManagersAPI SnmpManagersPatch Patch /api/2.15/snmp-managers PATCH snmp-managers
SNMPManagersAPI SnmpManagersPost Post /api/2.15/snmp-managers POST snmp-managers
SNMPManagersAPI SnmpManagersTestGet Get /api/2.15/snmp-managers/test GET snmp-managers/test
SessionsAPI SessionsGet Get /api/2.15/sessions List session data
SubnetsAPI SubnetsDelete Delete /api/2.15/subnets DELETE subnets
SubnetsAPI SubnetsGet Get /api/2.15/subnets GET subnets
SubnetsAPI SubnetsPatch Patch /api/2.15/subnets PATCH subnets
SubnetsAPI SubnetsPost Post /api/2.15/subnets POST subnets
SupportAPI SupportGet Get /api/2.15/support GET support
SupportAPI SupportPatch Patch /api/2.15/support PATCH support
SupportAPI SupportTestGet Get /api/2.15/support/test GET support-test
SyslogAPI SyslogServersDelete Delete /api/2.15/syslog-servers DELETE syslog-servers
SyslogAPI SyslogServersGet Get /api/2.15/syslog-servers GET syslog-servers
SyslogAPI SyslogServersPatch Patch /api/2.15/syslog-servers PATCH syslog-servers
SyslogAPI SyslogServersPost Post /api/2.15/syslog-servers POST syslog-servers
SyslogAPI SyslogServersSettingsGet Get /api/2.15/syslog-servers/settings GET syslog-servers/settings
SyslogAPI SyslogServersSettingsPatch Patch /api/2.15/syslog-servers/settings PATCH syslog-servers/settings
SyslogAPI SyslogServersTestGet Get /api/2.15/syslog-servers/test GET syslog-servers/test
TargetsAPI TargetsDelete Delete /api/2.15/targets DELETE targets
TargetsAPI TargetsGet Get /api/2.15/targets GET targets
TargetsAPI TargetsPatch Patch /api/2.15/targets PATCH targets
TargetsAPI TargetsPerformanceReplicationGet Get /api/2.15/targets/performance/replication GET targets/performance/replication
TargetsAPI TargetsPost Post /api/2.15/targets POST targets
UsageAPI UsageGroupsGet Get /api/2.15/usage/groups GET usage/groups
UsageAPI UsageUsersGet Get /api/2.15/usage/users GET usage/users
VerificationKeysAPI SupportVerificationKeysGet Get /api/2.15/support/verification-keys GET verification-keys
VerificationKeysAPI SupportVerificationKeysPatch Patch /api/2.15/support/verification-keys PATCH verification-keys

Documentation For Models

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

  • PtrBool
  • PtrInt
  • PtrInt32
  • PtrInt64
  • PtrFloat
  • PtrFloat32
  • PtrFloat64
  • PtrString
  • PtrTime