How the REST APIs work

Cloud Manager includes REST APIs that enable software developers to automate the management of Cloud Volumes ONTAP. You should understand how the APIs work before you get started.

API resources

The Cloud Manager APIs enable you to perform operations on different types of resources. The resources are broadly categorized as follows:

  • Administrative resources
    Used to set up and configure Cloud Manager

  • Auditing resources
    Used to view details about Cloud Manager operations

  • Authentication resources
    Used to authenticate with Cloud Manager so you can run API operations

  • Working environment resources
    Used to deploy and manage working environments: single Cloud Volumes ONTAP systems, Cloud Volumes ONTAP HA configurations, and ONTAP clusters

API endpoint

Cloud Manager API URLs are relative to http://ip_address:port/occm/api.

For example, the request URL to a launch Cloud Volumes ONTAP in AWS is http://ip_address:port/occm/api/vsa/working-environments.

API request and response formats

The REST API issues calls through HTTP requests and responses. The HTTP message body carries data objects in readable strings, in the default JSON (JavaScript Object Notation) format.

Responses can be a JSON object, or an array of JSON objects.

The format of a JSON object is as follows:

{
    name: "string"
}

The format of an array of JSON objects is as follows:

[
    {name: "string"}, {name: "string"}
]

Header fields

You must specify the Content-Type field in the header for each API call. The Accept field is optional. Both fields must be set to application/json for most API calls:

Accept: application/json
Content-Type: application/json
The server automatically returns content in JSON format if Accept is not specified.

The API reference identifies when Content-Type and Accept must be set to different values. For example, for backup API calls, Content-Type must be set to multiport/form-data and for restore API calls, Accept must be set to application/octet-stream.

Each API returns a custom HTTP header field named OnCloud-Request-Id. You can use the value of this field to track the progress of requests using the audit API calls.

Public IDs

All Cloud Manager resources (for example, users and working environments) are assigned a public ID. Whenever a resource is created or returned, the public ID is displayed in the response. You must specify a resource’s public ID when performing operations on the resource. For example, you must specify the public ID for a working environment when you create a volume.

HTTP status codes

HTTP code Description

200

The operation was completed successfully and the API sent a response.

202

The operation was accepted and is currently in process. Cloud Manager returns this code when the API operation returns before the actual operation finishes. For example, the /vsa/working-environments operation returns with code 202, but the Cloud Volumes ONTAP instance successfully launches up to 25 minutes later.

204

The operation was completed successfully and the API did not send a response.

400

There was an error with the client’s request. An error response explains the reason.

401

The user has not authenticated.

403

The user has authenticated but does not have permissions to perform the operation on the resource.

409

The operation failed because another operation is already in progress.

420

Cloud Manager has not been set up. You must set up Cloud Manager using the API call /occm/setup/init

5xx

An error occurred with the Cloud Manager server.

URI scheme

Host: localhost

BasePath: /occm/api

Schemes: HTTP

Authentication with NetApp Cloud Central

Most API operations require an authentication header that specifies a token. The token identifies the client/caller.

Before you can get the token, you need to obtain the domain and client IDs from Cloud Manager. You can obtain the IDs by calling the support-services API.

After you obtain the IDs, you can then invoke Cloud Manager’s authentication API to get the token.

The following example first obtains the domain and client IDs and then invokes the authentication API:

curl -X GET http://localhost/occm/api/occm/system/support-services |jq -r .portalService.auth0Information > info.txt

clientId=`cat info.txt|jq -r .clientId`
domain=`cat info.txt|jq -r .domain`
audience=`cat info.txt|jq -r .audience`
curl  https://$domain/oauth/token -X POST --header "Content-Type:application/json" --data "{\"grant_type\": \"password\",\"username\": \"$email\",\"password\": \"$password\",\"audience\": \"$audience\",\"scope\": \"profile\",\"client_id\": \"$clientId\"}" | jq -r .access_token > token.txt

token+=`cat token.txt`
This new authentication method was introduced in Cloud Manager 3.5. Previous versions of Cloud Manager used a cookie for authentication. That login method is still supported, but we recommend using this new authentication method.

Accessing the API reference and running operations using Swagger

Cloud Manager provides interactive API documentation through the Swagger interface. You can use Swagger to find descriptions of the APIs and to run the operations.

Steps

  1. Click the link in the lower-right corner of the console, or enter the URL http://server/occm/api-doc in your web browser.

    screenshot apis
  2. Expand the operations for the API calls to view the API descriptions.

    Example

    The following image shows an API description:

    screenshot swagger descriptions
  3. If desired, run the operations directly from Swagger by entering values for the parameters and then clicking Try it out!

API examples

Reviewing API examples can help you understand how to use the Cloud Manager APIs yourself.

The examples use curl as the HTTP client. Some examples show API calls for single Cloud Volumes ONTAP systems and others show API calls for Cloud Volumes ONTAP HA configurations.

Getting started

Adding an AWS account to Cloud Manager

You need to add one or more cloud provider accounts to Cloud Manager so you can specify the AWS account in which you want to deploy Cloud Volumes ONTAP.

curl -X POST http://localhost/occm/api/accounts/aws --header "Authorization: $token" --header "Content-Type: application/json" --data "{\"accountName\": \"AWSAdminKeys\", \"providerKeys\": {\"awsAccessKeys\": {\"accessKey\": \"$accessKey\",\"secretKey\":\"$secretKey\"}}}"

Adding an Azure account to Cloud Manager

You need to add one or more cloud provider accounts to Cloud Manager so you can specify the Azure account in which you want to deploy Cloud Volumes ONTAP.

curl -X POST http://localhost/occm/api/accounts/azure --header "Authorization: $token" --header "Content-Type: application/json" --data "{\"accountName\": \"AzureAdminKeys\", \"providerKeys\": {\"tenantId\": \"$azureTenantId\",\"applicationId\": \"$azureApplicationId\",\"applicationKey\": \"$azureApplicationKey\"}}"

Adding a GCP account to Cloud Manager

If you want to enable data tiering on a Cloud Volumes ONTAP system, you need to provide Cloud Manager with a storage access key for a Google Cloud Platform account. Cloud Manager uses the access keys to set up and manage a Cloud Storage bucket for data tiering.

curl -X POST http://localhost/occm/api/accounts/gcp  --header "Authorization: $token" --header "Content-Type: application/json" --data "{\"accountName\": \"GcpAdminKeys\", \"providerKeys\": {\"accessKey\": \"$accessKey\", \"secretKey\":\"$secretKey\"}}"

Obtaining your cloud provider account ID

When you create a working environment, you must provide the ID of a cloud provider account.

curl -X GET http://localhost/occm/api/accounts --header "Authorization: $token"  |jq -r '.azureAccounts[0]'.publicId > temp.txt
azureAccountId=`cat temp.txt`
curl -X GET http://localhost/occm/api/accounts --header "Authorization: $token"  |jq -r '.awsAccounts[0]'.publicId > temp.txt
awsAccountId=`cat temp.txt`
curl -X GET http://localhost/occm/api/accounts --header "Authorization: $token"  |jq -r '.gcpAccounts[0]'.publicId > temp.txt
gcpAccountId=`cat temp.txt`

Adding a NetApp Support Site account to Cloud Manager

Adding your NetApp Support Site account to Cloud Manager is required to deploy a BYOL system. It’s also required to register pay-as-you-go systems and to upgrade ONTAP software.

curl http://localhost/occm/api/accounts/nss  -X POST  --header 'Content-Type: application/json' --header "Authorization: $token" --data "{\"accountName\": \"accountNameTest\",\"providerKeys\": { \"nssUserName\": \"1\", \"nssPassword\": \"1\"},\"vsaList\": [\"$azureId\"]}"

Creating systems in AWS

Preparing to launch Cloud Volumes ONTAP in AWS

When you launch Cloud Volumes ONTAP, you must specify valid values for license type, AWS region, Cloud Volumes ONTAP version, and instance type. You can obtain valid values for your version of Cloud Manager by using the following API call:

curl http://localhost/occm/api/vsa/metadata/manifests -X
GET --header "Content-Type:application/json" --header "Authorization:$token"

Note the following about the response for this API:

  • For licenses, the type field displays valid values for the licenseType parameter.

  • For regions, the code field displays valid values for the region parameter.

  • For Cloud Volumes ONTAP versions, the valid values for the ontapVersion parameter display underneath the version of Cloud Manager that you are running.

  • For instance types, the valid values for the instanceType parameter display underneath each license type.

You must also identify the target VPC and subnet before you can launch Cloud Volumes ONTAP. The following API call provides the target VPC ID and subnet ID in a specific region:

curl "http://localhost/occm/api/vsa/metadata/vpcs?region=$region&cloudProviderAccountId=$awsAccountId" -X GET --header "Content-Type:application/json" --header "Authorization:$token" | jq .

Launching a single Cloud Volumes ONTAP instance in AWS

The following operation launches Cloud Volumes ONTAP in AWS:

curl http://localhost/occm/api/vsa/working-environments -X POST --header "Authorization:$token" --header "Content-Type:application/json" --data "{\"name\":\"kuki\",\"tenantId\":\"$tenantId\",\"region\":\"$region\",\"subnetId\":\"$subnetId\",\"ebsVolumeType\":\"gp2\",\"ebsVolumeSize\": {\"size\": 500, \"unit\": \"GB\"},\"dataEncryptionType\":\"NONE\",\"ontapEncryptionParameters\":null,\"svmPassword\":\"$svmPassword\",\"vpcId\":\"$vpcId\",\"cloudProviderAccount\": \"$awsAccountId\",\"vsaMetadata\":{\"platformSerialNumber\":null,\"ontapVersion\":\"ONTAP.ENG-9.4.T1\",\"licenseType\":\"cot-standard-paygo\",\"instanceType\":\"m4.2xlarge\"},\"writingSpeedState\":\"NORMAL\"}"
The preceding example does not specify a license or a volume.

To monitor the creation of the instance, you can use the following API call:

curl http://localhost/occm/api/vsa/working-environments -X GET --header "Content-Type:application/json" --header "Authorization:$token" | jq -r .[0].publicId > vsaId.txt
weid=`cat vsaId.txt`

After the Cloud Volumes ONTAP instance is up and running, you can use the following API call to get details about the instance:

curl "http://localhost/occm/api/vsa/working-environments?fields=status,svmName,awsProperties,reservedSize,encryptionProperties,ontapProperties,actionsRequired,cronJobSchedules,snapshotPolicies,svms,activeActions,interClusterLifs,capacityFeatures,replicationProperties&tenantId=%tenantId%" -X GET --header "Content-Type:application/json" --header "Authorization:$token"

A sample response follows:

{"id":"VsaWorkingEnvironment-UU72AEtE","status":"ON",
"lifs":[{"ip":"4.4.4.4","netmask":"mgmt","lifType":"Node Management",
"dataProtocols":[]},{"ip":"10.20.1.2","netmask":"data","lifType":
"Node Management","dataProtocols":[]},{"ip":"10.20.1.1","netmask":
"data","lifType":"Cluster Management","dataProtocols":[]},
{"ip":"10.20.1.6","netmask":"data","lifType":"Intercluster",
"dataProtocols":[]},{"ip":"10.20.1.4","netmask":"data","lifType":
"Data","dataProtocols":["iscsi"]},{"ip":"10.20.1.5","netmask":
"data","lifType":"Data","dataProtocols":["nfs","cifs"]},
{"ip":"10.20.1.7","netmask":"mgmt","lifType":"SVM Management",
"dataProtocols":[]}],
"serialNumber":"serial-vsa1",
"systemId":"system-id-vsa1",
"clusterName":"vsa1",
"ontapVersion":"ONTAP-9.4.T1",
"accountId":"account123",
"productCode":"",
"amiId":"ami-7731c31c",
"systemManagerUrl":"https://10.20.1.1/sysmgr/SysMgr.html",
"creationTime":1388527200000,
"instanceId":"i-1",
"platformLicense":"",
"licenseExpiryDate":0,
"instanceType":"m4.2xlarge",
"publicIp":null,
"publicDnsName":null,
"activeActions":null,
"licenseType":{"name":"ONTAP Cloud Standard",
"capacityLimit":{"size":10.0,"unit":"TB"}},
"vsaEncryptionResponse":{"awsVolumeEncryption":false,"keyManagers":[],
"ontapEncryption":false,
"ontapEncryptionCertificates":[]}}

You should make note of the working environment ID because you must specify it when performing subsequent operations on the working environment.

Creating an aggregate for a single node Cloud Volumes ONTAP system in AWS

Use the following API call to create a new aggregate on a Cloud Volumes ONTAP system:

curl http://localhost/occm/api/vsa/aggregates -X POST --header "Content-Type:application/json" header "Authorization:$token" --data "{\"name\": \"aggr33\",\"workingEnvironmentId\": \"%weid%\", \"numberOfDisks\": \"2\", \"diskSize\": {\"size\": \"500\", \"unit\": \"GB\"}, \"providerVolumeType\": \"gp2\"}"

After Cloud Manager creates the aggregate, you can use the following API call to get details about it:

curl http://localhost/occm/api/vsa/aggregates?workingEnvironmentId=%weid% -X GET --header "Content-Type:application/json" --header "Authorization:$token"

Creating a volume on a single Cloud Volumes ONTAP system in AWS

The first API call in the following example gets the Storage Virtual Machine (SVM) name to specify when creating the volume. The second API call gets the required number of disks and the aggregate name in which to create the volume. The third API call creates a new volume on a Cloud Volumes ONTAP system using the public ID of the working environment, which was returned after Cloud Manager created the working environment.

If aggregateName and maxNumOfDisksApprovedToAdd are not specified, then the response fails with a suggested aggregate name and the number of disks that Cloud Manager needs to create to fulfill the request.
curl "http://localhost/occm/api/vsa/working-environments/%weid%?fields=svmName" -X GET --header "Content-Type:application/json" --header "Authorization:$token" | jq -r .svmName > svm.txt
svm=`cat svm.txt`
curl http://localhost/occm/api/vsa/volumes/quote -X POST --header "Content-Type:application/json" header "Authorization:$token" --data "{\"workingEnvironmentId\": \"%weid%\",\"svmName\": \"%svm%\",\"aggregateName\": \"aggr33\", \"name\": \"newVol\", \"size\": {\"size\": \"100\", \"unit\": \"GB\"}, \"enableThinProvisioning\": \"true\", \"providerVolumeType\": \"gp2\"}" > quote.txt
cat quote.txt| jq -r .numOfDisks >disks.txt
cat quote.txt| jq -r .aggregateName >aggrName.txt
disks=`cat disks.txt`
aggrName=`cat aggrName.txt`
curl http://localhost/occm/api/vsa/volumes -X POST --header "Content-Type:application/json" header "Authorization:$token" --data "{\"name\":\"newVol\",\"workingEnvironmentId\":\"%weid%\",\"svmName\":\"%svm%\",\"exportPolicyInfo\":{\"policyType\":\"custom\",\"ips\":[\"0.0.0.0\/0\"]},\"snapshotPolicyName\":\"default\",\"size\":{\"size\":\"100\",\"unit\":\"GB\"},\"enableThinProvisioning\":\"true\",\"enableDeduplication\":\"true\",\"enableCompression\":\"false\",\"maxNumOfDisksApprovedToAdd\":\"%disks%\",\"aggregateName\":\"%aggrName%\",\"providerVolumeType\":\"gp2\"}"

Creating a volume on an aggregate that uses Provisioned IOPS SSDs

In this example, the first API call obtains the required number of disks and the aggregate name for the volume. The second call creates the volume. Note that the first API call might not return the aggregateName parameter. If that happens, Cloud Manager chooses the best matching aggregate (if one exists) or it creates a new aggregate that meets the requirements.

curl http://localhost/occm/api/vsa/volumes/quote -X POST --header "Content-Type:application/json" --header "Authorization:$token" --data "{\"workingEnvironmentId\":\"%weid%\",\"svmName\":\"%svm%\", \"name\":\"newVol1\",\"iops\":500,\"providerVolumeType\":\"io1\",\"verifyNameUniqueness\":true,\"size\":{\"size\":100,\"unit\":\"GB\"},\"enableThinProvisioning\":true,\"enableDeduplication\":true,\"enableCompression\":true}" > quote.txt
cat quote.txt| jq -r .numOfDisks >disks.txt
cat quote.txt| jq -r .aggregateName >aggrName.txt
disks=`cat disks.txt`
aggrName=`cat aggrName.txt`
curl http://localhost/occm/api/vsa/volumes?createAggregateIfNotFound=true -X POST --header "Content-Type:application/json" --header "Authorization:$token" --data "{\"workingEnvironmentId\":\"%weid%\", \"svmName\":\"%svm%\", \"exportPolicyInfo\":{\"policyType\":\"custom\", \"ips\":[\"10.30.0.0/16\"],\"_ips\":\"10.30.0.0/16\"},\"snapshotPolicyName\":\"default\",\"name\":\"newVol1\",\"iops\":500,\"providerVolumeType\":\"io1\",\"verifyNameUniqueness\":true,\"size\":{\"size\":100,\"unit\":\"GB\"},\"enableThinProvisioning\":true,\"enableDeduplication\":true,\"enableCompression\":true,\"maxNumOfDisksApprovedToAdd\":\"%disks%\", \"aggregateName\":\"%aggrName%\"}"

Stopping a single Cloud Volumes ONTAP instance in AWS

The following operation stops a Cloud Volumes ONTAP instance in AWS:

curl http://localhost/occm/api/vsa/working-environments/%weid%/stop?take_snapshots=true -X POST --header "Content-Type:application/json" --header "Authorization:$token"

Starting a single Cloud Volumes ONTAP instance in AWS

The following operation starts a Cloud Volumes ONTAP instance in AWS:

curl http://localhost/occm/api/vsa/working-environments/%weid%/start -X POST --header "Content-Type:application/json" --header "Authorization:$token"

Deleting a single Cloud Volumes ONTAP working environment

The following API call deletes a Cloud Volumes ONTAP working environment, which terminates the instance in AWS:

curl http://localhost/occm/api/vsa/working-environments/%weid% -X DELETE --header "Content-Type:application/json" --header "Authorization:$token"

Launching a Cloud Volumes ONTAP HA configuration in multiple AWS Availability Zones

The following API call launches an HA configuration in AWS:

curl http://localhost/occm/api/aws/ha/working-environments -X POST --header "Content-Type:application/json" --header "Authorization:$token" --data "{\"name\": \"Ha1\",\"tenantId\": \"$tenantId\",\"region\": \"$haRegion\",\"vsaMetadata\": {\"ontapVersion\": \"ONTAP.ENG-9.4.T1.ha\",\"licenseType\": \"ha-cot-standard-paygo\",\"instanceType\": \"m4.2xlarge\"},\"svmPassword\": \"$svmPassword\",\"vpcId\": \"$haVpcId\",\"volume\": {\"exportPolicyInfo\": {\"policyType\": \"custom\",\"ips\": [\"10.0.0.0/24\"]},\"snapshotPolicyName\": \"default\",\"name\": \"newVol1\",\"enableThinProvisioning\": true,\"enableDeduplication\": true,\"enableCompression\": true,\"size\": {\"size\": 50,\"unit\": \"GB\"}},\"cloudProviderAccount\": \"$awsAccountId\",\"dataEncryptionType\": \"NONE\",\"ontapEncryptionParameters\": null,\"ebsVolumeType\": \"gp2\",\"ebsVolumeSize\": {\"size\": 1,\"unit\": \"TB\"},\"haParams\": {\"node2SubnetId\": \"$haSubnetId2\",\"failoverMode\":\"FloatingIP\",\"mediatorSubnetId\": \"$haSubnetId3\",\"mediatorKeyPairName\": \"$keyPair\",\"clusterFloatingIP\": \"$floatingIp4\",\"dataFloatingIP\": \"$floatingIp5\",\"dataFloatingIP2\": \"$floatingIp6\",\"node1SubnetId\": \"$haSubnetId1\",\"routeTableIds\": [\"$routeTableId1\"]},\"awsTags\": []}" | jq .

Specifying a proxy for the HA mediator

The following example creates an HA working environment that uses a proxy to provide the mediator instance with outbound internet connectivity.

curl http://localhost/occm/api/aws/ha/working-environments -X POST --header "Content-Type:application/json" --header "Authorization:$token" --data "{\"name\": \"Ha3\",\"tenantId\": \"$tenantId\",\"region\": \"$haRegion\",\"vsaMetadata\": {\"ontapVersion\": \"ONTAP.ENG-9.4.T1.ha\",\"licenseType\": \"ha-cot-standard-paygo\",\"instanceType\": \"m4.2xlarge\"},\"svmPassword\": \"$svmPassword\",\"vpcId\": \"$haVpcId\",\"cloudProviderAccount\": \"$awsAccountId\",\"dataEncryptionType\": \"NONE\",\"ontapEncryptionParameters\": null,\"ebsVolumeType\": \"gp2\",\"ebsVolumeSize\": {\"size\": 1,\"unit\": \"TB\"},\"haParams\": {\"node2SubnetId\": \"$haSubnetId2\",\"failoverMode\":\"FloatingIP\",\"mediatorSubnetId\": \"$haSubnetId3\",\"mediatorKeyPairName\": \"$keyPair\",\"clusterFloatingIP\": \"$floatingIp7\",\"dataFloatingIP\": \"$floatingIp8\",\"dataFloatingIP2\": \"$floatingIp9\",\"node1SubnetId\": \"$haSubnetId1\",\"routeTableIds\": [\"$routeTableId1\"], \"mediatorProxy\": {\"url\": \"http:///0.0.0.0:555\",\"userName\": \"admin\",\"password\":\"admin\"}},\"awsTags\": []}"

Launching an HA configuration in a single AWS Availability Zone

The following API call launches a Cloud Volumes ONTAP HA configuration in a single AZ in AWS, sets up a proxy configuration for the mediator, and uses dedicated EC2 instances:

curl http://localhost/occm/api/aws/ha/working-environments -X POST --header "Content-Type:application/json" --header "Authorization:$token" --data "{\"name\": \"Ha2\",\"tenantId\": \"$tenantId\",\"volume\": {\"exportPolicyInfo\": {\"policyType\": \"custom\",\"ips\": [\"10.20.0.0/16\"]},\"snapshotPolicyName\": \"default\",\"name\": \"newVol1\",\"enableThinProvisioning\": true,\"enableDeduplication\": true,\"enableCompression\": true,\"size\": {\"size\": 50,\"unit\": \"GB\"}},\"region\": \"$haRegion\",\"vsaMetadata\": {\"ontapVersion\": \"ONTAP.ENG-9.4.T1.ha\",\"licenseType\": \"ha-cot-standard-paygo\",\"instanceType\": \"m4.2xlarge\"},\"svmPassword\": \"$svmPassword\",\"vpcId\": \"$haVpcId\",\"cloudProviderAccount\": \"$awsAccountId\",\"dataEncryptionType\": \"AWS\",\"ontapEncryptionParameters\": null,\"ebsVolumeType\": \"gp2\",\"ebsVolumeSize\": {\"size\": 1,\"unit\": \"TB\"},\"haParams\": {\"node2SubnetId\": \"$haSubnetId1\",\"failoverMode\":\"PrivateIP\",\"mediatorSubnetId\": \"$haSubnetId1\",\"mediatorKeyPairName\": \"$keyPair\",\"node1SubnetId\": \"$haSubnetId1\",\"routeTableIds\": [\"$routeTableId1\"],\"mediatorProxy\": {\"url\": \"proxyUrl\",\"userName\": null,\"password\": null}},\"awsTags\": [],\"instanceTenancy\": \"dedicated\",\"awsEncryptionParameters\": {\"kmsKeyId\": \"eecb7e25-848a-40c7-85da-7af078e74ade\"}}"  | jq .

To monitor creation of the HA configuration, you can use the following API call:

sleep 60
curl http://localhost/occm/api/vsa/working-environments -X GET --header "Content-Type:application/json" --header "Authorization:$token" > getHA.txt
cat getHA.txt| jq -r .[0].publicId > haId.txt
cat getHA.txt| jq -r .[0].svmName > svmName.txt
haid=`cat haId.txt`
svm=`cat svmName.txt`

Creating an aggregate on a node in an HA configuration

The following operation creates an aggregate on the first node in an HA configuration:

curl http://localhost/occm/api/aws/ha/aggregates -X POST --header "Content-Type:application/json" --header "Authorization:$token" --data "{\"name\": \"aggr2\",\"workingEnvironmentId\": \"$haid\",\"numberOfDisks\": \"2\",\"diskSize\": {\"size\": \"500\",\"unit\": \"GB\"},\"homeNode\": \"Ha1-01\", \"providerVolumeType\": \"gp2\"}"

Changing the underlying AWS disk type to tier data to S3

The following API commands change the underlying AWS disk type to use data tiering (General Purpose SSD + S3). Note that the first API call might not return the aggregateName parameter. If that happens, Cloud Manager chooses the best matching aggregate (if one exists) or it creates a new aggregate that meets the requirements.

curl http://localhost/occm/api/aws/ha/volumes/quote -X POST --header "Content-Type:application/json" --header "Authorization:$token" --data "{\"workingEnvironmentId\":\"%haid%\",\"svmName\":\"%svm%\",\"name\":\"newVol1\",\"verifyNameUniqueness\":false,\"size\":{\"size\":100,\"unit\":\"GB\"},\"enableThinProvisioning\":true,\"providerVolumeType\":\"gp2\",\"capacityTier\":\"S3\"}" > quote.txt
cat quote.txt| jq -r .numOfDisks >disks.txt
cat quote.txt| jq -r .aggregateName >aggrName.txt
disks=`cat disks.txt`
aggrName=`cat aggrName.txt`

curl http://localhost/occm/api/aws/ha/volumes/%haid%/%svm%/newVol1/change-tier -X POST --header "Content-Type:application/json" --header "Authorization:$token" --data "{\"aggregateName\":\"%aggrName%\",\"numOfDisks\":\"%disks%\",\"newAggregate\":true,\"newDiskTypeName\":\"gp2\",\"newCapacityTier\":\"S3\"}"

Updating route tables for an HA configuration

The following API call updates the list of route tables that contain route entries for an HA configuration’s floating IP addresses:

curl http://localhost/occm/api/aws/ha/working-environments/%haid%/route-tables -X PUT --header "Content-Type:application/json" --header "Authorization:$token" --data "{\"routeTableIds\": [\"%routeTableId1%\", \"%routeTableId2%\"]}"

Creating systems in Azure

Deploying a single node Cloud Volumes ONTAP system in Azure

The following operation deploys a Cloud Volumes ONTAP system in Azure:

curl http://localhost/occm/api/azure/vsa/working-environments -X POST --header "Content-Type:application/json" --header "Authorization:$token" --data "{\"name\": \"vsaAzure\",\"tenantId\": \"$tenantId\",\"region\": \"westus\",\"vsaMetadata\": {  \"ontapVersion\": \"ONTAP-9.4X8.T1.azure\",  \"licenseType\": \"azure-cot-standard-paygo\",  \"instanceType\": \"Standard_DS4_v2\"},\"writingSpeedState\": \"NORMAL\",\"subnetId\": \"$azureSubnetId\",\"svmPassword\": \"$svmPassword\",\"vnetId\": \"$azureVnetId\",\"cloudProviderAccount\": \"$azureAccountId\",\"subscriptionId\": \"$azureSubscriptionId\",\"cidr\": \"$azureCidr\",\"dataEncryptionType\": \"NONE\",\"ontapEncryptionParameters\": null,\"securityGroupId\": null,\"skipSnapshots\": false,\"diskSize\": {  \"size\": 1,  \"unit\": \"TB\"},\"storageType\": \"Premium_LRS\",\"azureTags\": []}" | jq .

The following API call monitors creation of the system:

curl http://localhost/occm/api/azure/vsa/working-environments -X GET --header "Content-Type:application/json" --header "Authorization:$token" | jq -r .[0].publicId > azureId.txt
azureId=`cat azureId.txt`

Creating an aggregate for a Cloud Volumes ONTAP system in Azure

The following API call creates an aggregate on a Cloud Volumes ONTAP system in Azure using the public ID returned when creating the working environment:

curl http://localhost/occm/api/azure/vsa/aggregates -X POST --header "Content-Type:application/json" header "Authorization:$token" --data "{\"name\": \"aggr2\",\"workingEnvironmentId\": \"%azureId%\",\"numberOfDisks\": \"2\",\"diskSize\": {\"size\": \"1\",\"unit\": \"TB\"},\"providerVolumeType\": \"Standard_LRS\"}"

Deploying an HA pair in Azure

The following API call creates an HA pair in Azure:

curl http://localhost/occm/api/azure/ha/working-environments -X POST  --header "Content-Type: application/json" --header "Authorization: $token" --data "{\"name\": \"kuki2\",\"tenantId\": \"$tenantId\",\"region\": \"$region\",\"packageName\": \"azure_ha_standard\",\"dataEncryptionType\": \"AZURE\",\"capacityTier\": \"Blob\",\"vsaMetadata\": {\"ontapVersion\":\"latest\",\"licenseType\": \"azure-ha-cot-standard-paygo\",\"instanceType\":\"Standard_DS4_v2\"},\"writingSpeedState\": \"NORMAL\",\"subnetId\": \"$subnetId\",\"svmPassword\": \"$svmPassword\",\"vnetId\": \"$vnetId\",\"cidr\": \"$azureCidr\",\"ontapEncryptionParameters\": null,\"securityGroupId\": null,\"skipSnapshots\": false,\"diskSize\": {\"size\": 1,\"unit\": \"TB\",\"_identifier\": \"1 TB\"},\"storageType\": \"Premium_LRS\",\"azureTags\": [], \"resourceGroup\": \"testHAazure-rg\", \"subscriptionId\": \"1\",\"cloudProviderAccount\": \"$azureAccountId\"}"

Stopping a Cloud Volumes ONTAP system in Azure

To stop a Cloud Volumes ONTAP system in Azure, invoke the following API call using the working environment ID returned from the create-request:

curl http://localhost/occm/api/azure/vsa/working-environments/$azureId/stop?take_snapshots=true -X POST --header "Content-Type:application/json" --header "Authorization:$token"

Starting a Cloud Volumes ONTAP system in Azure

To start a Cloud Volumes ONTAP system in Azure, invoke the following API call using the working environment ID returned from the create-request:

curl http://localhost/occm/api/azure/vsa/working-environments/$azureId/start -X POST --header "Content-Type:application/json" --header "Authorization:$token"

Creating systems in GCP

To create a Cloud Volumes ONTAP working environment in GCP, invoke the following API call:

curl http://localhost/occm/api/gcp/vsa/working-environments -X POST --header "Content-Type: application/json" --header "Authorization:$token" --data "{\"name\": \"gcptest1\", \"tenantId\": \"$tenantId\", \"region\": \"us-east1-b\", \"packageName\": \"gcp_poc\", \"dataEncryptionType\": \"GCP\", \"vsaMetadata\": {\"ontapVersion\": \"ONTAP-9.6X17.T1.gcp\", \"licenseType\": \"gcp-cot-explore-paygo\", \"instanceType\": \"custom-4-16384\"}, \"writingSpeedState\": \"NORMAL\", \"subnetId\": \"default\", \"svmPassword\": \"$svmPassword\", \"vpcId\": \"default\", \"gcpVolumeSize\": {\"size\": 500, \"unit\": \"GB\", \"_identifier\": \"500 GB\"}, \"gcpVolumeType\": \"pd-ssd\", \"gcpLabels\": []}"

If you want to create a Cloud Volumes ONTAP working environment with customer-managed keys, you’ll need to provide the KMS key. To find the keypath for the KMS key that Cloud Manager requires in the request, use the following API call:

curl "http://localhost/occm/api/gcp/vsa/metadata/gcp-encryption-keys?region=us-east1&project=$gcpProject" -X GET --header "Content-Type: application/json" --header "Authorization:$token" | jq -r .[0].id > kmsKey.txt

kmsKey=`cat kmsKey.txt`

To create a Cloud Volumes ONTAP working environment in GCP with customer-managed keys, invoke the following API call:

curl http://localhost/occm/api/gcp/vsa/working-environments -X POST --header "Content-Type: application/json" --header "Authorization:$token" --data "{\"name\": \"gcptest2\", \"tenantId\": \"$tenantId\", \"region\": \"us-east1-b\", \"packageName\": \"gcp_poc\", \"project\": \"$gcpProject\", \"dataEncryptionType\": \"GCP\", \"vsaMetadata\":{\"ontapVersion\": \"ONTAP-9.6X17.T1.gcp\", \"licenseType\": \"gcp-cot-explore-paygo\", \"instanceType\": \"custom-4-16384\"}, \"writingSpeedState\": \"NORMAL\", \"subnetId\": \"default\", \"svmPassword\": \"$svmPassword\", \"vpcId\": \"default\", \"gcpVolumeSize\": {\"size\": 500, \"unit\": \"GB\", \"_identifier\": \"500 GB\"}, \"gcpVolumeType\": \"pd-ssd\", \"gcpEncryptionParameters\": {\"key\": \"$kmsKey\"}, \"gcpLabels\": []}"

Managing Snapshot copies

Creating Snapshot copies

To create a Snapshot copy, invoke the following API call using the working environment ID, SVM name, and volume name:

curl http://localhost/occm/api/vsa/volumes/$weid/$svm/newVol/snapshot -X DELETE --header "Content-Type:application/json" --header "Authorization: $token"  --data "{\"snapshotName\": [\"$snapshotName\"]}"

Deleting Snapshot copies

To delete a Snapshot copy, invoke the following API call using the working environment ID, SVM name, and volume name:

curl http://localhost/occm/api/vsa/volumes/$weid/$svm/newVol/snapshot -X DELETE --header "Content-Type:application/json" --header "Authorization: $token"  --data "{\"snapshotName\": [\"$snapshotName\"]}"

Resources

This section describes the API calls available for each resource.

Accounts

Creates a Nss account.

POST /accounts/nss
Parameters
Type Name Description Required Schema Default

BodyParameter

body

true

NssAccountRequest

Responses
HTTP Code Description Schema

default

success

NssAccountResponse

Consumes
  • application/json

Produces
  • application/json

Deletes an existing account. It is not possible to delete an account that has working environments attached to it.

DELETE /accounts/{cloudProviderAccountId}
Parameters
Type Name Description Required Schema Default

PathParameter

cloudProviderAccountId

Public Id of the account to be deleted

true

string

Responses
HTTP Code Description Schema

404

Account with the given account id does not exist

No Content

Consumes
  • application/json

Produces
  • application/json

Updates an existing AWS account.

PUT /accounts/aws/{cloudProviderAccountId}
Parameters
Type Name Description Required Schema Default

PathParameter

cloudProviderAccountId

Public Id of AWS account

true

string

BodyParameter

body

false

AwsAccountRequest

Responses
HTTP Code Description Schema

200

success

AwsAccountResponse

404

AWS Account with the given account id does not exist

No Content

Consumes
  • application/json

Produces
  • application/json

Retrieves an AWS account by public Id.

GET /accounts/aws/{cloudProviderAccountId}
Parameters
Type Name Description Required Schema Default

PathParameter

cloudProviderAccountId

Public Id of AWS account

true

string

Responses
HTTP Code Description Schema

default

success

AwsAccountResponse

Consumes
  • application/json

Produces
  • application/json

Retrieves accounts.

GET /accounts
Responses
HTTP Code Description Schema

default

success

CloudProviderAccountResponse

Consumes
  • application/json

Produces
  • application/json

Updates vsa list of an existing Nss account.

PUT /accounts/nss/set-vsa-list/{cloudProviderAccountId}
Parameters
Type Name Description Required Schema Default

PathParameter

cloudProviderAccountId

Public Id of Nss account

true

string

BodyParameter

body

false

NssAccountVsaListRequest

Responses
HTTP Code Description Schema

200

success

NssAccountResponse

404

Nss Account with the given account id does not exist

No Content

Consumes
  • application/json

Produces
  • application/json

Creates an Azure account.

POST /accounts/azure
Parameters
Type Name Description Required Schema Default

BodyParameter

body

true

AzureAccountRequest

Responses
HTTP Code Description Schema

default

success

AzureAccountResponse

Consumes
  • application/json

Produces
  • application/json

Updates an existing Azure account.

PUT /accounts/azure/{cloudProviderAccountId}
Parameters
Type Name Description Required Schema Default

PathParameter

cloudProviderAccountId

Public Id of Azure account

true

string

BodyParameter

body

false

AzureAccountRequest

Responses
HTTP Code Description Schema

200

success

AzureAccountResponse

404

Azure Account with the given account id does not exist

No Content

Consumes
  • application/json

Produces
  • application/json

Retrieves an Azure account by public Id.

GET /accounts/azure/{cloudProviderAccountId}
Parameters
Type Name Description Required Schema Default

PathParameter

cloudProviderAccountId

Public Id of Azure account

true

string

Responses
HTTP Code Description Schema

default

success

AzureAccountResponse

Consumes
  • application/json

Produces
  • application/json

Create a Gcp Storage account.

POST /accounts/gcp
Parameters
Type Name Description Required Schema Default

BodyParameter

body

true

GcpStorageAccountRequest

Responses
HTTP Code Description Schema

default

success

GcpAccountResponse

Consumes
  • application/json

Produces
  • application/json

Updates an existing Nss account.

PUT /accounts/nss/{cloudProviderAccountId}
Parameters
Type Name Description Required Schema Default

PathParameter

cloudProviderAccountId

Public Id of Nss account

true

string

BodyParameter

body

false

NssAccountRequest

Responses
HTTP Code Description Schema

200

success

NssAccountResponse

404

Nss Account with the given account id does not exist

No Content

Consumes
  • application/json

Produces
  • application/json

Retrieves a Nss account by public Id.

GET /accounts/nss/{cloudProviderAccountId}
Parameters
Type Name Description Required Schema Default

PathParameter

cloudProviderAccountId

Public Id of Nss account

true

string

Responses
HTTP Code Description Schema

default

success

NssAccountResponse

Consumes
  • application/json

Produces
  • application/json

Creates an AWS account.

POST /accounts/aws
Parameters
Type Name Description Required Schema Default

BodyParameter

body

true

AwsAccountRequest

Responses
HTTP Code Description Schema

default

success

AwsAccountResponse

Consumes
  • application/json

Produces
  • application/json

Updates an existing Gcp storage account.

PUT /accounts/gcp/{cloudProviderAccountId}
Parameters
Type Name Description Required Schema Default

PathParameter

cloudProviderAccountId

Public Id of Gcp storage account

true

string

BodyParameter

body

false

GcpStorageAccountRequest

Responses
HTTP Code Description Schema

200

success

GcpAccountResponse

404

Gcp Storage Account with the given account does not exist

No Content

Consumes
  • application/json

Produces
  • application/json

Retrieve Gcp Storage account by public Id.

GET /accounts/gcp/{cloudProviderAccountId}
Parameters
Type Name Description Required Schema Default

PathParameter

cloudProviderAccountId

Public Id of Gcp Storage account

true

string

Responses
HTTP Code Description Schema

default

success

GcpAccountResponse

Consumes
  • application/json

Produces
  • application/json

Active-directory

Creates a new active directory entry.

POST /active-directory
Parameters
Type Name Description Required Schema Default

BodyParameter

body

Create Active Directory Request

true

ActiveDirectoryCreateRequest

Consumes
  • application/json

Produces
  • application/json

Retrieves active directory entries.

GET /active-directory
Responses
HTTP Code Description Schema

default

success

ActiveDirectoryEntry array

Consumes
  • application/json

Produces
  • application/json

Deletes an existing active directory entry.

DELETE /active-directory/{activeDirectoryId}
Parameters
Type Name Description Required Schema Default

PathParameter

activeDirectoryId

Public Id of active directory

true

string

Consumes
  • application/json

Produces
  • application/json

Updates an existing active directory entry.

PUT /active-directory/{activeDirectoryId}
Parameters
Type Name Description Required Schema Default

PathParameter

activeDirectoryId

Public Id of active directory

true

string

BodyParameter

body

Create Active Directory Request

true

ActiveDirectoryUpdateRequest

Consumes
  • application/json

Produces
  • application/json

Check connection to active directory.

POST /active-directory/check-connection
Parameters
Type Name Description Required Schema Default

BodyParameter

body

Create Active Directory Request

true

ActiveDirectoryCheckConnectionRequest

Consumes
  • application/json

Produces
  • application/json

Anf

Get Azure Netapp Files Volumes.

GET /anf/volumes
Consumes
  • application/json

Produces
  • application/json

Get Azure Netapp Files Volumes summary.

GET /anf/summary
Consumes
  • application/json

Produces
  • application/json

Delete Azure Netapp Files volume.

DELETE /anf/volume/{subscription}/{resourceGroup}/{account}/{pool}/{volume}
Parameters
Type Name Description Required Schema Default

PathParameter

subscription

true

string

PathParameter

resourceGroup

true

string

PathParameter

account

true

string

PathParameter

pool

true

string

PathParameter

volume

true

string

Consumes
  • application/json

Produces
  • application/json

Get Azure Netapp Files data for creation.

GET /anf/data-creation
Consumes
  • application/json

Produces
  • application/json

Create Azure Netapp Files volume.

POST /anf/volume
Parameters
Type Name Description Required Schema Default

BodyParameter

body

true

CreateAzureNetappFileVolumeRequest

Consumes
  • application/json

Produces
  • application/json

Audit

Retrieves the audit group entry for the specific request ID.

GET /audit/{requestId}
Parameters
Type Name Description Required Schema Default

PathParameter

requestId

Retrieve audit group entries for this request ID

true

string

QueryParameter

records

with records

false

boolean

Responses
HTTP Code Description Schema

default

success

AuditGroupSummary array

Consumes
  • application/json

Produces
  • application/json

Retrieves audit group entries optionally filtered by query parameters.

GET /audit
Parameters
Type Name Description Required Schema Default

QueryParameter

limit

Limit entries to specific amount

false

integer (int32)

QueryParameter

after

Filter entries after specific date

false

integer (int64)

QueryParameter

workingEnvironmentId

Filter entries by working environment public ID

false

string

Responses
HTTP Code Description Schema

default

success

AuditGroupSummary array

Consumes
  • application/json

Produces
  • application/json

Retrieves audit groups and group records optionally filtered by query parameters.

GET /audit/auditserver
Responses
HTTP Code Description Schema

default

success

AuditGroupSummary array

Consumes
  • application/json

Produces
  • application/json

Aws-ha:aggregates

Creates a new aggregate

POST /aws/ha/aggregates
Parameters
Type Name Description Required Schema Default

BodyParameter

body

Create Aggregate Request

true

VsaAggregateCreateRequest

Consumes
  • application/json

Produces
  • application/json

Retrieves aggregates

GET /aws/ha/aggregates
Parameters
Type Name Description Required Schema Default

QueryParameter

workingEnvironmentId

Public Id of working environment

false

string

Responses
HTTP Code Description Schema

default

success

AggregateResponse array

Consumes
  • application/json

Produces
  • application/json

Adds disks to an existing aggregate

POST /aws/ha/aggregates/{workingEnvironmentId}/{aggregateName}/disks
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

PathParameter

aggregateName

Name of aggregate to be updated

true

string

BodyParameter

body

Add disk to aggregate request

true

AddDisksToAggregateRequest

Consumes
  • application/json

Produces
  • application/json

Deletes an existing aggregate

DELETE /aws/ha/aggregates/{workingEnvironmentId}/{aggregateName}
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

PathParameter

aggregateName

Name of aggregate to be deleted

true

string

Consumes
  • application/json

Produces
  • application/json

Aws-ha:discovery

Saves a previously discovered Cloud Volumes ONTAP working environment to the Cloud Manager database.

POST /aws/ha/discovery/recover
Parameters
Type Name Description Required Schema Default

BodyParameter

body

Working environment

true

RecoverVsaRequest

Responses
HTTP Code Description Schema

default

success

VsaWorkingEnvironmentResponse

Consumes
  • application/json

Produces
  • application/json

Retrieves a list of discovered working environments visible to the current user in the specified AWS region.

GET /aws/ha/discovery/discover
Parameters
Type Name Description Required Schema Default

QueryParameter

region

Region to discover working environments

true

string

QueryParameter

cloudProviderAccountId

false

string

Responses
HTTP Code Description Schema

default

success

DiscoveredAwsHaResponse array

Consumes
  • application/json

Produces
  • application/json

Aws-ha:encryption

Updates the key manager CA certificate on the Cloud Volumes ONTAP system

POST /aws/ha/encryption/{workingEnvironmentId}/update-key-manager-ca-certificate
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

Update Cloud Volumes ONTAP key manager CA certificate request parameters

true

UpdateKeyManagerCaCertificateRequest

Responses
HTTP Code Description Schema

default

success

CertificateResponse

Consumes
  • application/json

Produces
  • application/json

Updates the client certificate on the Cloud Volumes ONTAP system

POST /aws/ha/encryption/{workingEnvironmentId}/update-client-certificate
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Responses
HTTP Code Description Schema

default

success

CertificateResponse

Consumes
  • application/json

Produces
  • application/json

Deletes a key manager from the Cloud Volumes ONTAP system

DELETE /aws/ha/encryption/{workingEnvironmentId}/key-managers/{keyManagerIp}
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

PathParameter

keyManagerIp

Key manager IP address

true

string

Consumes
  • application/json

Produces
  • application/json

Adds a key manager to the Cloud Volumes ONTAP system

POST /aws/ha/encryption/{workingEnvironmentId}/key-managers/{keyManagerIp}
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

PathParameter

keyManagerIp

Key manager IP address

true

string

Consumes
  • application/json

Produces
  • application/json

Aws-ha:metadata

Retrieves supported capacity tiers for EBS volume types

GET /aws/ha/metadata/supported-capacity-tiers
Parameters
Type Name Description Required Schema Default

QueryParameter

region

true

string

QueryParameter

ontapVersion

true

string

QueryParameter

dataEncryptionType

true

string

QueryParameter

licenseType

true

string

QueryParameter

instanceType

true

string

Responses
HTTP Code Description Schema

default

success

SupportedCapacityTiers

Consumes
  • application/json

Produces
  • application/json

Retrieves AWS encryption keys for specific region

GET /aws/ha/metadata/aws-encryption-keys
Parameters
Type Name Description Required Schema Default

QueryParameter

region

true

string

QueryParameter

roleArn

false

string

QueryParameter

cloudProviderAccountId

false

string

Responses
HTTP Code Description Schema

default

success

AwsEncryptionKey array

Consumes
  • application/json

Produces
  • application/json

Retrieves default snapshot policies available on a cluster

GET /aws/ha/metadata/default-snapshot-policies
Responses
HTTP Code Description Schema

default

success

SnapshotPolicy array

Consumes
  • application/json

Produces
  • application/json

Retrieves supported EBS volume types

GET /aws/ha/metadata/ebs-volume-types
Responses
HTTP Code Description Schema

default

success

EbsVolumeType array

Consumes
  • application/json

Produces
  • application/json

Retrieves instance types not supporting acceleration and capacity tiering

GET /aws/ha/metadata/instance-types-not-supporting-acceleration-and-capacity-tiering
Responses
HTTP Code Description Schema

default

success

InstanceTypesNotSupportingAccelerationAndCapacityTieringResponse

Consumes
  • application/json

Produces
  • application/json

Validates the current user is subscribed to Cloud Volumes ONTAP product in Amazon marketplace

POST /aws/ha/metadata/validate-subscribed-to-ontap-cloud
Parameters
Type Name Description Required Schema Default

BodyParameter

body

Validate subscribed to Cloud Volumes ONTAP request

true

AwsValidateSubscribedToOntapCloudRequest

Responses
HTTP Code Description Schema

default

success

AwsValidateSubscribedToOntapCloudResponse

Consumes
  • application/json

Produces
  • application/json

Retrieves AWS user Key Pairs for specific region

GET /aws/ha/metadata/key-pairs
Parameters
Type Name Description Required Schema Default

QueryParameter

region

true

string

QueryParameter

roleArn

false

string

QueryParameter

cloudProviderAccountId

false

string

Responses
HTTP Code Description Schema

default

success

string array

Consumes
  • application/json

Produces
  • application/json

Validate HA floating IPs.

POST /aws/ha/metadata/validate-floating-ips
Parameters
Type Name Description Required Schema Default

BodyParameter

body

Validate HA floating IPs request

true

AwsHaFloatingIpValidationData

Responses
HTTP Code Description Schema

default

success

AwsHaFloatingIpValidationResponse

Consumes
  • application/json

Produces
  • application/json

Retrieves all Cloud Manager manifests. Refer to the API Developers Guide in order to understand how to extract valid region codes, license types, instance types and Cloud Volumes ONTAP version parameters for the creation of a Cloud Volumes ONTAP working environment.

GET /aws/ha/metadata/manifests
Responses
HTTP Code Description Schema

default

success

MetadataResponse

Consumes
  • application/json

Produces
  • application/json

Retrieves all Cloud Volumes ONTAP configurations.

GET /aws/ha/metadata/permutations
Parameters
Type Name Description Required Schema Default

QueryParameter

region

Filter by region

false

string

QueryParameter

version

Filter by version

false

string

QueryParameter

license

Filter by license

false

string

QueryParameter

instance_type

Filter by instance type

false

string

QueryParameter

default_instance_type

Filter by default instance type

false

string

QueryParameter

feature

Filter by feature

false

string

QueryParameter

latest_only

Filter latest only

false

string

QueryParameter

ami

Filter by ami id

false

string

Responses
HTTP Code Description Schema

default

success

Configuration array

Consumes
  • application/json

Produces
  • application/json

Retrieves the minimum number of required IPs for a single Cloud Volumes ONTAP system, an HA node, and HA mediator

GET /aws/ha/metadata/network-requirements
Responses
HTTP Code Description Schema

default

success

NetworkRequirementsResponse

Consumes
  • application/json

Produces
  • application/json

Retrieves AWS regions over which an Cloud Volumes ONTAP working environment may be created

GET /aws/ha/metadata/regions
Responses
HTTP Code Description Schema

default

success

Region array

Consumes
  • application/json

Produces
  • application/json

Retrieves AWS user Key Pairs for all regions

GET /aws/ha/metadata/key-pairs-by-region
Parameters
Type Name Description Required Schema Default

QueryParameter

roleArn

false

string

QueryParameter

cloudProviderAccountId

false

string

Responses
HTTP Code Description Schema

default

success

KeyPairsByRegionResponse

Consumes
  • application/json

Produces
  • application/json

Retrieves packages configuration

GET /aws/ha/metadata/packages
Responses
HTTP Code Description Schema

default

success

PackageInfoResponse array

Consumes
  • application/json

Produces
  • application/json

Retrieves route tables per vpc and their subnet associations.

GET /aws/ha/metadata/route-tables
Parameters
Type Name Description Required Schema Default

QueryParameter

region

true

string

QueryParameter

vpcId

true

string

QueryParameter

roleArn

false

string

QueryParameter

cloudProviderAccountId

false

string

Responses
HTTP Code Description Schema

default

success

RouteTableResponse array

Consumes
  • application/json

Produces
  • application/json

Retrieves all the Tag names

GET /aws/ha/metadata/tag-keys
Parameters
Type Name Description Required Schema Default

QueryParameter

roleArn

false

string

QueryParameter

cloudProviderAccountId

false

string

Responses
HTTP Code Description Schema

default

success

TagKeyResponse array

Consumes
  • application/json

Produces
  • application/json

Retrieves VPCs

GET /aws/ha/metadata/vpcs
Parameters
Type Name Description Required Schema Default

QueryParameter

region

true

string

QueryParameter

roleArn

false

string

QueryParameter

cloudProviderAccountId

false

string

Responses
HTTP Code Description Schema

default

success

VpcExtendedResponse array

Consumes
  • application/json

Produces
  • application/json

Retrieves AWS instance profiles

GET /aws/ha/metadata/instance-profiles
Parameters
Type Name Description Required Schema Default

QueryParameter

roleArn

false

string

QueryParameter

cloudProviderAccountId

false

string

Responses
HTTP Code Description Schema

default

success

InstanceProfileResponse array

Consumes
  • application/json

Produces
  • application/json

Retrieves supported features

GET /aws/ha/metadata/supported-features
Parameters
Type Name Description Required Schema Default

QueryParameter

region

true

string

QueryParameter

ontapVersion

true

string

QueryParameter

dataEncryptionType

true

string

QueryParameter

licenseType

true

string

QueryParameter

instanceType

true

string

Responses
HTTP Code Description Schema

default

success

SupportedFeaturesResponse

Consumes
  • application/json

Produces
  • application/json

Aws-ha:volumes

Creates a new volume. If the properties aggregateName and maxNumOfDisksApprovedToAdd are not filled in, then the response will fail with a suggested aggregate name and the number of disks that will need to be created in order to fulfill the request.Operation may only be performed on working environments whose status is: ON, DEGRADED

POST /aws/ha/volumes
Parameters
Type Name Description Required Schema Default

QueryParameter

createAggregateIfNotFound

On create volume request, allow creating not-found aggregate

false

boolean

BodyParameter

body

Create volume request

true

VsaVolumeCreateRequest

Consumes
  • application/json

Produces
  • application/json

Retrieves volumes.Operation may only be performed on working environments whose status is: ON, DEGRADED

GET /aws/ha/volumes
Parameters
Type Name Description Required Schema Default

QueryParameter

workingEnvironmentId

Filter volumes by this working environment

true

string

Responses
HTTP Code Description Schema

default

success

VolumeResponse array

Consumes
  • application/json

Produces
  • application/json

Deletes an existing volume.Operation may only be performed on working environments whose status is: ON, DEGRADED

DELETE /aws/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

PathParameter

svmName

true

string

PathParameter

volumeName

true

string

Consumes
  • application/json

Produces
  • application/json

Modify an existing volume.Operation may only be performed on working environments whose status is: ON, DEGRADED

PUT /aws/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

PathParameter

svmName

true

string

PathParameter

volumeName

true

ref

BodyParameter

body

Modify volume request

true

VolumeModifyRequest

Consumes
  • application/json

Produces
  • application/json

Change underlying volume tier.Operation may only be performed on working environments whose status is: ON, DEGRADED

POST /aws/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/change-tier
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

PathParameter

svmName

true

string

PathParameter

volumeName

true

string

BodyParameter

body

true

ChangeVolumeTierRequest

Consumes
  • application/json

Produces
  • application/json

Move an existing volume.Operation may only be performed on working environments whose status is: ON, DEGRADED

POST /aws/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/move
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

PathParameter

svmName

true

string

PathParameter

volumeName

true

string

BodyParameter

body

true

VolumeMoveRequest

Consumes
  • application/json

Produces
  • application/json

Clones an existing volume.Operation may only be performed on working environments whose status is: ON, DEGRADED

POST /aws/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/clone
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

PathParameter

svmName

true

string

PathParameter

volumeName

true

string

BodyParameter

body

true

VolumeCloneRequest

Consumes
  • application/json

Produces
  • application/json

Delete snapshot manually.Operation may only be performed on working environments whose status is: ON, DEGRADED

DELETE /aws/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

PathParameter

svmName

true

string

PathParameter

volumeName

true

string

BodyParameter

body

Create snapshot request

true

SnapshotDeleteRequest

Consumes
  • application/json

Produces
  • application/json

Create snapshot manually.Operation may only be performed on working environments whose status is: ON, DEGRADED

POST /aws/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

PathParameter

svmName

true

string

PathParameter

volumeName

true

string

BodyParameter

body

Create snapshot request

true

SnapshotCreateRequest

Consumes
  • application/json

Produces
  • application/json

Quotes a new volume. Returns a resource quote needed to satisfy the requested volume.Operation may only be performed on working environments whose status is: ON, DEGRADED

POST /aws/ha/volumes/quote
Parameters
Type Name Description Required Schema Default

BodyParameter

body

Quote volume request

true

VsaVolumeQuoteRequest

Responses
HTTP Code Description Schema

default

success

VsaVolumeQuoteResponse

Consumes
  • application/json

Produces
  • application/json

Return a list of snapshot descriptions for the volume.Operation may only be performed on working environments whose status is: ON, DEGRADED

GET /aws/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshots
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

PathParameter

svmName

true

string

PathParameter

volumeName

true

string

Responses
HTTP Code Description Schema

default

success

[SnapshotResponse] array

Consumes
  • application/json

Produces
  • application/json

Aws-ha:working-environments

Setup a new CIFS using workgroup configuration to an existing Cloud Volumes ONTAP working environment

POST /aws/ha/working-environments/{workingEnvironmentId}/cifs-workgroup
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

CIFS Configuration request

true

CIFSWorkgroupConfigurationRequest

Consumes
  • application/json

Produces
  • application/json

Create snapshot policy

POST /aws/ha/working-environments/{workingEnvironmentId}/snapshot-policy
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

BodyParameter

body

Create snapshot policy request

true

SnapshotPolicyCreateRequest

Consumes
  • application/json

Produces
  • application/json

Updates Cloud Manager password of a specific Cloud Volumes ONTAP

PUT /aws/ha/working-environments/{workingEnvironmentId}/update-credentials
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

Update Cloud Manager password request

true

UpdateCredentialsRequest

Consumes
  • application/json

Produces
  • application/json

Activate FPolicy for ransomeware files

PUT /aws/ha/working-environments/{workingEnvironmentId}/activate-fpolicy
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

Consumes
  • application/json

Produces
  • application/json

Disable FPolicy for ransomeware files

PUT /aws/ha/working-environments/{workingEnvironmentId}/disable-fpolicy
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

Consumes
  • application/json

Produces
  • application/json

Setup NTP server

POST /aws/ha/working-environments/{workingEnvironmentId}/ntp
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

NTP Configuration request

true

NTPConfigurationRequest

Consumes
  • application/json

Produces
  • application/json

Working Environment Cost And Usage

GET /aws/ha/working-environments/{workingEnvironmentId}/cost-and-usage
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

QueryParameter

start

cost and usage start period

false

string

QueryParameter

end

cost and usage end period

false

string

Responses
HTTP Code Description Schema

default

success

WorkingEnvironmentCostAndUsageResponse

Consumes
  • application/json

Produces
  • application/json

Modify the net port broadcast domain mtu of the Cloud Volumes ONTAP

PUT /aws/ha/working-environments/{workingEnvironmentId}/networkOptimization
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

Use optimization

true

ChangeNetworkOptimizationRequest

Consumes
  • application/json

Produces
  • application/json

Sets the writing speed for Cloud Volumes ONTAP

PUT /aws/ha/working-environments/{workingEnvironmentId}/writing-speed
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

Writing speed request

true

WritingSpeedRequest

Consumes
  • application/json

Produces
  • application/json

Stops a specific Cloud Volumes ONTAP instance

POST /aws/ha/working-environments/{workingEnvironmentId}/stop
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

QueryParameter

takeSnapshots

Take snapshots before stopping Cloud Volumes ONTAP

true

boolean

true

Consumes
  • application/json

Produces
  • application/json

Starts a specific Cloud Volumes ONTAP instance

POST /aws/ha/working-environments/{workingEnvironmentId}/start
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Consumes
  • application/json

Produces
  • application/json

Performs a complete image update operation on the single node of the specified Cloud Volumes ONTAP

POST /aws/ha/working-environments/{workingEnvironmentId}/update-image
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

Update system image request

true

UpdateSystemImageRequest

Consumes
  • application/json

Produces
  • application/json

Checks for the presence of non-persistent locks held on CIFs Sessions.

GET /aws/ha/working-environments/{workingEnvironmentId}/cifs-locks-exist
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

Responses
HTTP Code Description Schema

default

success

boolean

Consumes
  • application/json

Produces
  • application/json

Sets the cluster password of a specific Cloud Volumes ONTAP

PUT /aws/ha/working-environments/{workingEnvironmentId}/set-password
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

QueryParameter

occmOnly

false

boolean

BodyParameter

body

Set password request

true

PasswordWrapper

Consumes
  • application/json

Produces
  • application/json

Retrieves eligibility support status of a Cloud Volumes ONTAP system. Valid values - NSS_NOT_VALID, NOT_REGISTERED, IPA_PROBLEM, VALID, NSS_NOT_EXISTS, LICENSE_EXPIRED

GET /aws/ha/working-environments/{workingEnvironmentId}/update-eligibility
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Responses
HTTP Code Description Schema

200

success

EligibilityResponse

400

Working Environment must be ON or UPDATING in order to check eligibility

No Content

Consumes
  • application/json

Produces
  • application/json

Modify the svm name of the Cloud Volumes ONTAP

PUT /aws/ha/working-environments/{workingEnvironmentId}/svm
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

Svm name modification request

true

SvmNameModificationRequest

Consumes
  • application/json

Produces
  • application/json

Activate snapshot policy assignment to all not protected rw volumes

PUT /aws/ha/working-environments/{workingEnvironmentId}/activate-snapshot-policy
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Consumes
  • application/json

Produces
  • application/json

Creates a new AWS HA Cloud Volumes ONTAP working environment.

POST /aws/ha/working-environments
Parameters
Type Name Description Required Schema Default

BodyParameter

body

Working environment

true

CreateAwsHaWorkingEnvironmentRequest

Responses
HTTP Code Description Schema

default

success

VsaWorkingEnvironmentResponse

Consumes
  • application/json

Produces
  • application/json

Retrieves a list of versions to which this Cloud Volumes ONTAP can be upgraded

GET /aws/ha/working-environments/{workingEnvironmentId}/occm-provided-upgrade-versions
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Responses
HTTP Code Description Schema

default

success

OntapUpdateImageMetadata array

Consumes
  • application/json

Produces
  • application/json

Updates mediator of the specified Cloud Volumes ONTAP with the given version.Operation may only be performed on working environments whose status is: ON, DEGRADED

POST /aws/ha/working-environments/{workingEnvironmentId}/update-mediator
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

Consumes
  • application/json

Produces
  • application/json

Activate offbox configuration

PUT /aws/ha/working-environments/{workingEnvironmentId}/offbox
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Consumes
  • application/json

Produces
  • application/json

Change serial number of Cloud Volumes ONTAP

POST /aws/ha/working-environments/{workingEnvironmentId}/change-serial
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

Change serial number request

true

ChangeSerialNumberRequest

Consumes
  • application/json

Produces
  • application/json

Parses an uploaded Cloud license file

POST /aws/ha/working-environments/parse-license-file
Parameters
Type Name Description Required Schema Default

HeaderParameter

filename

Cloud license file name

false

string

BodyParameter

license

license

false

string

Responses
HTTP Code Description Schema

default

success

ProvidedLicenseResponse

Consumes
  • multipart/form-data

Produces
  • application/json

Uploads a Cloud license file content on the provided Cloud Volumes ONTAP

POST /aws/ha/working-environments/{workingEnvironmentId}/upload-licenses
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

license file content request

true

LicenseFileContent

Consumes
  • application/json

Produces
  • application/json

Deletes an existing Cloud Volumes ONTAP working environment, including all Cloud resources created for this working environment (unless the localDelete flag is set to true)

DELETE /aws/ha/working-environments/{workingEnvironmentId}
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

QueryParameter

localDelete

If true, the Cloud Volumes ONTAP instance is not terminated in Cloud, but Cloud Manager no longer manages the working environment.

false

boolean

false

QueryParameter

forceDelete

If true, the working environment will be deleted even if it is part of one or more SnapMirror relationships.

false

boolean

false

Consumes
  • application/json

Produces
  • application/json

Retrieves an HA Cloud Volumes ONTAP working environment.

GET /aws/ha/working-environments/{workingEnvironmentId}
Parameters
Type Name Description Required Schema Default

QueryParameter

fields

false

string

PathParameter

workingEnvironmentId

true

string

Responses
HTTP Code Description Schema

default

success

VsaWorkingEnvironmentResponse

Consumes
  • application/json

Produces
  • application/json

Manually triggers subscription sync for all Cloud Volumes ONTAP working environments

POST /aws/ha/working-environments/sync-subscription
Consumes
  • application/json

Produces
  • application/json

Updates the route tables of an HA Cloud Volumes ONTAP working environment.Operation may only be performed on working environments whose status is: ON, DEGRADED

PUT /aws/ha/working-environments/{workingEnvironmentId}/route-tables
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

BodyParameter

body

true

UpdateRouteTablesRequest

Consumes
  • application/json

Produces
  • application/json

Retrieves action parameters used in create request of a given Cloud Volumes ONTAP instance

GET /aws/ha/working-environments/{workingEnvironmentId}/create-request-parameters
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Responses
HTTP Code Description Schema

default

success

CreateRequestParametersResponse

Consumes
  • application/json

Produces
  • application/json

Delete FPolicy for ransomeware files

DELETE /aws/ha/working-environments/{workingEnvironmentId}/fpolicy
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

Consumes
  • application/json

Produces
  • application/json

Modify user tags for cloud resources of a given Cloud Volumes ONTAP instance

PUT /aws/ha/working-environments/{workingEnvironmentId}/user-tags
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

Modify user tags request

true

ModifyUserTagsRequest

Consumes
  • application/json

Produces
  • application/json

Retrieves editable tags for cloud resources of a given Cloud Volumes ONTAP instance

GET /aws/ha/working-environments/{workingEnvironmentId}/user-tags
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Responses
HTTP Code Description Schema

default

success

UserTagsResponse

Consumes
  • application/json

Produces
  • application/json

Retrieves images already installed on the Cloud Volumes ONTAP

GET /aws/ha/working-environments/{workingEnvironmentId}/ontap-available-images
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Responses
HTTP Code Description Schema

default

success

UpdateLocalImage array

Consumes
  • application/json

Produces
  • application/json

Setup a new CIFS Configuration to an existing Cloud Volumes ONTAP working environment

POST /aws/ha/working-environments/{workingEnvironmentId}/cifs
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

CIFS Configuration request

true

CIFSConfigurationRequest

Consumes
  • application/json

Produces
  • application/json

Retrieves CIFS Configuration to an existing Cloud Volumes ONTAP working environment

GET /aws/ha/working-environments/{workingEnvironmentId}/cifs
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Responses
HTTP Code Description Schema

default

success

CIFSConfigurationResponse array

Consumes
  • application/json

Produces
  • application/json

Registers a Cloud Volumes ONTAP system with NetApp

POST /aws/ha/working-environments/{workingEnvironmentId}/support-registration
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

QueryParameter

nssAccountId

false

string

Responses
HTTP Code Description Schema

default

success

SupportRegistrationResponse

Consumes
  • application/json

Produces
  • application/json

Retrieves the support registration status of a Cloud Volumes ONTAP system

GET /aws/ha/working-environments/{workingEnvironmentId}/support-registration
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Responses
HTTP Code Description Schema

default

success

SupportRegistrationResponse

Consumes
  • application/json

Produces
  • application/json

Uploads a Cloud license file on the provided Cloud Volumes ONTAP

POST /aws/ha/working-environments/{workingEnvironmentId}/upload-license-file
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

HeaderParameter

filename

Cloud license file name

false

string

BodyParameter

license

license

false

string

Consumes
  • multipart/form-data

Produces
  • application/json

Working Environment Ontap Saving

GET /aws/ha/working-environments/{workingEnvironmentId}/ontap-saving
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Responses
HTTP Code Description Schema

default

success

WorkingEnvironmentOntapSavingResponse

Consumes
  • application/json

Produces
  • application/json

Change tier level

POST /aws/ha/working-environments/{workingEnvironmentId}/change-tier-level
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

Change tier level request

true

ChangeTierLevelRequest

Consumes
  • application/json

Produces
  • application/json

Set schedules for Cloud Volumes ONTAP

PUT /aws/ha/working-environments/{workingEnvironmentId}/schedules
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

Cloud Volumes ONTAP working environment update schedule request

true

VsaSchedulesRequest

Consumes
  • application/json

Produces
  • application/json

List start-stop schedules for Cloud Volumes ONTAP

GET /aws/ha/working-environments/{workingEnvironmentId}/schedules
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Responses
HTTP Code Description Schema

default

success

VsaSchedule array

Consumes
  • application/json

Produces
  • application/json

Sets the instance type of a specific Cloud Volumes ONTAP

PUT /aws/ha/working-environments/{workingEnvironmentId}/license-instance-type
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

Instance type modification request

true

LicenseAndInstanceTypeModificationRequest

Consumes
  • application/json

Produces
  • application/json

Retrieves all license types and their associated instance types for a given Cloud Volumes ONTAP instance

GET /aws/ha/working-environments/{workingEnvironmentId}/license-instance-type
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Responses
HTTP Code Description Schema

default

success

LicenseAndInstanceType array

Consumes
  • application/json

Produces
  • application/json

Update Backup to S3 Service settings

PUT /aws/ha/working-environments/{workingEnvironmentId}/cbs-settings
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

BodyParameter

body

true

CbsInfo

Consumes
  • application/json

Produces
  • application/json

Enable capacity tiering

POST /aws/ha/working-environments/{workingEnvironmentId}/enable-capacity-tiering
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

Enable capacity tiering request

true

EnableCapacityTieringRequest

Consumes
  • application/json

Produces
  • application/json

Azure-ha:aggregates

Creates a new aggregate

POST /azure/ha/aggregates
Parameters
Type Name Description Required Schema Default

BodyParameter

body

Create Aggregate Request

true

VsaAggregateCreateRequest

Consumes
  • application/json

Produces
  • application/json

Retrieves aggregates

GET /azure/ha/aggregates/{workingEnvironmentId}
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

Responses
HTTP Code Description Schema

default

success

AggregateResponse array

Consumes
  • application/json

Produces
  • application/json

Adds disks to an existing aggregate

POST /azure/ha/aggregates/{workingEnvironmentId}/{aggregateName}/disks
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

PathParameter

aggregateName

Name of aggregate to be updated

true

string

BodyParameter

body

Add disk to aggregate request

true

AddDisksToAggregateRequest

Consumes
  • application/json

Produces
  • application/json

Deletes an existing aggregate

DELETE /azure/ha/aggregates/{workingEnvironmentId}/{aggregateName}
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

PathParameter

aggregateName

Name of aggregate to be deleted

true

string

Consumes
  • application/json

Produces
  • application/json

Azure-ha:discovery

Retrieves a list of discovered working environments visible to the current user in the specified Azure region.

GET /azure/ha/discovery/discover
Parameters
Type Name Description Required Schema Default

QueryParameter

region

Region to discover working environments

true

string

QueryParameter

subscriptionId

false

string

QueryParameter

cloudProviderAccountId

false

string

Responses
HTTP Code Description Schema

default

success

DiscoveredAzureHaResponse array

Consumes
  • application/json

Produces
  • application/json

Saves a previously discovered Cloud Volumes ONTAP working environment to the Cloud Manager database.

POST /azure/ha/discovery/recover
Parameters
Type Name Description Required Schema Default

BodyParameter

body

Working environment

true

RecoverAzureHARequest

Responses
HTTP Code Description Schema

default

success

AzureVsaWorkingEnvironmentResponse

Consumes
  • application/json

Produces
  • application/json

Azure-ha:metadata

Retrieves the minimum number of required IPs for a Cloud Volumes ONTAP system

GET /azure/ha/metadata/network-requirements
Responses
HTTP Code Description Schema

default

success

AzureNetworkRequirementsResponse

Consumes
  • application/json

Produces
  • application/json

Retrieves packages configuration

GET /azure/ha/metadata/packages
Responses
HTTP Code Description Schema

default

success

PackageInfoResponse array

Consumes
  • application/json

Produces
  • application/json

Retrieves Network Extended Info

GET /azure/ha/metadata/vnets
Parameters
Type Name Description Required Schema Default

QueryParameter

region

true

string

QueryParameter

subscriptionId

false

string

QueryParameter

cloudProviderAccountId

false

string

Responses
HTTP Code Description Schema

default

success

AzureNetworkExtendedResponse

Consumes
  • application/json

Produces
  • application/json

Retrieves all the Tag names

GET /azure/ha/metadata/tag-keys
Parameters
Type Name Description Required Schema Default

QueryParameter

subscriptionId

false

string

QueryParameter

cloudProviderAccountId

false

string

Responses
HTTP Code Description Schema

default

success

TagKeyResponse array

Consumes
  • application/json

Produces
  • application/json

Retrieves supported capacity tiers for Azure disk types

GET /azure/ha/metadata/supported-capacity-tiers
Parameters
Type Name Description Required Schema Default

QueryParameter

region

true

string

QueryParameter

ontapVersion

true

string

QueryParameter

dataEncryptionType

true

string

QueryParameter

licenseType

true

string

QueryParameter

instanceType

true

string

QueryParameter

subscriptionId

false

string

QueryParameter

cloudProviderAccountId

false

string

Responses
HTTP Code Description Schema

default

success

SupportedCapacityTiers

Consumes
  • application/json

Produces
  • application/json

Retrieves supported features

GET /azure/ha/metadata/supported-features
Parameters
Type Name Description Required Schema Default

QueryParameter

region

true

string

QueryParameter

ontapVersion

true

string

QueryParameter

dataEncryptionType

true

string

QueryParameter

licenseType

true

string

QueryParameter

instanceType

true

string

Responses
HTTP Code Description Schema

default

success

SupportedFeaturesResponse

Consumes
  • application/json

Produces
  • application/json

Validates the current user is subscribed to Cloud Volumes ONTAP product in Azure marketplace

POST /azure/ha/metadata/validate-subscribed-to-ontap-cloud
Parameters
Type Name Description Required Schema Default

BodyParameter

body

Validate subscribed to Cloud Volumes ONTAP request

true

AzureValidateSubscribedToOntapCloudRequest

Responses
HTTP Code Description Schema

default

success

AzureValidateSubscribedToOntapCloudResponse

Consumes
  • application/json

Produces
  • application/json

Retrieves supported Azure storage account types

GET /azure/ha/metadata/storage-account-types
Responses
HTTP Code Description Schema

default

success

AzureStorageAccountTypeResponse array

Consumes
  • application/json

Produces
  • application/json

Retrieves default snapshot policies available on a cluster

GET /azure/ha/metadata/default-snapshot-policies
Responses
HTTP Code Description Schema

default

success

SnapshotPolicy array

Consumes
  • application/json

Produces
  • application/json

Retrieves associated subscriptions

GET /azure/ha/metadata/associated-subscriptions
Parameters
Type Name Description Required Schema Default

QueryParameter

cloudProviderAccountId

false

string

Responses
HTTP Code Description Schema

default

success

AssociatedSubscription array

Consumes
  • application/json

Produces
  • application/json

Retrieves Azure regions over which an Cloud Volumes ONTAP working environment may be created

GET /azure/ha/metadata/regions
Parameters
Type Name Description Required Schema Default

QueryParameter

fields

false

string

QueryParameter

subscriptionId

false

string

QueryParameter

cloudProviderAccountId

false

string

Responses
HTTP Code Description Schema

default

success

AzureRegionResponse array

Consumes
  • application/json

Produces
  • application/json

Retrieves all ONTAP Cloud configurations.

GET /azure/ha/metadata/permutations
Parameters
Type Name Description Required Schema Default

QueryParameter

region

Filter by region

false

string

QueryParameter

version

Filter by version

false

string

QueryParameter

license

Filter by license

false

string

QueryParameter

instance_type

Filter by instance type

false

string

QueryParameter

default_instance_type

Filter by default instance type

false

string

QueryParameter

feature

Filter by feature

false

string

QueryParameter

latest_only

Filter latest only

false

string

QueryParameter

marketplace_version

Filter by marketplace version

false

string

QueryParameter

marketplace_sku

Filter by marketplace sku

false

string

Responses
HTTP Code Description Schema

default

success

Configuration array

Consumes
  • application/json

Produces
  • application/json

Retrieves instance types not supporting acceleration and capacity tiering

GET /azure/ha/metadata/instance-types-not-supporting-acceleration-and-capacity-tiering
Responses
HTTP Code Description Schema

default

success

InstanceTypesNotSupportingAccelerationAndCapacityTieringResponse

Consumes
  • application/json

Produces
  • application/json

Azure-ha:volumes

Change underlying volume tier.Operation may only be performed on working environments whose status is: ON, DEGRADED

POST /azure/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/change-tier
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

PathParameter

svmName

true

string

PathParameter

volumeName

true

string

BodyParameter

body

true

ChangeVolumeTierRequest

Consumes
  • application/json

Produces
  • application/json

Return a list of snapshot descriptions for the volume.Operation may only be performed on working environments whose status is: ON, DEGRADED

GET /azure/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshots
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

PathParameter

svmName

true

string

PathParameter

volumeName

true

string

Responses
HTTP Code Description Schema

default

success

[SnapshotResponse] array

Consumes
  • application/json

Produces
  • application/json

Deletes an existing volume.Operation may only be performed on working environments whose status is: ON, DEGRADED

DELETE /azure/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

PathParameter

svmName

true

string

PathParameter

volumeName

true

string

Consumes
  • application/json

Produces
  • application/json

Modify an existing volume.Operation may only be performed on working environments whose status is: ON, DEGRADED

PUT /azure/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

PathParameter

svmName

true

string

PathParameter

volumeName

true

ref

BodyParameter

body

Modify volume request

true

VolumeModifyRequest

Consumes
  • application/json

Produces
  • application/json

Delete snapshot manually.Operation may only be performed on working environments whose status is: ON, DEGRADED

DELETE /azure/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

PathParameter

svmName

true

string

PathParameter

volumeName

true

string

BodyParameter

body

Create snapshot request

true

SnapshotDeleteRequest

Consumes
  • application/json

Produces
  • application/json

Create snapshot manually.Operation may only be performed on working environments whose status is: ON, DEGRADED

POST /azure/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

PathParameter

svmName

true

string

PathParameter

volumeName

true

string

BodyParameter

body

Create snapshot request

true

SnapshotCreateRequest

Consumes
  • application/json

Produces
  • application/json

Move an existing volume.Operation may only be performed on working environments whose status is: ON, DEGRADED

POST /azure/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/move
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

PathParameter

svmName

true

string

PathParameter

volumeName

true

string

BodyParameter

body

true

VolumeMoveRequest

Consumes
  • application/json

Produces
  • application/json

Clones an existing volume.Operation may only be performed on working environments whose status is: ON, DEGRADED

POST /azure/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/clone
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

PathParameter

svmName

true

string

PathParameter

volumeName

true

string

BodyParameter

body

true

VolumeCloneRequest

Consumes
  • application/json

Produces
  • application/json

Quotes a new volume. Returns a resource quote needed to satisfy the requested volume.Operation may only be performed on working environments whose status is: ON, DEGRADED

POST /azure/ha/volumes/quote
Parameters
Type Name Description Required Schema Default

BodyParameter

body

Quote volume request

true

VsaVolumeQuoteRequest

Responses
HTTP Code Description Schema

default

success

VsaVolumeQuoteResponse

Consumes
  • application/json

Produces
  • application/json

Creates a new volume. If the properties aggregateName and maxNumOfDisksApprovedToAdd are not filled in, then the response will fail with a suggested aggregate name and the number of disks that will need to be created in order to fulfill the request.Operation may only be performed on working environments whose status is: ON, DEGRADED

POST /azure/ha/volumes
Parameters
Type Name Description Required Schema Default

QueryParameter

createAggregateIfNotFound

On create volume request, allow creating not-found aggregate

false

boolean

BodyParameter

body

Create volume request

true

VsaVolumeCreateRequest

Consumes
  • application/json

Produces
  • application/json

Retrieves volumes.Operation may only be performed on working environments whose status is: ON, DEGRADED

GET /azure/ha/volumes
Parameters
Type Name Description Required Schema Default

QueryParameter

workingEnvironmentId

Filter volumes by this working environment

true

string

Responses
HTTP Code Description Schema

default

success

VolumeResponse array

Consumes
  • application/json

Produces
  • application/json

Azure-ha:working-environments

Modify the svm name of the Cloud Volumes ONTAP

PUT /azure/ha/working-environments/{workingEnvironmentId}/svm
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

Svm name modification request

true

SvmNameModificationRequest

Consumes
  • application/json

Produces
  • application/json

Manually triggers subscription sync for all Cloud Volumes ONTAP working environments

POST /azure/ha/working-environments/sync-subscription
Consumes
  • application/json

Produces
  • application/json

Deletes an existing Cloud Volumes ONTAP working environment, including all Cloud resources created for this working environment (unless the localDelete flag is set to true)

DELETE /azure/ha/working-environments/{workingEnvironmentId}
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

QueryParameter

localDelete

If true, the Cloud Volumes ONTAP instance is not terminated in Cloud, but Cloud Manager no longer manages the working environment.

false

boolean

false

QueryParameter

forceDelete

If true, the working environment will be deleted even if it is part of one or more SnapMirror relationships.

false

boolean

false

Consumes
  • application/json

Produces
  • application/json

Retrieves an Cloud Volumes ONTAP working environment

GET /azure/ha/working-environments/{workingEnvironmentId}
Parameters
Type Name Description Required Schema Default

QueryParameter

fields

false

string

PathParameter

workingEnvironmentId

true

string

Responses
HTTP Code Description Schema

default

success

AzureVsaWorkingEnvironmentResponse

Consumes
  • application/json

Produces
  • application/json

Working Environment Cost And Usage

GET /azure/ha/working-environments/{workingEnvironmentId}/cost-and-usage
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

QueryParameter

start

cost and usage start period

false

string

QueryParameter

end

cost and usage end period

false

string

Responses
HTTP Code Description Schema

default

success

WorkingEnvironmentCostAndUsageResponse

Consumes
  • application/json

Produces
  • application/json

Retrieves a list of versions to which this Cloud Volumes ONTAP can be upgraded

GET /azure/ha/working-environments/{workingEnvironmentId}/occm-provided-upgrade-versions
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Responses
HTTP Code Description Schema

default

success

OntapUpdateImageMetadata array

Consumes
  • application/json

Produces
  • application/json

Sets the writing speed for Cloud Volumes ONTAP

PUT /azure/ha/working-environments/{workingEnvironmentId}/writing-speed
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

Writing speed request

true

WritingSpeedRequest

Consumes
  • application/json

Produces
  • application/json

Parses an uploaded Cloud license file

POST /azure/ha/working-environments/parse-license-file
Parameters
Type Name Description Required Schema Default

HeaderParameter

filename

Cloud license file name

false

string

BodyParameter

license

license

false

string

Responses
HTTP Code Description Schema

default

success

ProvidedLicenseResponse

Consumes
  • multipart/form-data

Produces
  • application/json

Sets the cluster password of a specific Cloud Volumes ONTAP

PUT /azure/ha/working-environments/{workingEnvironmentId}/set-password
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

QueryParameter

occmOnly

false

boolean

BodyParameter

body

Set password request

true

PasswordWrapper

Consumes
  • application/json

Produces
  • application/json

Setup NTP server

POST /azure/ha/working-environments/{workingEnvironmentId}/ntp
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

NTP Configuration request

true

NTPConfigurationRequest

Consumes
  • application/json

Produces
  • application/json

Retrieves images already installed on the Cloud Volumes ONTAP

GET /azure/ha/working-environments/{workingEnvironmentId}/ontap-available-images
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Responses
HTTP Code Description Schema

default

success

UpdateLocalImage array

Consumes
  • application/json

Produces
  • application/json

Set schedules for Cloud Volumes ONTAP

PUT /azure/ha/working-environments/{workingEnvironmentId}/schedules
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

Cloud Volumes ONTAP working environment update schedule request

true

VsaSchedulesRequest

Consumes
  • application/json

Produces
  • application/json

List start-stop schedules for Cloud Volumes ONTAP

GET /azure/ha/working-environments/{workingEnvironmentId}/schedules
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Responses
HTTP Code Description Schema

default

success

VsaSchedule array

Consumes
  • application/json

Produces
  • application/json

Enable capacity tiering

POST /azure/ha/working-environments/{workingEnvironmentId}/enable-capacity-tiering
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

Enable capacity tiering request

true

EnableCapacityTieringRequest

Consumes
  • application/json

Produces
  • application/json

Retrieves number of available ip addresses in the Cloud Volumes ONTAP working environment’s subnet

GET /azure/ha/working-environments/{workingEnvironmentId}/available-ips-in-subnet
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

Responses
HTTP Code Description Schema

default

success

AvailableIpsResponse

Consumes
  • application/json

Produces
  • application/json

Checks for the presence of non-persistent locks held on CIFs Sessions.

GET /azure/ha/working-environments/{workingEnvironmentId}/cifs-locks-exist
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

Responses
HTTP Code Description Schema

default

success

boolean

Consumes
  • application/json

Produces
  • application/json

Starts a specific Cloud Volumes ONTAP instance

POST /azure/ha/working-environments/{workingEnvironmentId}/start
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Consumes
  • application/json

Produces
  • application/json

Uploads a Cloud license file content on the provided Cloud Volumes ONTAP

POST /azure/ha/working-environments/{workingEnvironmentId}/upload-licenses
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

license file content request

true

LicenseFileContent

Consumes
  • application/json

Produces
  • application/json

Modify the net port broadcast domain mtu of the Cloud Volumes ONTAP

PUT /azure/ha/working-environments/{workingEnvironmentId}/networkOptimization
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

Use optimization

true

ChangeNetworkOptimizationRequest

Consumes
  • application/json

Produces
  • application/json

Returns true if a resource group with that name already exists, false otherwise

GET /azure/ha/working-environments/resource-group-exists/{resourceGroupName}
Parameters
Type Name Description Required Schema Default

PathParameter

resourceGroupName

resource group name

true

string

QueryParameter

subscriptionId

false

string

QueryParameter

cloudProviderAccountId

false

string

Responses
HTTP Code Description Schema

default

success

boolean

Consumes
  • application/json

Produces
  • application/json

Creates a new Azure HA Cloud Volumes ONTAP working environment.

POST /azure/ha/working-environments
Parameters
Type Name Description Required Schema Default

BodyParameter

body

Working environment

true

CreateAzureVSAWorkingEnvironmentRequest

Responses
HTTP Code Description Schema

default

success

AzureVsaWorkingEnvironmentResponse

Consumes
  • application/json

Produces
  • application/json

Retrieves Cloud Volumes ONTAP working environments visible to the currently logged in user

GET /azure/ha/working-environments
Parameters
Type Name Description Required Schema Default

QueryParameter

fields

false

string

QueryParameter

tenantId

false

string

Responses
HTTP Code Description Schema

default

success

AzureVsaWorkingEnvironmentResponse array

Consumes
  • application/json

Produces
  • application/json

Create snapshot policy

POST /azure/ha/working-environments/{workingEnvironmentId}/snapshot-policy
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

BodyParameter

body

Create snapshot policy request

true

SnapshotPolicyCreateRequest

Consumes
  • application/json

Produces
  • application/json

Stops a specific Cloud Volumes ONTAP instance

POST /azure/ha/working-environments/{workingEnvironmentId}/stop
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

QueryParameter

takeSnapshots

Take snapshots before stopping Cloud Volumes ONTAP

true

boolean

true

Consumes
  • application/json

Produces
  • application/json

Disable FPolicy for ransomeware files

PUT /azure/ha/working-environments/{workingEnvironmentId}/disable-fpolicy
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

Consumes
  • application/json

Produces
  • application/json

Activate snapshot policy assignment to all not protected rw volumes

PUT /azure/ha/working-environments/{workingEnvironmentId}/activate-snapshot-policy
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Consumes
  • application/json

Produces
  • application/json

Sets the instance type of a specific Cloud Volumes ONTAP

PUT /azure/ha/working-environments/{workingEnvironmentId}/license-instance-type
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

Instance type modification request

true

LicenseAndInstanceTypeModificationRequest

Consumes
  • application/json

Produces
  • application/json

Retrieves all license types and their associated instance types for a given Cloud Volumes ONTAP instance

GET /azure/ha/working-environments/{workingEnvironmentId}/license-instance-type
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Responses
HTTP Code Description Schema

default

success

LicenseAndInstanceType array

Consumes
  • application/json

Produces
  • application/json

Update Backup to S3 Service settings

PUT /azure/ha/working-environments/{workingEnvironmentId}/cbs-settings
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

BodyParameter

body

true

CbsInfo

Consumes
  • application/json

Produces
  • application/json

Setup a new CIFS using workgroup configuration to an existing Cloud Volumes ONTAP working environment

POST /azure/ha/working-environments/{workingEnvironmentId}/cifs-workgroup
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

CIFS Configuration request

true

CIFSWorkgroupConfigurationRequest

Consumes
  • application/json

Produces
  • application/json

Change tier level

POST /azure/ha/working-environments/{workingEnvironmentId}/change-tier-level
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

Change tier level request

true

ChangeTierLevelRequest

Consumes
  • application/json

Produces
  • application/json

Delete FPolicy for ransomeware files

DELETE /azure/ha/working-environments/{workingEnvironmentId}/fpolicy
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

Consumes
  • application/json

Produces
  • application/json

Activate FPolicy for ransomeware files

PUT /azure/ha/working-environments/{workingEnvironmentId}/activate-fpolicy
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

Consumes
  • application/json

Produces
  • application/json

Setup a new CIFS Configuration to an existing Cloud Volumes ONTAP working environment

POST /azure/ha/working-environments/{workingEnvironmentId}/cifs
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

CIFS Configuration request

true

CIFSConfigurationRequest

Consumes
  • application/json

Produces
  • application/json

Retrieves CIFS Configuration to an existing Cloud Volumes ONTAP working environment

GET /azure/ha/working-environments/{workingEnvironmentId}/cifs
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Responses
HTTP Code Description Schema

default

success

CIFSConfigurationResponse array

Consumes
  • application/json

Produces
  • application/json

Working Environment Ontap Saving

GET /azure/ha/working-environments/{workingEnvironmentId}/ontap-saving
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Responses
HTTP Code Description Schema

default

success

WorkingEnvironmentOntapSavingResponse

Consumes
  • application/json

Produces
  • application/json

Retrieves eligibility support status of a Cloud Volumes ONTAP system. Valid values - NSS_NOT_VALID, NOT_REGISTERED, IPA_PROBLEM, VALID, NSS_NOT_EXISTS, LICENSE_EXPIRED

GET /azure/ha/working-environments/{workingEnvironmentId}/update-eligibility
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Responses
HTTP Code Description Schema

200

success

EligibilityResponse

400

Working Environment must be ON or UPDATING in order to check eligibility

No Content

Consumes
  • application/json

Produces
  • application/json

Modify user tags for cloud resources of a given Cloud Volumes ONTAP instance

PUT /azure/ha/working-environments/{workingEnvironmentId}/user-tags
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

Modify user tags request

true

ModifyUserTagsRequest

Consumes
  • application/json

Produces
  • application/json

Retrieves editable tags for cloud resources of a given Cloud Volumes ONTAP instance

GET /azure/ha/working-environments/{workingEnvironmentId}/user-tags
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Responses
HTTP Code Description Schema

default

success

UserTagsResponse

Consumes
  • application/json

Produces
  • application/json

Change serial number of Cloud Volumes ONTAP

POST /azure/ha/working-environments/{workingEnvironmentId}/change-serial
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

Change serial number request

true

ChangeSerialNumberRequest

Consumes
  • application/json

Produces
  • application/json

Performs a complete image update operation on the single node of the specified Cloud Volumes ONTAP

POST /azure/ha/working-environments/{workingEnvironmentId}/update-image
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

Update system image request

true

UpdateSystemImageRequest

Consumes
  • application/json

Produces
  • application/json

Activate offbox configuration

PUT /azure/ha/working-environments/{workingEnvironmentId}/offbox
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Consumes
  • application/json

Produces
  • application/json

Registers a Cloud Volumes ONTAP system with NetApp

POST /azure/ha/working-environments/{workingEnvironmentId}/support-registration
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

QueryParameter

nssAccountId

false

string

Responses
HTTP Code Description Schema

default

success

SupportRegistrationResponse

Consumes
  • application/json

Produces
  • application/json

Retrieves the support registration status of a Cloud Volumes ONTAP system

GET /azure/ha/working-environments/{workingEnvironmentId}/support-registration
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Responses
HTTP Code Description Schema

default

success

SupportRegistrationResponse

Consumes
  • application/json

Produces
  • application/json

Updates Cloud Manager password of a specific Cloud Volumes ONTAP

PUT /azure/ha/working-environments/{workingEnvironmentId}/update-credentials
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

Update Cloud Manager password request

true

UpdateCredentialsRequest

Consumes
  • application/json

Produces
  • application/json

Retrieves action parameters used in create request of a given Cloud Volumes ONTAP instance

GET /azure/ha/working-environments/{workingEnvironmentId}/create-request-parameters
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Responses
HTTP Code Description Schema

default

success

CreateRequestParametersResponse

Consumes
  • application/json

Produces
  • application/json

Uploads a Cloud license file on the provided Cloud Volumes ONTAP

POST /azure/ha/working-environments/{workingEnvironmentId}/upload-license-file
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

HeaderParameter

filename

Cloud license file name

false

string

BodyParameter

license

license

false

string

Consumes
  • multipart/form-data

Produces
  • application/json

Azure-vsa:aggregates

Creates a new aggregate

POST /azure/vsa/aggregates
Parameters
Type Name Description Required Schema Default

BodyParameter

body

Create Aggregate Request

true

VsaAggregateCreateRequest

Consumes
  • application/json

Produces
  • application/json

Adds disks to an existing aggregate

POST /azure/vsa/aggregates/{workingEnvironmentId}/{aggregateName}/disks
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

PathParameter

aggregateName

Name of aggregate to be updated

true

string

BodyParameter

body

Add disk to aggregate request

true

AddDisksToAggregateRequest

Consumes
  • application/json

Produces
  • application/json

Retrieves aggregates.Operation may only be performed on working environments whose status is: ON, INITIALIZING, DEGRADED

GET /azure/vsa/aggregates/{workingEnvironmentId}
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

Responses
HTTP Code Description Schema

default

success

AggregateResponse array

Consumes
  • application/json

Produces
  • application/json

Deletes an existing aggregate

DELETE /azure/vsa/aggregates/{workingEnvironmentId}/{aggregateName}
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

PathParameter

aggregateName

Name of aggregate to be deleted

true

string

Consumes
  • application/json

Produces
  • application/json

Azure-vsa:discovery

Retrieves a list of discovered working environments visible to the current user in the specified Azure region.

GET /azure/vsa/discover
Parameters
Type Name Description Required Schema Default

QueryParameter

region

Region to discover working environments

true

string

QueryParameter

subscriptionId

false

string

QueryParameter

cloudProviderAccountId

false

string

Responses
HTTP Code Description Schema

default

success

DiscoveredAzureVSAResponse array

Consumes
  • application/json

Produces
  • application/json

Saves a previously discovered Cloud Volumes ONTAP working environment to the Cloud Manager database.

POST /azure/vsa/recover
Parameters
Type Name Description Required Schema Default

BodyParameter

body

Working environment

true

RecoverAzureVSARequest

Responses
HTTP Code Description Schema

default

success

AzureVsaWorkingEnvironmentResponse

Consumes
  • application/json

Produces
  • application/json

Azure-vsa:metadata

Retrieves supported Azure storage account types.

GET /azure/vsa/metadata/storage-account-types
Responses
HTTP Code Description Schema

default

success

AzureStorageAccountTypeResponse array

Consumes
  • application/json

Produces
  • application/json

Retrieves associated subscriptions.

GET /azure/vsa/metadata/associated-subscriptions
Parameters
Type Name Description Required Schema Default

QueryParameter

cloudProviderAccountId

false

string

Responses
HTTP Code Description Schema

default

success

AssociatedSubscription array

Consumes
  • application/json

Produces
  • application/json

Retrieves all Cloud Volumes ONTAP configurations.

GET /azure/vsa/metadata/permutations
Parameters
Type Name Description Required Schema Default

QueryParameter

region

Filter by region

false

string

QueryParameter

version

Filter by version

false

string

QueryParameter

license

Filter by license

false

string

QueryParameter

instance_type

Filter by instance type

false

string

QueryParameter

default_instance_type

Filter by default instance type

false

string

QueryParameter

feature

Filter by feature

false

string

QueryParameter

latest_only

Filter latest only

false

string

QueryParameter

marketplace_version

Filter by marketplace version

false

string

QueryParameter

marketplace_sku

Filter by marketplace sku

false

string

Responses
HTTP Code Description Schema

default

success

Configuration array

Consumes
  • application/json

Produces
  • application/json

Validates the current user is subscribed to Cloud Volumes ONTAP product in Azure marketplace.

POST /azure/vsa/metadata/validate-subscribed-to-ontap-cloud
Parameters
Type Name Description Required Schema Default

BodyParameter

body

Validate subscribed to Cloud Volumes ONTAP request

true

AzureValidateSubscribedToOntapCloudRequest

Responses
HTTP Code Description Schema

default

success

AzureValidateSubscribedToOntapCloudResponse

Consumes
  • application/json

Produces
  • application/json

Retrieves default snapshot policies available on a cluster

GET /azure/vsa/metadata/default-snapshot-policies
Responses
HTTP Code Description Schema

default

success

SnapshotPolicy array

Consumes
  • application/json

Produces
  • application/json

Retrieves supported capacity tiers for Azure disk types.

GET /azure/vsa/metadata/supported-capacity-tiers
Parameters
Type Name Description Required Schema Default

QueryParameter

region

true

string

QueryParameter

ontapVersion

true

string

QueryParameter

dataEncryptionType

true

string

QueryParameter

licenseType

true

string

QueryParameter

instanceType

true

string

QueryParameter

subscriptionId

false

string

QueryParameter

cloudProviderAccountId

false

string

Responses
HTTP Code Description Schema

default

success

SupportedCapacityTiers

Consumes
  • application/json

Produces
  • application/json

Retrieves Network Extended Info.

GET /azure/vsa/metadata/vnets
Parameters
Type Name Description Required Schema Default

QueryParameter

region

true

string

QueryParameter

subscriptionId

false

string

QueryParameter

cloudProviderAccountId

false

string

Responses
HTTP Code Description Schema

default

success

AzureNetworkExtendedResponse

Consumes
  • application/json

Produces
  • application/json

Retrieves Azure regions over which an Cloud Volumes ONTAP working environment may be created.

GET /azure/vsa/metadata/regions
Parameters
Type Name Description Required Schema Default

QueryParameter

fields

false

string

QueryParameter

subscriptionId

false

string

QueryParameter

cloudProviderAccountId

false

string

Responses
HTTP Code Description Schema

default

success

AzureRegionResponse array

Consumes
  • application/json

Produces
  • application/json

Retrieves the minimum number of required IPs for a Cloud Volumes ONTAP system.

GET /azure/vsa/metadata/network-requirements
Responses
HTTP Code Description Schema

default

success

AzureNetworkRequirementsResponse

Consumes
  • application/json

Produces
  • application/json

Retrieves packages configuration

GET /azure/vsa/metadata/packages
Responses
HTTP Code Description Schema

default

success

PackageInfoResponse array

Consumes
  • application/json

Produces
  • application/json

Retrieves instance types not supporting acceleration and capacity tiering

GET /azure/vsa/metadata/instance-types-not-supporting-acceleration-and-capacity-tiering
Responses
HTTP Code Description Schema

default

success

InstanceTypesNotSupportingAccelerationAndCapacityTieringResponse

Consumes
  • application/json

Produces
  • application/json

Retrieves all the Tag names.

GET /azure/vsa/metadata/tag-keys
Parameters
Type Name Description Required Schema Default

QueryParameter

subscriptionId

false

string

QueryParameter

cloudProviderAccountId

false

string

Responses
HTTP Code Description Schema

default

success

TagKeyResponse array

Consumes
  • application/json

Produces
  • application/json

Retrieves supported features

GET /azure/vsa/metadata/supported-features
Parameters
Type Name Description Required Schema Default

QueryParameter

region

true

string

QueryParameter

ontapVersion

true

string

QueryParameter

dataEncryptionType

true

string

QueryParameter

licenseType

true

string

QueryParameter

instanceType

true

string

Responses
HTTP Code Description Schema

default

success

SupportedFeaturesResponse

Consumes
  • application/json

Produces
  • application/json

Azure-vsa:volumes

Delete snapshot manually.Operation may only be performed on working environments whose status is: ON, DEGRADED

DELETE /azure/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

PathParameter

svmName

true

string

PathParameter

volumeName

true

string

BodyParameter

body

Create snapshot request

true

SnapshotDeleteRequest

Consumes
  • application/json

Produces
  • application/json

Create snapshot manually.Operation may only be performed on working environments whose status is: ON, DEGRADED

POST /azure/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

PathParameter

svmName

true

string

PathParameter

volumeName

true

string

BodyParameter

body

Create snapshot request

true

SnapshotCreateRequest

Consumes
  • application/json

Produces
  • application/json

Quotes a new volume. Returns a resource quote needed to satisfy the requested volume.Operation may only be performed on working environments whose status is: ON, DEGRADED

POST /azure/vsa/volumes/quote
Parameters
Type Name Description Required Schema Default

BodyParameter

body

Quote volume request

true

VsaVolumeQuoteRequest

Responses
HTTP Code Description Schema

default

success

VsaVolumeQuoteResponse

Consumes
  • application/json

Produces
  • application/json

Return a list of snapshot descriptions for the volume.Operation may only be performed on working environments whose status is: ON, DEGRADED

GET /azure/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshots
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

PathParameter

svmName

true

string

PathParameter

volumeName

true

string

Responses
HTTP Code Description Schema

default

success

[SnapshotResponse] array

Consumes
  • application/json

Produces
  • application/json

Creates a new volume. If the properties aggregateName and maxNumOfDisksApprovedToAdd are not filled in, then the response will fail with a suggested aggregate name and the number of disks that will need to be created in order to fulfill the request.Operation may only be performed on working environments whose status is: ON, DEGRADED

POST /azure/vsa/volumes
Parameters
Type Name Description Required Schema Default

QueryParameter

createAggregateIfNotFound

On create volume request, allow creating not-found aggregate

false

boolean

BodyParameter

body

Create volume request

true

VsaVolumeCreateRequest

Consumes
  • application/json

Produces
  • application/json

Retrieves volumes.Operation may only be performed on working environments whose status is: ON, DEGRADED

GET /azure/vsa/volumes
Parameters
Type Name Description Required Schema Default

QueryParameter

workingEnvironmentId

Filter volumes by this working environment

true

string

Responses
HTTP Code Description Schema

default

success

VolumeResponse array

Consumes
  • application/json

Produces
  • application/json

Move an existing volume.Operation may only be performed on working environments whose status is: ON, DEGRADED

POST /azure/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/move
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

PathParameter

svmName

true

string

PathParameter

volumeName

true

string

BodyParameter

body

true

VolumeMoveRequest

Consumes
  • application/json

Produces
  • application/json

Clones an existing volume.Operation may only be performed on working environments whose status is: ON, DEGRADED

POST /azure/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/clone
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

PathParameter

svmName

true

string

PathParameter

volumeName

true

string

BodyParameter

body

true

VolumeCloneRequest

Consumes
  • application/json

Produces
  • application/json

Change underlying volume tier.Operation may only be performed on working environments whose status is: ON, DEGRADED

POST /azure/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/change-tier
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

PathParameter

svmName

true

string

PathParameter

volumeName

true

string

BodyParameter

body

true

ChangeVolumeTierRequest

Consumes
  • application/json

Produces
  • application/json

Deletes an existing volume.Operation may only be performed on working environments whose status is: ON, DEGRADED

DELETE /azure/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

PathParameter

svmName

true

string

PathParameter

volumeName

true

string

Consumes
  • application/json

Produces
  • application/json

Modify an existing volume.Operation may only be performed on working environments whose status is: ON, DEGRADED

PUT /azure/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

PathParameter

svmName

true

string

PathParameter

volumeName

true

ref

BodyParameter

body

Modify volume request

true

VolumeModifyRequest

Consumes
  • application/json

Produces
  • application/json

Azure-vsa:working-environments

Retrieves action parameters used in create request of a given Cloud Volumes ONTAP instance

GET /azure/vsa/working-environments/{workingEnvironmentId}/create-request-parameters
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Responses
HTTP Code Description Schema

default

success

CreateRequestParametersResponse

Consumes
  • application/json

Produces
  • application/json

Registers a Cloud Volumes ONTAP system with NetApp

POST /azure/vsa/working-environments/{workingEnvironmentId}/support-registration
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

QueryParameter

nssAccountId

false

string

Responses
HTTP Code Description Schema

default

success

SupportRegistrationResponse

Consumes
  • application/json

Produces
  • application/json

Retrieves the support registration status of a Cloud Volumes ONTAP system

GET /azure/vsa/working-environments/{workingEnvironmentId}/support-registration
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Responses
HTTP Code Description Schema

default

success

SupportRegistrationResponse

Consumes
  • application/json

Produces
  • application/json

Updates Cloud Manager password of a specific Cloud Volumes ONTAP

PUT /azure/vsa/working-environments/{workingEnvironmentId}/update-credentials
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

Update Cloud Manager password request

true

UpdateCredentialsRequest

Consumes
  • application/json

Produces
  • application/json

Creates a new Cloud Volumes ONTAP working environment.

POST /azure/vsa/working-environments
Parameters
Type Name Description Required Schema Default

BodyParameter

body

Working environment

true

CreateAzureVSAWorkingEnvironmentRequest

Responses
HTTP Code Description Schema

default

success

AzureVsaWorkingEnvironmentResponse

Consumes
  • application/json

Produces
  • application/json

Retrieves Cloud Volumes ONTAP working environments visible to the currently logged in user

GET /azure/vsa/working-environments
Parameters
Type Name Description Required Schema Default

QueryParameter

fields

false

string

QueryParameter

tenantId

false

string

Responses
HTTP Code Description Schema

default

success

AzureVsaWorkingEnvironmentResponse array

Consumes
  • application/json

Produces
  • application/json

Stops a specific Cloud Volumes ONTAP instance

POST /azure/vsa/working-environments/{workingEnvironmentId}/stop
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

QueryParameter

takeSnapshots

Take snapshots before stopping Cloud Volumes ONTAP

true

boolean

true

Consumes
  • application/json

Produces
  • application/json

Uploads a Cloud license file on the provided Cloud Volumes ONTAP

POST /azure/vsa/working-environments/{workingEnvironmentId}/upload-license-file
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

HeaderParameter

filename

Cloud license file name

false

string

BodyParameter

license

license

false

string

Consumes
  • multipart/form-data

Produces
  • application/json

Set schedules for Cloud Volumes ONTAP

PUT /azure/vsa/working-environments/{workingEnvironmentId}/schedules
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

Cloud Volumes ONTAP working environment update schedule request

true

VsaSchedulesRequest

Consumes
  • application/json

Produces
  • application/json

List start-stop schedules for Cloud Volumes ONTAP

GET /azure/vsa/working-environments/{workingEnvironmentId}/schedules
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Responses
HTTP Code Description Schema

default

success

VsaSchedule array

Consumes
  • application/json

Produces
  • application/json

Disable FPolicy for ransomeware files

PUT /azure/vsa/working-environments/{workingEnvironmentId}/disable-fpolicy
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

Consumes
  • application/json

Produces
  • application/json

Retrieves images already installed on the Cloud Volumes ONTAP

GET /azure/vsa/working-environments/{workingEnvironmentId}/ontap-available-images
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Responses
HTTP Code Description Schema

default

success

UpdateLocalImage array

Consumes
  • application/json

Produces
  • application/json

Sets the cluster password of a specific Cloud Volumes ONTAP

PUT /azure/vsa/working-environments/{workingEnvironmentId}/set-password
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

QueryParameter

occmOnly

false

boolean

BodyParameter

body

Set password request

true

PasswordWrapper

Consumes
  • application/json

Produces
  • application/json

Change tier level

POST /azure/vsa/working-environments/{workingEnvironmentId}/change-tier-level
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

Change tier level request

true

ChangeTierLevelRequest

Consumes
  • application/json

Produces
  • application/json

Setup a new CIFS Configuration to an existing Cloud Volumes ONTAP working environment

POST /azure/vsa/working-environments/{workingEnvironmentId}/cifs
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

CIFS Configuration request

true

CIFSConfigurationRequest

Consumes
  • application/json

Produces
  • application/json

Retrieves CIFS Configuration to an existing Cloud Volumes ONTAP working environment

GET /azure/vsa/working-environments/{workingEnvironmentId}/cifs
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Responses
HTTP Code Description Schema

default

success

CIFSConfigurationResponse array

Consumes
  • application/json

Produces
  • application/json

Enable capacity tiering

POST /azure/vsa/working-environments/{workingEnvironmentId}/enable-capacity-tiering
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

Enable capacity tiering request

true

EnableCapacityTieringRequest

Consumes
  • application/json

Produces
  • application/json

Retrieves number of available ip addresses in the Cloud Volumes ONTAP working environment’s subnet

GET /azure/vsa/working-environments/{workingEnvironmentId}/available-ips-in-subnet
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

Responses
HTTP Code Description Schema

default

success

AvailableIpsResponse

Consumes
  • application/json

Produces
  • application/json

Returns true if a resource group with that name already exists, false otherwise

GET /azure/vsa/working-environments/resource-group-exists/{resourceGroupName}
Parameters
Type Name Description Required Schema Default

PathParameter

resourceGroupName

resource group name

true

string

QueryParameter

subscriptionId

false

string

QueryParameter

cloudProviderAccountId

false

string

Responses
HTTP Code Description Schema

default

success

boolean

Consumes
  • application/json

Produces
  • application/json

Performs a complete image update operation on the single node of the specified Cloud Volumes ONTAP

POST /azure/vsa/working-environments/{workingEnvironmentId}/update-image
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

Update system image request

true

UpdateSystemImageRequest

Consumes
  • application/json

Produces
  • application/json

Setup a new CIFS using workgroup configuration to an existing Cloud Volumes ONTAP working environment

POST /azure/vsa/working-environments/{workingEnvironmentId}/cifs-workgroup
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

CIFS Configuration request

true

CIFSWorkgroupConfigurationRequest

Consumes
  • application/json

Produces
  • application/json

Delete FPolicy for ransomeware files

DELETE /azure/vsa/working-environments/{workingEnvironmentId}/fpolicy
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

Consumes
  • application/json

Produces
  • application/json

Change serial number of Cloud Volumes ONTAP

POST /azure/vsa/working-environments/{workingEnvironmentId}/change-serial
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

Change serial number request

true

ChangeSerialNumberRequest

Consumes
  • application/json

Produces
  • application/json

Activate FPolicy for ransomeware files

PUT /azure/vsa/working-environments/{workingEnvironmentId}/activate-fpolicy
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

Consumes
  • application/json

Produces
  • application/json

Update Backup to S3 Service settings

PUT /azure/vsa/working-environments/{workingEnvironmentId}/cbs-settings
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

BodyParameter

body

true

CbsInfo

Consumes
  • application/json

Produces
  • application/json

Retrieves eligibility support status of a Cloud Volumes ONTAP system. Valid values - NSS_NOT_VALID, NOT_REGISTERED, IPA_PROBLEM, VALID, NSS_NOT_EXISTS, LICENSE_EXPIRED

GET /azure/vsa/working-environments/{workingEnvironmentId}/update-eligibility
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Responses
HTTP Code Description Schema

200

success

EligibilityResponse

400

Working Environment must be ON or UPDATING in order to check eligibility

No Content

Consumes
  • application/json

Produces
  • application/json

Activate offbox configuration

PUT /azure/vsa/working-environments/{workingEnvironmentId}/offbox
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Consumes
  • application/json

Produces
  • application/json

Manually triggers subscription sync for all Cloud Volumes ONTAP working environments

POST /azure/vsa/working-environments/sync-subscription
Consumes
  • application/json

Produces
  • application/json

Retrieves a list of versions to which this Cloud Volumes ONTAP can be upgraded

GET /azure/vsa/working-environments/{workingEnvironmentId}/occm-provided-upgrade-versions
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Responses
HTTP Code Description Schema

default

success

OntapUpdateImageMetadata array

Consumes
  • application/json

Produces
  • application/json

Working Environment Cost And Usage

GET /azure/vsa/working-environments/{workingEnvironmentId}/cost-and-usage
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

QueryParameter

start

cost and usage start period

false

string

QueryParameter

end

cost and usage end period

false

string

Responses
HTTP Code Description Schema

default

success

WorkingEnvironmentCostAndUsageResponse

Consumes
  • application/json

Produces
  • application/json

Working Environment Ontap Saving

GET /azure/vsa/working-environments/{workingEnvironmentId}/ontap-saving
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Responses
HTTP Code Description Schema

default

success

WorkingEnvironmentOntapSavingResponse

Consumes
  • application/json

Produces
  • application/json

Setup NTP server

POST /azure/vsa/working-environments/{workingEnvironmentId}/ntp
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

NTP Configuration request

true

NTPConfigurationRequest

Consumes
  • application/json

Produces
  • application/json

Parses an uploaded Cloud license file

POST /azure/vsa/working-environments/parse-license-file
Parameters
Type Name Description Required Schema Default

HeaderParameter

filename

Cloud license file name

false

string

BodyParameter

license

license

false

string

Responses
HTTP Code Description Schema

default

success

ProvidedLicenseResponse

Consumes
  • multipart/form-data

Produces
  • application/json

Starts a specific Cloud Volumes ONTAP instance

POST /azure/vsa/working-environments/{workingEnvironmentId}/start
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Consumes
  • application/json

Produces
  • application/json

Modify user tags for cloud resources of a given Cloud Volumes ONTAP instance

PUT /azure/vsa/working-environments/{workingEnvironmentId}/user-tags
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

Modify user tags request

true

ModifyUserTagsRequest

Consumes
  • application/json

Produces
  • application/json

Retrieves editable tags for cloud resources of a given Cloud Volumes ONTAP instance

GET /azure/vsa/working-environments/{workingEnvironmentId}/user-tags
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Responses
HTTP Code Description Schema

default

success

UserTagsResponse

Consumes
  • application/json

Produces
  • application/json

Sets the instance type of a specific Cloud Volumes ONTAP

PUT /azure/vsa/working-environments/{workingEnvironmentId}/license-instance-type
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

Instance type modification request

true

LicenseAndInstanceTypeModificationRequest

Consumes
  • application/json

Produces
  • application/json

Retrieves all license types and their associated instance types for a given Cloud Volumes ONTAP instance

GET /azure/vsa/working-environments/{workingEnvironmentId}/license-instance-type
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Responses
HTTP Code Description Schema

default

success

LicenseAndInstanceType array

Consumes
  • application/json

Produces
  • application/json

Activate snapshot policy assignment to all not protected rw volumes

PUT /azure/vsa/working-environments/{workingEnvironmentId}/activate-snapshot-policy
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Consumes
  • application/json

Produces
  • application/json

Deletes an existing Cloud Volumes ONTAP working environment, including all Cloud resources created for this working environment (unless the localDelete flag is set to true)

DELETE /azure/vsa/working-environments/{workingEnvironmentId}
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

QueryParameter

localDelete

If true, the Cloud Volumes ONTAP instance is not terminated in Cloud, but Cloud Manager no longer manages the working environment.

false

boolean

false

QueryParameter

forceDelete

If true, the working environment will be deleted even if it is part of one or more SnapMirror relationships.

false

boolean

false

Consumes
  • application/json

Produces
  • application/json

Retrieves an Cloud Volumes ONTAP working environment

GET /azure/vsa/working-environments/{workingEnvironmentId}
Parameters
Type Name Description Required Schema Default

QueryParameter

fields

false

string

PathParameter

workingEnvironmentId

true

string

Responses
HTTP Code Description Schema

default

success

AzureVsaWorkingEnvironmentResponse

Consumes
  • application/json

Produces
  • application/json

Modify the svm name of the Cloud Volumes ONTAP

PUT /azure/vsa/working-environments/{workingEnvironmentId}/svm
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

Svm name modification request

true

SvmNameModificationRequest

Consumes
  • application/json

Produces
  • application/json

Sets the writing speed for Cloud Volumes ONTAP

PUT /azure/vsa/working-environments/{workingEnvironmentId}/writing-speed
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

Writing speed request

true

WritingSpeedRequest

Consumes
  • application/json

Produces
  • application/json

Uploads a Cloud license file content on the provided Cloud Volumes ONTAP

POST /azure/vsa/working-environments/{workingEnvironmentId}/upload-licenses
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

license file content request

true

LicenseFileContent

Consumes
  • application/json

Produces
  • application/json

Modify the net port broadcast domain mtu of the Cloud Volumes ONTAP

PUT /azure/vsa/working-environments/{workingEnvironmentId}/networkOptimization
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

Use optimization

true

ChangeNetworkOptimizationRequest

Consumes
  • application/json

Produces
  • application/json

Create snapshot policy

POST /azure/vsa/working-environments/{workingEnvironmentId}/snapshot-policy
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

BodyParameter

body

Create snapshot policy request

true

SnapshotPolicyCreateRequest

Consumes
  • application/json

Produces
  • application/json

Cbs

Retrieves volume information for restore from S3 backup to the existing working environment.Operation may only be performed on working environments whose status is: ON, DEGRADED

GET /cbs/volume-info-for-restore
Parameters
Type Name Description Required Schema Default

QueryParameter

fileSystemId

File System Id

true

string

QueryParameter

backupName

Backup Name

true

string

QueryParameter

workingEnvironmentId

Destination working environment Id

true

string

Responses
HTTP Code Description Schema

default

success

CbsVolumeInfoForRestore

Consumes
  • application/json

Produces
  • application/json

Add scheduled volume backup to S3 Service.Operation may only be performed on working environments whose status is: ON, DEGRADED

POST /cbs/backup
Parameters
Type Name Description Required Schema Default

BodyParameter

body

Request for backup to CBS

true

ScheduledBackupToCbsRequest

Consumes
  • application/json

Produces
  • application/json

Restores a S3 backup to a new volume.Operation may only be performed on working environments whose status is: ON, DEGRADED

POST /cbs/restore
Parameters
Type Name Description Required Schema Default

BodyParameter

body

Restore S3 backup request

true

RestoreCbsBackupRequest

Consumes
  • application/json

Produces
  • application/json

Delete a list of S3 backups.

DELETE /cbs/backups
Parameters
Type Name Description Required Schema Default

QueryParameter

deleteAll

Delete All Backups

true

boolean

BodyParameter

body

Delete S3 backup request

true

DeleteCbsBackupRequest

Consumes
  • application/json

Produces
  • application/json

Retrieves list of volumes with S3 backups information.

GET /cbs/volumes
Parameters
Type Name Description Required Schema Default

QueryParameter

offset

offset

false

integer (int32)

QueryParameter

limit

limit

false

integer (int32)

QueryParameter

workspaceId

Filter volumes by workspace Id. Required for Workspace Admin

false

string

Responses
HTTP Code Description Schema

default

success

CbsVolumeList

Consumes
  • application/json

Produces
  • application/json

Cloudsync

Retrieves AWS user Key Pairs for working environment’s account and region.

GET /cloudsync/key-pairs-by-vsa/{workingEnvironmentId}
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of VSA working environment

true

string

Responses
HTTP Code Description Schema

default

success

string array

Consumes
  • application/json

Produces
  • application/json

Delete sync of OnPrem working environment to Cloud Sync service.Operation may only be performed on working environments whose status is: ON

DELETE /cloudsync/sync/onprem/{workingEnvironmentId}
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of OnPrem working environment

true

string

Consumes
  • application/json

Produces
  • application/json

Create sync of OnPrem working environment with Cloud Sync service.Operation may only be performed on working environments whose status is: ON

POST /cloudsync/sync/onprem/{workingEnvironmentId}
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of OnPrem working environment

true

string

BodyParameter

body

Create sync request

true

CreateSyncRequest

Consumes
  • application/json

Produces
  • application/json

Delete Cloud Sync relationship from an OnPrem volume.Operation may only be performed on working environments whose status is: ON

DELETE /cloudsync/relationship/onprem/{workingEnvironmentId}/{volumeName}
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of OnPrem working environment

true

string

PathParameter

volumeName

true

ref

Consumes
  • application/json

Produces
  • application/json

Add Cloud Sync relationship to an OnPrem volume.Operation may only be performed on working environments whose status is: ON

POST /cloudsync/relationship/onprem/{workingEnvironmentId}/{volumeName}
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of OnPrem working environment

true

string

PathParameter

volumeName

true

ref

Consumes
  • application/json

Produces
  • application/json

Delete Cloud Sync relationship from a VSA volume.Operation may only be performed on working environments whose status is: ON, DEGRADED

DELETE /cloudsync/relationship/{workingEnvironmentId}/{volumeName}
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of VSA working environment

true

string

PathParameter

volumeName

true

ref

Consumes
  • application/json

Produces
  • application/json

Add Cloud Sync relationship to a VSA volume.Operation may only be performed on working environments whose status is: ON, DEGRADED

POST /cloudsync/relationship/{workingEnvironmentId}/{volumeName}
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of VSA working environment

true

string

PathParameter

volumeName

true

ref

Consumes
  • application/json

Produces
  • application/json

Retrieve all S3 buckets.

GET /cloudsync/buckets
Parameters
Type Name Description Required Schema Default

QueryParameter

userId

User ID of the working environment creator

true

string

Responses
HTTP Code Description Schema

default

success

S3BucketInfo array

Consumes
  • application/json

Produces
  • application/json

List S3 bucket’s sub directories.

GET /cloudsync/buckets/{bucketName}/sub-directories
Parameters
Type Name Description Required Schema Default

QueryParameter

userId

User ID of the working environment creator

true

string

QueryParameter

fullPath

Full path to list sub directories

false

string

PathParameter

bucketName

Bucket name to get sub directories from

true

string

Responses
HTTP Code Description Schema

default

success

BucketInformation

Consumes
  • application/json

Produces
  • application/json

Delete sync of VSA working environment to Cloud Sync service.Operation may only be performed on working environments whose status is: ON, DEGRADED

DELETE /cloudsync/sync/{workingEnvironmentId}
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of VSA working environment

true

string

Consumes
  • application/json

Produces
  • application/json

Create sync of VSA working environment with Cloud Sync service.Operation may only be performed on working environments whose status is: ON, DEGRADED

POST /cloudsync/sync/{workingEnvironmentId}
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of VSA working environment

true

string

BodyParameter

body

Create sync request

true

CreateSyncRequest

Consumes
  • application/json

Produces
  • application/json

List S3 bucket’s sub directories in working environment’s account.

GET /cloudsync/buckets/{bucketName}/sub-directories/{workingEnvironmentId}
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of VSA working environment

true

string

QueryParameter

fullPath

Full path to list sub directories

false

string

PathParameter

bucketName

Bucket name to get sub directories from

true

string

Responses
HTTP Code Description Schema

default

success

BucketInformation

Consumes
  • application/json

Produces
  • application/json

Retrieves VPCs for working environment’s account and region.

GET /cloudsync/vpcs-by-vsa/{workingEnvironmentId}
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of VSA working environment

true

string

Responses
HTTP Code Description Schema

default

success

VpcExtendedResponse array

Consumes
  • application/json

Produces
  • application/json

Retrieve all S3 buckets in working environment’s account.

GET /cloudsync/buckets/{workingEnvironmentId}
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of VSA working environment

true

string

Responses
HTTP Code Description Schema

default

success

S3BucketInfo array

Consumes
  • application/json

Produces
  • application/json

Get Cloud Sync Service url, according to the current environment.

GET /cloudsync/service-url
Responses
HTTP Code Description Schema

default

success

ServiceUrl

Consumes
  • application/json

Produces
  • application/json

Cvs

Get CVS Credentials.

GET /cvs/credentials
Responses
HTTP Code Description Schema

default

success

[Object]

Consumes
  • application/json

Produces
  • application/json

discover a CVS system.

POST /cvs/discover
Parameters
Type Name Description Required Schema Default

BodyParameter

body

true

CvsAccountRequest

Responses
HTTP Code Description Schema

default

success

CvsAccountResponse

Consumes
  • application/json

Produces
  • application/json

Retrieve CVS system by public Id.

GET /cvs/retrieve/{cloudProviderAccountId}
Parameters
Type Name Description Required Schema Default

PathParameter

cloudProviderAccountId

Public Id of Cvs system

true

string

Responses
HTTP Code Description Schema

default

success

CvsAccountResponse

Consumes
  • application/json

Produces
  • application/json

Retrieves CVS regions on AWS.

GET /cvs/regions
Responses
HTTP Code Description Schema

default

success

[CvsRegionResponse] array

Consumes
  • application/json

Produces
  • application/json

Gcp-vsa:aggregates

Creates a new aggregate

POST /gcp/vsa/aggregates
Parameters
Type Name Description Required Schema Default

BodyParameter

body

Create Aggregate Request

true

VsaAggregateCreateRequest

Consumes
  • application/json

Produces
  • application/json

Adds disks to an existing aggregate

POST /gcp/vsa/aggregates/{workingEnvironmentId}/{aggregateName}/disks
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

PathParameter

aggregateName

Name of aggregate to be updated

true

string

BodyParameter

body

Add disk to aggregate request

true

AddDisksToAggregateRequest

Consumes
  • application/json

Produces
  • application/json

Retrieves aggregates.Operation may only be performed on working environments whose status is: ON, INITIALIZING, DEGRADED

GET /gcp/vsa/aggregates/{workingEnvironmentId}
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

Responses
HTTP Code Description Schema

default

success

AggregateResponse array

Consumes
  • application/json

Produces
  • application/json

Deletes an existing aggregate

DELETE /gcp/vsa/aggregates/{workingEnvironmentId}/{aggregateName}
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

PathParameter

aggregateName

Name of aggregate to be deleted

true

string

Consumes
  • application/json

Produces
  • application/json

Gcp-vsa:discovery

Saves a previously discovered Cloud Volumes ONTAP working environment to the Cloud Manager database.

POST /gcp/vsa/recover
Parameters
Type Name Description Required Schema Default

BodyParameter

body

Working environment

true

RecoverGcpVsaRequest

Responses
HTTP Code Description Schema

default

success

GcpVsaWorkingEnvironmentResponse

Consumes
  • application/json

Produces
  • application/json

Retrieves a list of discovered working environments visible to the current user in the specified Gcp zone.

GET /gcp/vsa/discover
Parameters
Type Name Description Required Schema Default

QueryParameter

region

Region to discover working environments

true

string

QueryParameter

project

Project to discover working environments

false

string

Responses
HTTP Code Description Schema

default

success

DiscoveredGcpVsaResponse array

Consumes
  • application/json

Produces
  • application/json

Gcp-vsa:metadata

Retrieves default snapshot policies available on a cluster

GET /gcp/vsa/metadata/default-snapshot-policies
Responses
HTTP Code Description Schema

default

success

SnapshotPolicy array

Consumes
  • application/json

Produces
  • application/json

Retrieves GCP encryption keys for specific region.

GET /gcp/vsa/metadata/gcp-encryption-keys
Parameters
Type Name Description Required Schema Default

QueryParameter

region

true

string

QueryParameter

project

true

string

Responses
HTTP Code Description Schema

default

success

GcpEncryptionKey array

Consumes
  • application/json

Produces
  • application/json

Retrieves all Cloud Volumes ONTAP configurations.

GET /gcp/vsa/metadata/permutations
Parameters
Type Name Description Required Schema Default

QueryParameter

region

Filter by region

false

string

QueryParameter

version

Filter by version

false

string

QueryParameter

license

Filter by license

false

string

QueryParameter

machine_type

Filter by machine type

false

string

QueryParameter

latest_only

Filter latest only

false

string

Responses
HTTP Code Description Schema

default

success

Configuration array

Consumes
  • application/json

Produces
  • application/json

Retrieves list of Projects that the caller has permission on.

GET /gcp/vsa/metadata/projects
Responses
HTTP Code Description Schema

default

success

GcpProjectsResponse

Consumes
  • application/json

Produces
  • application/json

Retrieves supported disk types.

GET /gcp/vsa/metadata/gcp-disk-types
Responses
HTTP Code Description Schema

default

success

GcpDiskTypeResponse array

Consumes
  • application/json

Produces
  • application/json

Retrieves GCP regions over which an Cloud Volumes ONTAP working environment may be created.

GET /gcp/vsa/metadata/regions
Parameters
Type Name Description Required Schema Default

QueryParameter

project

false

string

QueryParameter

fields

false

string

Responses
HTTP Code Description Schema

default

success

GcpRegionResponse array

Consumes
  • application/json

Produces
  • application/json

Retrieves supported capacity tiers for gcp disk types.

GET /gcp/vsa/metadata/supported-capacity-tiers
Parameters
Type Name Description Required Schema Default

QueryParameter

region

true

string

QueryParameter

ontapVersion

true

string

QueryParameter

dataEncryptionType

true

string

QueryParameter

licenseType

true

string

QueryParameter

instanceType

true

string

Responses
HTTP Code Description Schema

default

success

SupportedCapacityTiers

Consumes
  • application/json

Produces
  • application/json

Retrieves all the Labels in the given project Id and zone.

GET /gcp/vsa/metadata/tag-keys
Parameters
Type Name Description Required Schema Default

QueryParameter

projectId

true

string

QueryParameter

zone

true

string

Responses
HTTP Code Description Schema

default

success

TagKeyResponse array

Consumes
  • application/json

Produces
  • application/json

Retrieves instance types not supporting acceleration and capacity tiering

GET /gcp/vsa/metadata/instance-types-not-supporting-acceleration-and-capacity-tiering
Responses
HTTP Code Description Schema

default

success

InstanceTypesNotSupportingAccelerationAndCapacityTieringResponse

Consumes
  • application/json

Produces
  • application/json

Retrieves packages configuration

GET /gcp/vsa/metadata/packages
Responses
HTTP Code Description Schema

default

success

PackageInfoResponse array

Consumes
  • application/json

Produces
  • application/json

Retrieves supported features

GET /gcp/vsa/metadata/supported-features
Parameters
Type Name Description Required Schema Default

QueryParameter

region

true

string

QueryParameter

ontapVersion

true

string

QueryParameter

dataEncryptionType

true

string

QueryParameter

licenseType

true

string

QueryParameter

instanceType

true

string

Responses
HTTP Code Description Schema

default

success

SupportedFeaturesResponse

Consumes
  • application/json

Produces
  • application/json

Retrieves the minimum number of required IPs for a Cloud Volumes ONTAP system.

GET /gcp/vsa/metadata/network-requirements
Responses
HTTP Code Description Schema

default

success

GcpNetworkRequirementsResponse

Consumes
  • application/json

Produces
  • application/json

Gcp-vsa:volumes

Deletes an existing volume.Operation may only be performed on working environments whose status is: ON, DEGRADED

DELETE /gcp/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

PathParameter

svmName

true

string

PathParameter

volumeName

true

string

Consumes
  • application/json

Produces
  • application/json

Modify an existing volume.Operation may only be performed on working environments whose status is: ON, DEGRADED

PUT /gcp/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

PathParameter

svmName

true

string

PathParameter

volumeName

true

ref

BodyParameter

body

Modify volume request

true

VolumeModifyRequest

Consumes
  • application/json

Produces
  • application/json

Return a list of snapshot descriptions for the volume.Operation may only be performed on working environments whose status is: ON, DEGRADED

GET /gcp/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshots
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

PathParameter

svmName

true

string

PathParameter

volumeName

true

string

Responses
HTTP Code Description Schema

default

success

[SnapshotResponse] array

Consumes
  • application/json

Produces
  • application/json

Clones an existing volume.Operation may only be performed on working environments whose status is: ON, DEGRADED

POST /gcp/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/clone
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

PathParameter

svmName

true

string

PathParameter

volumeName

true

string

BodyParameter

body

true

VolumeCloneRequest

Consumes
  • application/json

Produces
  • application/json

Change underlying volume tier.Operation may only be performed on working environments whose status is: ON, DEGRADED

POST /gcp/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/change-tier
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

PathParameter

svmName

true

string

PathParameter

volumeName

true

string

BodyParameter

body

true

ChangeVolumeTierRequest

Consumes
  • application/json

Produces
  • application/json

Creates a new volume. If the properties aggregateName and maxNumOfDisksApprovedToAdd are not filled in, then the response will fail with a suggested aggregate name and the number of disks that will need to be created in order to fulfill the request.Operation may only be performed on working environments whose status is: ON, DEGRADED

POST /gcp/vsa/volumes
Parameters
Type Name Description Required Schema Default

QueryParameter

createAggregateIfNotFound

On create volume request, allow creating not-found aggregate

false

boolean

BodyParameter

body

Create volume request

true

VsaVolumeCreateRequest

Consumes
  • application/json

Produces
  • application/json

Retrieves volumes.Operation may only be performed on working environments whose status is: ON, DEGRADED

GET /gcp/vsa/volumes
Parameters
Type Name Description Required Schema Default

QueryParameter

workingEnvironmentId

Filter volumes by this working environment

true

string

Responses
HTTP Code Description Schema

default

success

VolumeResponse array

Consumes
  • application/json

Produces
  • application/json

Quotes a new volume. Returns a resource quote needed to satisfy the requested volume.Operation may only be performed on working environments whose status is: ON, DEGRADED

POST /gcp/vsa/volumes/quote
Parameters
Type Name Description Required Schema Default

BodyParameter

body

Quote volume request

true

VsaVolumeQuoteRequest

Responses
HTTP Code Description Schema

default

success

VsaVolumeQuoteResponse

Consumes
  • application/json

Produces
  • application/json

Delete snapshot manually.Operation may only be performed on working environments whose status is: ON, DEGRADED

DELETE /gcp/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

PathParameter

svmName

true

string

PathParameter

volumeName

true

string

BodyParameter

body

Create snapshot request

true

SnapshotDeleteRequest

Consumes
  • application/json

Produces
  • application/json

Create snapshot manually.Operation may only be performed on working environments whose status is: ON, DEGRADED

POST /gcp/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

PathParameter

svmName

true

string

PathParameter

volumeName

true

string

BodyParameter

body

Create snapshot request

true

SnapshotCreateRequest

Consumes
  • application/json

Produces
  • application/json

Move an existing volume.Operation may only be performed on working environments whose status is: ON, DEGRADED

POST /gcp/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/move
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

PathParameter

svmName

true

string

PathParameter

volumeName

true

string

BodyParameter

body

true

VolumeMoveRequest

Consumes
  • application/json

Produces
  • application/json

Gcp-vsa:working-environments

Create snapshot policy

POST /gcp/vsa/working-environments/{workingEnvironmentId}/snapshot-policy
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

BodyParameter

body

Create snapshot policy request

true

SnapshotPolicyCreateRequest

Consumes
  • application/json

Produces
  • application/json

Set schedules for Cloud Volumes ONTAP

PUT /gcp/vsa/working-environments/{workingEnvironmentId}/schedules
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

Cloud Volumes ONTAP working environment update schedule request

true

VsaSchedulesRequest

Consumes
  • application/json

Produces
  • application/json

List start-stop schedules for Cloud Volumes ONTAP

GET /gcp/vsa/working-environments/{workingEnvironmentId}/schedules
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Responses
HTTP Code Description Schema

default

success

VsaSchedule array

Consumes
  • application/json

Produces
  • application/json

Uploads a Cloud license file on the provided Cloud Volumes ONTAP

POST /gcp/vsa/working-environments/{workingEnvironmentId}/upload-license-file
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

HeaderParameter

filename

Cloud license file name

false

string

BodyParameter

license

license

false

string

Consumes
  • multipart/form-data

Produces
  • application/json

Registers a Cloud Volumes ONTAP system with NetApp

POST /gcp/vsa/working-environments/{workingEnvironmentId}/support-registration
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

QueryParameter

nssAccountId

false

string

Responses
HTTP Code Description Schema

default

success

SupportRegistrationResponse

Consumes
  • application/json

Produces
  • application/json

Retrieves the support registration status of a Cloud Volumes ONTAP system

GET /gcp/vsa/working-environments/{workingEnvironmentId}/support-registration
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Responses
HTTP Code Description Schema

default

success

SupportRegistrationResponse

Consumes
  • application/json

Produces
  • application/json

Deletes an existing Cloud Volumes ONTAP working environment, including all Cloud resources created for this working environment (unless the localDelete flag is set to true)

DELETE /gcp/vsa/working-environments/{workingEnvironmentId}
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

QueryParameter

localDelete

If true, the Cloud Volumes ONTAP instance is not terminated in Cloud, but Cloud Manager no longer manages the working environment.

false

boolean

false

QueryParameter

forceDelete

If true, the working environment will be deleted even if it is part of one or more SnapMirror relationships.

false

boolean

false

Consumes
  • application/json

Produces
  • application/json

Retrieves an Cloud Volumes ONTAP working environment.

GET /gcp/vsa/working-environments/{workingEnvironmentId}
Parameters
Type Name Description Required Schema Default

QueryParameter

fields

false

string

PathParameter

workingEnvironmentId

true

string

Responses
HTTP Code Description Schema

default

success

GcpVsaWorkingEnvironmentResponse

Consumes
  • application/json

Produces
  • application/json

Sets the instance type of a specific Cloud Volumes ONTAP

PUT /gcp/vsa/working-environments/{workingEnvironmentId}/license-instance-type
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

Instance type modification request

true

LicenseAndInstanceTypeModificationRequest

Consumes
  • application/json

Produces
  • application/json

Retrieves all license types and their associated instance types for a given Cloud Volumes ONTAP instance

GET /gcp/vsa/working-environments/{workingEnvironmentId}/license-instance-type
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Responses
HTTP Code Description Schema

default

success

LicenseAndInstanceType array

Consumes
  • application/json

Produces
  • application/json

Delete FPolicy for ransomeware files

DELETE /gcp/vsa/working-environments/{workingEnvironmentId}/fpolicy
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

Consumes
  • application/json

Produces
  • application/json

Change tier level

POST /gcp/vsa/working-environments/{workingEnvironmentId}/change-tier-level
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

Change tier level request

true

ChangeTierLevelRequest

Consumes
  • application/json

Produces
  • application/json

Modify the net port broadcast domain mtu of the Cloud Volumes ONTAP

PUT /gcp/vsa/working-environments/{workingEnvironmentId}/networkOptimization
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

Use optimization

true

ChangeNetworkOptimizationRequest

Consumes
  • application/json

Produces
  • application/json

Working Environment Ontap Saving

GET /gcp/vsa/working-environments/{workingEnvironmentId}/ontap-saving
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Responses
HTTP Code Description Schema

default

success

WorkingEnvironmentOntapSavingResponse

Consumes
  • application/json

Produces
  • application/json

Retrieves a list of versions to which this Cloud Volumes ONTAP can be upgraded

GET /gcp/vsa/working-environments/{workingEnvironmentId}/occm-provided-upgrade-versions
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Responses
HTTP Code Description Schema

default

success

OntapUpdateImageMetadata array

Consumes
  • application/json

Produces
  • application/json

Parses an uploaded Cloud license file

POST /gcp/vsa/working-environments/parse-license-file
Parameters
Type Name Description Required Schema Default

HeaderParameter

filename

Cloud license file name

false

string

BodyParameter

license

license

false

string

Responses
HTTP Code Description Schema

default

success

ProvidedLicenseResponse

Consumes
  • multipart/form-data

Produces
  • application/json

Starts a specific Cloud Volumes ONTAP instance

POST /gcp/vsa/working-environments/{workingEnvironmentId}/start
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Consumes
  • application/json

Produces
  • application/json

Retrieves eligibility support status of a Cloud Volumes ONTAP system. Valid values - NSS_NOT_VALID, NOT_REGISTERED, IPA_PROBLEM, VALID, NSS_NOT_EXISTS, LICENSE_EXPIRED

GET /gcp/vsa/working-environments/{workingEnvironmentId}/update-eligibility
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Responses
HTTP Code Description Schema

200

success

EligibilityResponse

400

Working Environment must be ON or UPDATING in order to check eligibility

No Content

Consumes
  • application/json

Produces
  • application/json

Creates a new Cloud Volumes ONTAP working environment.

POST /gcp/vsa/working-environments
Parameters
Type Name Description Required Schema Default

BodyParameter

body

Working environment

true

CreateGcpVsaWorkingEnvironmentRequest

Responses
HTTP Code Description Schema

default

success

GcpVsaWorkingEnvironmentResponse

Consumes
  • application/json

Produces
  • application/json

Retrieves Cloud Volumes ONTAP working environments visible to the currently logged in user.

GET /gcp/vsa/working-environments
Parameters
Type Name Description Required Schema Default

QueryParameter

fields

false

string

QueryParameter

tenantId

false

string

Responses
HTTP Code Description Schema

default

success

GcpVsaWorkingEnvironmentResponse array

Consumes
  • application/json

Produces
  • application/json

Setup NTP server

POST /gcp/vsa/working-environments/{workingEnvironmentId}/ntp
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

NTP Configuration request

true

NTPConfigurationRequest

Consumes
  • application/json

Produces
  • application/json

Stops a specific Cloud Volumes ONTAP instance

POST /gcp/vsa/working-environments/{workingEnvironmentId}/stop
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

QueryParameter

takeSnapshots

Take snapshots before stopping Cloud Volumes ONTAP

true

boolean

true

Consumes
  • application/json

Produces
  • application/json

Performs a complete image update operation on the single node of the specified Cloud Volumes ONTAP

POST /gcp/vsa/working-environments/{workingEnvironmentId}/update-image
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

Update system image request

true

UpdateSystemImageRequest

Consumes
  • application/json

Produces
  • application/json

Updates Cloud Manager password of a specific Cloud Volumes ONTAP

PUT /gcp/vsa/working-environments/{workingEnvironmentId}/update-credentials
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

Update Cloud Manager password request

true

UpdateCredentialsRequest

Consumes
  • application/json

Produces
  • application/json

Uploads a Cloud license file content on the provided Cloud Volumes ONTAP

POST /gcp/vsa/working-environments/{workingEnvironmentId}/upload-licenses
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

license file content request

true

LicenseFileContent

Consumes
  • application/json

Produces
  • application/json

Disable FPolicy for ransomeware files

PUT /gcp/vsa/working-environments/{workingEnvironmentId}/disable-fpolicy
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

Consumes
  • application/json

Produces
  • application/json

Update Backup to S3 Service settings

PUT /gcp/vsa/working-environments/{workingEnvironmentId}/cbs-settings
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

BodyParameter

body

true

CbsInfo

Consumes
  • application/json

Produces
  • application/json

Manually triggers subscription sync for all Cloud Volumes ONTAP working environments

POST /gcp/vsa/working-environments/sync-subscription
Consumes
  • application/json

Produces
  • application/json

Activate offbox configuration

PUT /gcp/vsa/working-environments/{workingEnvironmentId}/offbox
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Consumes
  • application/json

Produces
  • application/json

Setup a new CIFS Configuration to an existing Cloud Volumes ONTAP working environment

POST /gcp/vsa/working-environments/{workingEnvironmentId}/cifs
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

CIFS Configuration request

true

CIFSConfigurationRequest

Consumes
  • application/json

Produces
  • application/json

Retrieves CIFS Configuration to an existing Cloud Volumes ONTAP working environment

GET /gcp/vsa/working-environments/{workingEnvironmentId}/cifs
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Responses
HTTP Code Description Schema

default

success

CIFSConfigurationResponse array

Consumes
  • application/json

Produces
  • application/json

Sets the writing speed for Cloud Volumes ONTAP

PUT /gcp/vsa/working-environments/{workingEnvironmentId}/writing-speed
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

Writing speed request

true

WritingSpeedRequest

Consumes
  • application/json

Produces
  • application/json

Retrieves images already installed on the Cloud Volumes ONTAP

GET /gcp/vsa/working-environments/{workingEnvironmentId}/ontap-available-images
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Responses
HTTP Code Description Schema

default

success

UpdateLocalImage array

Consumes
  • application/json

Produces
  • application/json

Setup a new CIFS using workgroup configuration to an existing Cloud Volumes ONTAP working environment

POST /gcp/vsa/working-environments/{workingEnvironmentId}/cifs-workgroup
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

CIFS Configuration request

true

CIFSWorkgroupConfigurationRequest

Consumes
  • application/json

Produces
  • application/json

Activate snapshot policy assignment to all not protected rw volumes

PUT /gcp/vsa/working-environments/{workingEnvironmentId}/activate-snapshot-policy
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Consumes
  • application/json

Produces
  • application/json

Enable capacity tiering

POST /gcp/vsa/working-environments/{workingEnvironmentId}/enable-capacity-tiering
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

Enable capacity tiering request

true

EnableCapacityTieringRequest

Consumes
  • application/json

Produces
  • application/json

Activate FPolicy for ransomeware files

PUT /gcp/vsa/working-environments/{workingEnvironmentId}/activate-fpolicy
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

Consumes
  • application/json

Produces
  • application/json

Modify user tags for cloud resources of a given Cloud Volumes ONTAP instance

PUT /gcp/vsa/working-environments/{workingEnvironmentId}/user-tags
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

Modify user tags request

true

ModifyUserTagsRequest

Consumes
  • application/json

Produces
  • application/json

Retrieves editable tags for cloud resources of a given Cloud Volumes ONTAP instance

GET /gcp/vsa/working-environments/{workingEnvironmentId}/user-tags
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Responses
HTTP Code Description Schema

default

success

UserTagsResponse

Consumes
  • application/json

Produces
  • application/json

Retrieves action parameters used in create request of a given Cloud Volumes ONTAP instance

GET /gcp/vsa/working-environments/{workingEnvironmentId}/create-request-parameters
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Responses
HTTP Code Description Schema

default

success

CreateRequestParametersResponse

Consumes
  • application/json

Produces
  • application/json

Modify the svm name of the Cloud Volumes ONTAP

PUT /gcp/vsa/working-environments/{workingEnvironmentId}/svm
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

Svm name modification request

true

SvmNameModificationRequest

Consumes
  • application/json

Produces
  • application/json

Working Environment Cost And Usage

GET /gcp/vsa/working-environments/{workingEnvironmentId}/cost-and-usage
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

QueryParameter

start

cost and usage start period

false

string

QueryParameter

end

cost and usage end period

false

string

Responses
HTTP Code Description Schema

default

success

WorkingEnvironmentCostAndUsageResponse

Consumes
  • application/json

Produces
  • application/json

Change serial number of Cloud Volumes ONTAP

POST /gcp/vsa/working-environments/{workingEnvironmentId}/change-serial
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

Change serial number request

true

ChangeSerialNumberRequest

Consumes
  • application/json

Produces
  • application/json

Sets the cluster password of a specific Cloud Volumes ONTAP

PUT /gcp/vsa/working-environments/{workingEnvironmentId}/set-password
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

QueryParameter

occmOnly

false

boolean

BodyParameter

body

Set password request

true

PasswordWrapper

Consumes
  • application/json

Produces
  • application/json

Kubernetes

Retrieve Kubernetes clusters.

GET /k8s/clusters
Responses
HTTP Code Description Schema

default

success

[K8sInfo] array

Consumes
  • application/json

Produces
  • application/json

Connect ONTAP Cloud Working Environment to Kubernetes.Operation may only be performed on working environments whose status is: ON, DEGRADED

POST /k8s/connect-on-prem/{k8sClusterId}/{workingEnvironmentId}
Parameters
Type Name Description Required Schema Default

PathParameter

k8sClusterId

Kubernetes cluster public ID

true

string

PathParameter

workingEnvironmentId

on-premises ONTAP working environment

true

string

BodyParameter

body

Connect request

true

ConnectRequest

Consumes
  • application/json

Produces
  • application/json

Connect ONTAP Cloud Working Environment to Kubernetes.Operation may only be performed on working environments whose status is: ON, DEGRADED

POST /k8s/connect/{k8sClusterId}/{workingEnvironmentId}
Parameters
Type Name Description Required Schema Default

PathParameter

k8sClusterId

Kubernetes cluster public ID

true

string

PathParameter

workingEnvironmentId

Working environment public ID

true

string

BodyParameter

body

Connect request

true

ConnectRequest

Consumes
  • application/json

Produces
  • application/json

Remove existing Kubernetes cluster configuration.

DELETE /k8s/{k8sClusterId}
Parameters
Type Name Description Required Schema Default

PathParameter

k8sClusterId

Public Id of Kubernetes cluster

true

string

Consumes
  • application/json

Produces
  • application/json

Disconnect ONTAP Cloud Working Environment from Kubernetes.

DELETE /k8s/disconnect/{k8sClusterId}/{workingEnvironmentId}
Parameters
Type Name Description Required Schema Default

PathParameter

k8sClusterId

Kubernetes cluster public ID

true

string

PathParameter

workingEnvironmentId

Working environment public ID

true

string

Consumes
  • application/json

Produces
  • application/json

Kubernetes Setup - Uploads Kubernetes configuration file in YAML format, it should be provided in multipart/form-data, with the file at a part named 'config'..

POST /k8s/load
Parameters
Type Name Description Required Schema Default

HeaderParameter

filename

false

string

BodyParameter

config

config

false

string

Responses
HTTP Code Description Schema

default

success

K8sFileInfo

Consumes
  • multipart/form-data

Produces
  • application/json

Retrieve external Kubernetes clusters.

GET /k8s/external-clusters
Parameters
Type Name Description Required Schema Default

HeaderParameter

api-token

false

string

Responses
HTTP Code Description Schema

default

success

[K8sInfo] array

Consumes
  • application/json

Produces
  • application/json

Kubernetes Setup - Saves Kubernetes configuration.

POST /k8s/save
Parameters
Type Name Description Required Schema Default

BodyParameter

body

Save request

true

SaveRequest

Consumes
  • application/json

Produces
  • application/json

Occm:asup

Updates the AutoSupport configuration.

PUT /occm/asup
Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

AsupConfigurationRequest

Consumes
  • application/json

Produces
  • application/json

Retrieves the AutoSupport configuration.

GET /occm/asup
Responses
HTTP Code Description Schema

default

success

AsupConfiguration

Produces
  • application/json

Sends Cloud Volumes ONTAP performance archive support data to NetApp Support.Operation may only be performed on working environments whose status is: ON, DEGRADED

POST /occm/asup/send-Cot-performance-Asup/{workingEnvironmentId}
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Produces
  • application/json

Downloads a compressed file of all ASUP files from all VSAs.

GET /occm/asup/download-ontap-cloud-asups
Produces
  • application/json

Downloads Cloud Manager support data.

GET /occm/asup/download
Produces
  • application/json

Sends Cloud Manager support data to NetApp Support.

POST /occm/asup/send
Parameters
Type Name Description Required Schema Default

HeaderParameter

serial

occm serial number

false

string

Produces
  • application/json

Sends Cloud Volumes ONTAP support data to NetApp Support.

POST /occm/asup/send-Cot-Asup
Parameters
Type Name Description Required Schema Default

QueryParameter

sendToOccm

Send Asup to OCCM

true

boolean

false

Produces
  • application/json

Occm:config

Resets to the default simplicator URI. Internal use only.

POST /occm/config/simplicator/reset
Responses
HTTP Code Description Schema

default

success

ConfigResponse

Consumes
  • application/json

Produces
  • application/json

Configures modifiable Cloud Manager parameters.

PUT /occm/config
Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

ConfigValuesUpdateRequest

Responses
HTTP Code Description Schema

default

success

ConfigValuesResponse

Consumes
  • application/json

Produces
  • application/json

Retrieves Cloud Manager configuration parameters.

GET /occm/config
Responses
HTTP Code Description Schema

default

success

ConfigValuesResponse

Consumes
  • application/json

Produces
  • application/json

Retrieves the current simplicator URI and status. Internal use only.

GET /occm/config/simplicator
Responses
HTTP Code Description Schema

default

success

ConfigResponse

Consumes
  • application/json

Produces
  • application/json

Occm:encryption:certificate

Validates and installs the provided certificate. Successive calls will overwrite any previously installed certificate. The certificate must match a previously generated CSR.

POST /occm/encryption/certificate
Parameters
Type Name Description Required Schema Default

BodyParameter

body

The certificate generated for Cloud Manager

true

InstallCertificatesRequest

Responses
HTTP Code Description Schema

default

success

CertificateResponse

Consumes
  • application/json

Produces
  • application/json

Retrieves the installed certificate, if one exists.

GET /occm/encryption/certificate
Responses
HTTP Code Description Schema

default

success

CertificateResponse

Consumes
  • application/json

Produces
  • application/json

Occm:encryption:csr

Generates, stores and returns a certificate signing request (CSR). This CSR can be signed by a CA and then installed in Cloud Manager using /install_certificate. Successive calls will not overwrite previously generated CSRs.

POST /occm/encryption/csr
Responses
HTTP Code Description Schema

default

success

CsrResponse

Consumes
  • application/json

Produces
  • application/json

Retrieves the most recently generated CSR, if any exists.

GET /occm/encryption/csr
Responses
HTTP Code Description Schema

default

success

CsrResponse

Consumes
  • application/json

Produces
  • application/json

Occm:encryption:key-managers

Adds a new key manager.

POST /occm/encryption/key-managers
Parameters
Type Name Description Required Schema Default

BodyParameter

body

Create key manager request parameters

true

KeyManagerRequest

Responses
HTTP Code Description Schema

default

success

KeyManagerResponse

Consumes
  • application/json

Produces
  • application/json

Retrieves all key managers.

GET /occm/encryption/key-managers
Responses
HTTP Code Description Schema

default

success

KeyManagerResponse array

Consumes
  • application/json

Produces
  • application/json

Deletes an existing key manager.

DELETE /occm/encryption/key-managers/{keyManagerId}
Parameters
Type Name Description Required Schema Default

PathParameter

keyManagerId

Public Id of the key manager to be deleted

true

string

Responses
HTTP Code Description Schema

404

Key manager with the given id does not exist

No Content

Consumes
  • application/json

Produces
  • application/json

Updates an existing key manager.

PUT /occm/encryption/key-managers/{keyManagerId}
Parameters
Type Name Description Required Schema Default

BodyParameter

body

Update key manager request parameters

true

KeyManagerRequest

PathParameter

keyManagerId

Public Id of the key manager to be updated

true

string

Responses
HTTP Code Description Schema

200

success

KeyManagerResponse

404

Key manager with the given id does not exist

No Content

Consumes
  • application/json

Produces
  • application/json

Returns specific key manager by public Id.

GET /occm/encryption/key-managers/{keyManagerId}
Parameters
Type Name Description Required Schema Default

PathParameter

keyManagerId

Public Id of the key manager

true

string

Responses
HTTP Code Description Schema

default

success

KeyManagerResponse

Consumes
  • application/json

Produces
  • application/json

Occm:encryption:key-managers-ca-certificates

Deletes an existing key manager CA certificate.

DELETE /occm/encryption/key-managers-ca-certificates/{keyManagerCaCertificateId}
Parameters
Type Name Description Required Schema Default

PathParameter

keyManagerCaCertificateId

Public Id of the key manager ca certificate to be deleted

true

string

Responses
HTTP Code Description Schema

404

Key manager ca certificate with the given ID does not exist

No Content

Consumes
  • application/json

Produces
  • application/json

Retrieves a specific key manager CA certificate.

GET /occm/encryption/key-managers-ca-certificates/{keyManagerCaCertificateId}
Parameters
Type Name Description Required Schema Default

PathParameter

keyManagerCaCertificateId

Public Id of the key manager ca certificate

true

string

Responses
HTTP Code Description Schema

default

success

CertificateResponse

Consumes
  • application/json

Produces
  • application/json

Adds a new key manager CA certificate.

POST /occm/encryption/key-managers-ca-certificates
Parameters
Type Name Description Required Schema Default

BodyParameter

body

Saves a key manager ca certificate request parameters

true

KeyManagerCaCertificateRequest

Responses
HTTP Code Description Schema

default

success

CertificateResponse

Consumes
  • application/json

Produces
  • application/json

Retrieves all key managers CA certificates.

GET /occm/encryption/key-managers-ca-certificates
Responses
HTTP Code Description Schema

default

success

CertificateResponse array

Consumes
  • application/json

Produces
  • application/json

Occm:key-store

Generate new key pair and self certificate at key store and return a certificate signing request (CSR). This CSR can be signed by a CA.

POST /occm/key-store
Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

CertificateSigningRequest

Responses
HTTP Code Description Schema

default

success

CsrResponse

Consumes
  • application/json

Produces
  • application/json

Return existing trusted certificates added by the user from trust store.

GET /occm/key-store/user-trusted-certificates
Responses
HTTP Code Description Schema

default

success

TrustedCertificateResponse array

Consumes
  • application/json

Produces
  • application/json

Validates and installs the provided root CA chain. Successive calls will overwrite any previously installed root CA chain.

POST /occm/key-store/signed-certificate-file
Parameters
Type Name Description Required Schema Default

HeaderParameter

filename

Certificate file name

false

string

BodyParameter

certificate

The CA signed certificate

false

string

Responses
HTTP Code Description Schema

default

success

CertificateResponse

Consumes
  • multipart/form-data

Produces
  • application/json

Retrieve the self certificate of Cloud Manager key store, if one exists.

GET /occm/key-store/self-certificate
Responses
HTTP Code Description Schema

default

success

CertificateResponse

Consumes
  • application/json

Produces
  • application/json

Validates and installs the provided certificate in trust store.

POST /occm/key-store/trusted-certificate-file
Parameters
Type Name Description Required Schema Default

HeaderParameter

filename

Trusted certificate file name

false

string

BodyParameter

certificate

certificate

false

string

Responses
HTTP Code Description Schema

default

success

TrustedCertificateResponse

Consumes
  • multipart/form-data

Produces
  • application/json

Validates and installs the provided root CA chain. Successive calls will overwrite any previously installed root CA chain.

POST /occm/key-store/signed-certificate
Parameters
Type Name Description Required Schema Default

BodyParameter

body

The CA signed certificate

true

InstallCertificatesRequest

Responses
HTTP Code Description Schema

default

success

CertificateResponse

Consumes
  • application/json

Produces
  • application/json

Retrieve the CA signed certificate of Cloud Manager key store, if one exists.

GET /occm/key-store/signed-certificate
Responses
HTTP Code Description Schema

default

success

CertificateResponse

Consumes
  • application/json

Produces
  • application/json

Generate new key pair and self certificate at key store and return a certificate signing request (CSR). This CSR can be signed by a CA.

POST /occm/key-store/external-certificate
Parameters
Type Name Description Required Schema Default

BodyParameter

body

The CA signed certificate and an associated private key

true

InstallCertificatesAndPrivateKeyRequest

Responses
HTTP Code Description Schema

default

success

CertificateResponse

Consumes
  • application/json

Produces
  • application/json

Generate new key pair and self certificate at key store and return a certificate signing request (CSR). This CSR can be signed by a CA.

POST /occm/key-store/external-certificate-file
Parameters
Type Name Description Required Schema Default

HeaderParameter

certificateFilename

Certificate file name

false

string

HeaderParameter

privateKeyFilename

Private key file name

false

string

BodyParameter

certificate

The CA signed certificate

false

string

BodyParameter

privateKey

The private key associated with the CA signed certificate

false

string

Responses
HTTP Code Description Schema

default

success

CertificateResponse

Consumes
  • multipart/form-data

Produces
  • application/json

Delete existing trusted certificate from trust store.

DELETE /occm/key-store/trusted-certificate/{certificateId}
Parameters
Type Name Description Required Schema Default

PathParameter

certificateId

The trusted certificate’s ID

true

string

Consumes
  • application/json

Produces
  • application/json

Occm:saas-mp-service

Retrieves current SaaS marketplace account and subscriptions.

GET /occm/saas-mp-service/account
Responses
HTTP Code Description Schema

default

success

SaasMpAccountResponse

Produces
  • application/json

Update SaaS marketplace subscription for cvo.

PUT /occm/saas-mp-service/{workingEnvironmentId}/subscription
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

Update subscription request

true

UpdateSubscriptionRequest

Produces
  • application/json

Retrieves SaaS marketplace subscriptions for cvo.

GET /occm/saas-mp-service/{workingEnvironmentId}/subscription
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Responses
HTTP Code Description Schema

default

success

DescribeCvoSubscriptionResponse

Produces
  • application/json

Occm:setup

Performs initial setup.

POST /occm/setup/init
Parameters
Type Name Description Required Schema Default

BodyParameter

body

Setup data

true

SetupRequest

Responses
HTTP Code Description Schema

200

success

InitialSetupResponse

400

If setup already performed

No Content

Consumes
  • application/json

Produces
  • application/json

Validates that Cloud Manager has an active Internet connection

POST /occm/setup/validate/connectivity
Consumes
  • application/json

Produces
  • application/json

Validates a given proxy URL.

POST /occm/setup/validate/proxy
Parameters
Type Name Description Required Schema Default

BodyParameter

body

Proxy Url

true

ProxyUri

Consumes
  • application/json

Produces
  • application/json

Validates the given user as part of the Setup Wizard.

POST /occm/setup/validate/user
Parameters
Type Name Description Required Schema Default

BodyParameter

body

User Setup data

true

UserRequest

HeaderParameter

Setup-Proxy

false

string

HeaderParameter

Setup-Proxy-User

false

string

HeaderParameter

Setup-Proxy-Password

false

string

HeaderParameter

Setup-Proxy-Domain

false

string

HeaderParameter

Setup-Company

false

string

HeaderParameter

Setup-Site

false

string

Consumes
  • application/json

Produces
  • application/json

Validates the given tenant as part of the Setup Wizard.

POST /occm/setup/validate/tenant
Parameters
Type Name Description Required Schema Default

BodyParameter

body

Tenant Setup data

true

AddTenantRequest

HeaderParameter

Setup-Proxy

false

string

HeaderParameter

Setup-Proxy-User

false

string

HeaderParameter

Setup-Proxy-Password

false

string

HeaderParameter

Setup-Proxy-Domain

false

string

HeaderParameter

Setup-Company

false

string

HeaderParameter

Setup-Site

false

string

Consumes
  • application/json

Produces
  • application/json

Performs volume view initial setup.

POST /occm/setup/volume-view-init
Parameters
Type Name Description Required Schema Default

BodyParameter

body

Setup data

true

VolumeViewSetupRequest

Responses
HTTP Code Description Schema

200

success

InitialSetupResponse

400

If setup already performed

No Content

Consumes
  • application/json

Produces
  • application/json

Occm:setup-portal

Complete setup which was pending connectivity.

POST /occm/setup-portal/complete-connectivity-pending-setup
Responses
HTTP Code Description Schema

default

success

InitialSetupResponse

Consumes
  • application/json

Produces
  • application/json

Register Cloud Manager to NetApp Cloud Central.

POST /occm/setup-portal/register
Responses
HTTP Code Description Schema

200

success

RegistrationResponse

412

Cloud Manager is not configured with NetApp Cloud Central

No Content

404

Failed Communicating with NetApp Cloud Central

No Content

409

Cloud Manager is already registered to NetApp Cloud Central

No Content

Consumes
  • application/json

Produces
  • application/json

Setup a given proxy URL.

POST /occm/setup-portal/proxy/setup
Parameters
Type Name Description Required Schema Default

BodyParameter

body

Proxy Url

true

SetProxyRequest

Consumes
  • application/json

Produces
  • application/json

Performs initial setup with NetApp Cloud Central.

POST /occm/setup-portal/init
Parameters
Type Name Description Required Schema Default

HeaderParameter

Authorization

false

string

BodyParameter

body

Setup data

true

PortalSetupAsServiceConnectorRequest

Responses
HTTP Code Description Schema

200

success

InitialSetupResponse

400

If setup already performed

No Content

Consumes
  • application/json

Produces
  • application/json

Validates that Cloud Manager has an active Internet connection

POST /occm/setup-portal/validate/connectivity
Consumes
  • application/json

Produces
  • application/json

Occm:system

Retrieves Feature Flags.

GET /occm/system/feature-flags
Responses
HTTP Code Description Schema

default

success

FeatureFlag

Produces
  • application/json

Retrieves cloud providers supported regions.

GET /occm/system/cloud-provider-regions
Responses
HTTP Code Description Schema

default

success

ProviderSupportedRegions

Produces
  • application/json

Checks for a new version of Cloud Manager.

GET /occm/system/available-update-versions
Responses
HTTP Code Description Schema

default

success

UpdateInfo array

Produces
  • application/json

Retrieves Cloud Manager feedback configuration.

GET /occm/system/external-config
Responses
HTTP Code Description Schema

default

success

OccmExternalConfiguration

Produces
  • application/json

Updates Cloud Manager with the given patch. Backup should be provided in multipart/form-data, with the file at a part named 'patch'.

POST /occm/system/patch
Parameters
Type Name Description Required Schema Default

HeaderParameter

filename

false

string

BodyParameter

patch

patch

false

string

Consumes
  • multipart/form-data

Produces
  • application/json

Updates Cloud Manager to the given version.

POST /occm/system/update
Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

VersionWrapper

Produces
  • application/json

Manually trigger daily notification sending.

POST /occm/system/manually-trigger-send-daily-notification
Produces
  • application/json

Retrieves Cloud Manager support services information.

GET /occm/system/support-services
Responses
HTTP Code Description Schema

default

success

SupportServices

Produces
  • application/json

Manually activate Cloud Volumes ONTAP capacity automatic management cycle.

POST /occm/system/manually-activate-auto-vsa-capacity-management-cycle
Produces
  • application/json

Performs fetch and cache of Cloud Volumes ONTAP and Cloud Manager version information files from s3.

POST /occm/system/cloud-ontap-update-metadata
Produces
  • application/json

Retrieves Cloud Manager server information.

GET /occm/system/about
Responses
HTTP Code Description Schema

default

success

About

Produces
  • application/json

Retrieves the region, VPC, and subnet in which the Cloud Manager instance is running.

GET /occm/system/occm-instance-placement
Responses
HTTP Code Description Schema

default

success

InstancePlacementResponse

Produces
  • application/json

Performs fetch and processing of Cloud Volumes ONTAP image update metadata files.

POST /occm/system/cloud-ontap-update-image-metadata
Produces
  • application/json

Restart server.

POST /occm/system/restart-server
Produces
  • application/json

Occm:tenancy-service

Updates current Cloud Manager service user.

PUT /occm/tenancy-service/users/update-current-user
Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

UpdateServiceUser

Produces
  • application/json

Retrieves workspaces that are visible to the currently logged in user.

GET /occm/tenancy-service/workspaces
Responses
HTTP Code Description Schema

default

success

WorkspaceResponse array

Produces
  • application/json

Associate Service Connector to workspace.

POST /occm/tenancy-service/workspaces/{workspaceId}/associate
Parameters
Type Name Description Required Schema Default

PathParameter

workspaceId

true

string

Produces
  • application/json

Onprem:aggregates

Retrieves aggregates.

GET /onprem/aggregates
Parameters
Type Name Description Required Schema Default

QueryParameter

workingEnvironmentId

Filter aggregates by this working environment

true

string

QueryParameter

checkTieringRestrictions

Check tiering restrictions

false

boolean

Responses
HTTP Code Description Schema

default

success

OnPremAggregateResponse array

Consumes
  • application/json

Produces
  • application/json

Onprem:metadata

Verifies the address and credentials of the given cluster by retrieving the cluster info.

GET /onprem/metadata/cluster-info
Parameters
Type Name Description Required Schema Default

HeaderParameter

clusterAddress

Cluster address

true

string

HeaderParameter

clusterUsername

Cluster username

true

string

HeaderParameter

clusterPassword

Cluster password

true

string

Responses
HTTP Code Description Schema

default

success

ClusterInfoResponse

Consumes
  • application/json

Produces
  • application/json

Onprem:volumes

Clones an existing volume.Operation may only be performed on working environments whose status is: ON

POST /onprem/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/clone
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

PathParameter

svmName

SVM name

true

string

PathParameter

volumeName

Name of volume to be cloned

true

string

BodyParameter

body

Clone volume request

true

VolumeCloneRequest

Consumes
  • application/json

Produces
  • application/json

Deletes an existing volume.Operation may only be performed on working environments whose status is: ON

DELETE /onprem/volumes/{workingEnvironmentId}/{svmName}/{volumeName}
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

PathParameter

svmName

SVM name

true

string

PathParameter

volumeName

Name of volume to be deleted

true

string

Consumes
  • application/json

Produces
  • application/json

Modify an existing volume.Operation may only be performed on working environments whose status is: ON

PUT /onprem/volumes/{workingEnvironmentId}/{svmName}/{volumeName}
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

PathParameter

svmName

SVM name

true

string

PathParameter

volumeName

Name of volume to be modified

true

ref

BodyParameter

body

Modify volume request

true

OnPremVolumeModifyRequest

Consumes
  • application/json

Produces
  • application/json

Creates a new volume.Operation may only be performed on working environments whose status is: ON

POST /onprem/volumes
Parameters
Type Name Description Required Schema Default

BodyParameter

body

Create volume request

true

OnPremVolumeCreateRequest

Consumes
  • application/json

Produces
  • application/json

Retrieves volumes.Operation may only be performed on working environments whose status is: ON

GET /onprem/volumes
Parameters
Type Name Description Required Schema Default

QueryParameter

workingEnvironmentId

Filter volumes by this working environment

true

string

Responses
HTTP Code Description Schema

default

success

VolumeResponse array

Consumes
  • application/json

Produces
  • application/json

Delete snapshot manually.Operation may only be performed on working environments whose status is: ON

DELETE /onprem/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

PathParameter

svmName

true

string

PathParameter

volumeName

true

string

BodyParameter

body

Delete snapshot request

true

SnapshotDeleteRequest

Consumes
  • application/json

Produces
  • application/json

Create snapshot manually.Operation may only be performed on working environments whose status is: ON

POST /onprem/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

PathParameter

svmName

true

string

PathParameter

volumeName

true

string

BodyParameter

body

Create snapshot request

true

SnapshotCreateRequest

Consumes
  • application/json

Produces
  • application/json

Return a list of snapshot descriptions for the volume.Operation may only be performed on working environments whose status is: ON

GET /onprem/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshots
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

PathParameter

svmName

SVM name

true

string

PathParameter

volumeName

Filter snapshot descriptions for specified volume

true

string

Responses
HTTP Code Description Schema

default

success

[SnapshotResponse] array

Consumes
  • application/json

Produces
  • application/json

Onprem:working-environments

Discovers on-premises working environment in Cloud Manager.

POST /onprem/working-environments
Parameters
Type Name Description Required Schema Default

BodyParameter

body

Working environment

true

OnPremWorkingEnvironmentDiscoverRequest

Responses
HTTP Code Description Schema

default

success

OnPremWorkingEnvironmentResponse

Consumes
  • application/json

Produces
  • application/json

Retrieves on-premises working environments visible to the currently logged in user.

GET /onprem/working-environments
Parameters
Type Name Description Required Schema Default

QueryParameter

fields

false

string

QueryParameter

tenantId

Public Id of tenant

false

string

Responses
HTTP Code Description Schema

default

success

OnPremWorkingEnvironmentResponse array

Consumes
  • application/json

Produces
  • application/json

Updates Cloud Manager password for an On Premises working environment.

PUT /onprem/working-environments/{workingEnvironmentId}/update-credentials
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

Update Cloud Manager password request

true

UpdateCredentialsRequest

Consumes
  • application/json

Produces
  • application/json

Retrieves CIFS Configuration to an existing Cloud Volumes ONTAP working environment.Operation may only be performed on working environments whose status is: ON

GET /onprem/working-environments/{workingEnvironmentId}/cifs
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

QueryParameter

vserver

Vserver name

false

string

Responses
HTTP Code Description Schema

default

success

CIFSConfigurationResponse array

Consumes
  • application/json

Produces
  • application/json

Cloud Manager will no longer manage this working environment, but will not affect the Data ONTAP itself.

DELETE /onprem/working-environments/{workingEnvironmentId}
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Consumes
  • application/json

Produces
  • application/json

Retrieves an on-premises ONTAP working environment.

GET /onprem/working-environments/{workingEnvironmentId}
Parameters
Type Name Description Required Schema Default

QueryParameter

fields

false

string

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Responses
HTTP Code Description Schema

default

success

OnPremWorkingEnvironmentResponse

Consumes
  • application/json

Produces
  • application/json

Replication

Creates a new replication to an Cloud Volumes ONTAP working environment.

POST /replication/vsa
Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

CreateReplicationRequestToVsa

Consumes
  • application/json

Produces
  • application/json

Creates a new replication to an on-premises working environment.

POST /replication/onprem
Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

CreateReplicationRequestToOnPrem

Consumes
  • application/json

Produces
  • application/json

Retrieves the intercluster LIFs used in a cluster peering relationship.

GET /replication/intercluster-lifs
Parameters
Type Name Description Required Schema Default

QueryParameter

workingEnvironmentId

Public Id of working environment

true

string

QueryParameter

peerWorkingEnvironmentId

Public Id of peer working environment

true

string

Responses
HTTP Code Description Schema

default

success

ReplicationInterClusterLifs

Consumes
  • application/json

Produces
  • application/json

Retrieves the status of all SnapMirror relationships.

GET /replication/status
Parameters
Type Name Description Required Schema Default

QueryParameter

tenantId

Public Id of tenant

false

string

Responses
HTTP Code Description Schema

default

success

ReplicationStatusResponse array

Consumes
  • application/json

Produces
  • application/json

Breaks a SnapMirror replication relationship.

POST /replication/break/{destinationWorkingEnvironmentId}/{destinationSvmName}/{destinationVolumeName}
Parameters
Type Name Description Required Schema Default

PathParameter

destinationWorkingEnvironmentId

Public Id of destination working environment

true

string

PathParameter

destinationSvmName

Destination SVM name

true

string

PathParameter

destinationVolumeName

Destination volume name

true

string

Consumes
  • application/json

Produces
  • application/json

Initializes an existing SnapMirror relationship. This method can only be performed in case the relationship has already been established and is healthy, yet is idle and uninitialized. For example, if the initial transfer were interrupted, then it can be restarted with this request.

POST /replication/initialize/{destinationWorkingEnvironmentId}/{destinationSvmName}/{destinationVolumeName}
Parameters
Type Name Description Required Schema Default

PathParameter

destinationWorkingEnvironmentId

Public Id of the working environment with which the SnapMirror relationship has already been established

true

string

PathParameter

destinationSvmName

Destination SVM name

true

string

PathParameter

destinationVolumeName

Destination volume name

true

string

Consumes
  • application/json

Produces
  • application/json

Retrieves replication schedules of a specific working environment.

GET /replication/schedules/{workingEnvironmentId}
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of destination working environment

true

string

Responses
HTTP Code Description Schema

default

success

ReplicationSchedule array

Consumes
  • application/json

Produces
  • application/json

Updates a SnapMirror replication relationship.

PUT /replication/{workingEnvironmentId}/{destinationSvmName}/{destinationVolumeName}
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

Replication update request

true

ReplicationUpdateRequest

PathParameter

destinationSvmName

Destination SVM name

true

string

PathParameter

destinationVolumeName

Destination volume name

true

string

Consumes
  • application/json

Produces
  • application/json

Retrieves SnapMirror replication relationship statuses of a specific working environment.

GET /replication/status/{workingEnvironmentId}
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Responses
HTTP Code Description Schema

default

success

ReplicationStatusResponse array

Consumes
  • application/json

Produces
  • application/json

Updates the destination endpoint of the SnapMirror relationship.

POST /replication/update/{destinationWorkingEnvironmentId}/{destinationSvmName}/{destinationVolumeName}
Parameters
Type Name Description Required Schema Default

PathParameter

destinationWorkingEnvironmentId

Public Id of destination working environment

true

string

PathParameter

destinationSvmName

Destination SVM name

true

string

PathParameter

destinationVolumeName

Destination volume name

true

string

Consumes
  • application/json

Produces
  • application/json

Reversing an existing SnapMirror relationship. This method can only be performed in case the relationship has already been established and is healthy and idle.

POST /replication/reverse/{destinationWorkingEnvironmentId}/{destinationSvmName}/{destinationVolumeName}
Parameters
Type Name Description Required Schema Default

PathParameter

destinationWorkingEnvironmentId

Public Id of the working environment with which the SnapMirror relationship has already been established

true

string

PathParameter

destinationSvmName

Destination SVM name

true

string

PathParameter

destinationVolumeName

Destination volume name

true

string

BodyParameter

body

false

SourceSnapmirrorEndpoint

Consumes
  • application/json

Produces
  • application/json

Resyncs a SnapMirror replication relationship.

POST /replication/resync/{destinationWorkingEnvironmentId}/{destinationSvmName}/{destinationVolumeName}
Parameters
Type Name Description Required Schema Default

PathParameter

destinationWorkingEnvironmentId

Public Id of destination working environment

true

string

PathParameter

destinationSvmName

Destination SVM name

true

string

PathParameter

destinationVolumeName

Destination volume name

true

string

Consumes
  • application/json

Produces
  • application/json

Removes a replication relationship.

DELETE /replication/{destinationWorkingEnvironmentId}/{destinationSvmName}/{destinationVolumeName}
Parameters
Type Name Description Required Schema Default

PathParameter

destinationWorkingEnvironmentId

Public Id of destination working environment

true

string

PathParameter

destinationSvmName

Destination SVM name

true

string

PathParameter

destinationVolumeName

Destination volume name

true

string

Consumes
  • application/json

Produces
  • application/json

Replication:metadata

return list of snapshot labels from the volume matching lables in the passed list.Operation may only be performed on working environments whose status is: ON, DEGRADED

GET /replication/metadata/snapshot-labels/{workingEnvironmentId}/{svmName}/{volumeName}
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

PathParameter

svmName

SVM name

true

string

PathParameter

volumeName

Volume name

true

string

QueryParameter

labels

false

csv string array

Responses
HTTP Code Description Schema

default

success

string array

Consumes
  • application/json

Produces
  • application/json

retrieves SnapMirror policies based on source and destination Cloud Volumes ONTAP.

GET /replication/metadata/snapmirror-policies/{sourceWorkingEnvironmentId}/{targetWorkingEnvironmentId}
Parameters
Type Name Description Required Schema Default

PathParameter

sourceWorkingEnvironmentId

Public Id of source working environment

true

string

PathParameter

targetWorkingEnvironmentId

Public Id of destination working environment

true

string

Responses
HTTP Code Description Schema

default

success

SnapMirrorPolicyResponse array

Consumes
  • application/json

Produces
  • application/json

Tenants

Creates a new tenant.

POST /tenants
Parameters
Type Name Description Required Schema Default

BodyParameter

body

true

AddTenantRequest

Responses
HTTP Code Description Schema

default

success

TenantResponse

Consumes
  • application/json

Produces
  • application/json

Retrieves tenants that are visible to the currently logged in user.

GET /tenants
Parameters
Type Name Description Required Schema Default

QueryParameter

fields

false

string

Responses
HTTP Code Description Schema

default

success

TenantResponse array

Consumes
  • application/json

Produces
  • application/json

Deletes an existing tenant. It is not possible to delete a tenant over which working environments exist.

DELETE /tenants/{tenantId}
Parameters
Type Name Description Required Schema Default

PathParameter

tenantId

Public Id of the tenant to be deleted

true

string

Consumes
  • application/json

Produces
  • application/json

Updates an existing tenant.

PUT /tenants/{tenantId}
Parameters
Type Name Description Required Schema Default

PathParameter

tenantId

Public Id of tenant

true

string

BodyParameter

body

Tenant update request

true

UpdateTenantRequest

Responses
HTTP Code Description Schema

default

success

TenantResponse

Consumes
  • application/json

Produces
  • application/json

Retrieves a tenant.

GET /tenants/{tenantId}
Parameters
Type Name Description Required Schema Default

QueryParameter

fields

false

string

PathParameter

tenantId

Public Id of tenant

true

string

Responses
HTTP Code Description Schema

default

success

TenantResponse

Consumes
  • application/json

Produces
  • application/json

PUT /tenants/{tenantId}/nss-keys
Parameters
Type Name Description Required Schema Default

PathParameter

tenantId

Public Id of the tenant to be updated

true

string

BodyParameter

body

true

SetNssKeysRequest

Responses
HTTP Code Description Schema

default

success

TenantResponse

Consumes
  • application/json

Produces
  • application/json

User-mng:auth

Retrieves representation of currently logged in user.

GET /auth/current-user
Responses
HTTP Code Description Schema

200

success

UserResponse

401

No user is currently logged in

No Content

403

No connectivity - SSL Exception

No Content

409

Setup halted. Internet connectivity required to complete

No Content

Consumes
  • application/json

Produces
  • application/json

Changes the password of the currently logged in user.

PUT /auth/current-user/change-password
Parameters
Type Name Description Required Schema Default

BodyParameter

body

Change current user password request parameters

true

ResetPassword

Responses
HTTP Code Description Schema

401

No user is currently logged in

No Content

Consumes
  • application/json

Produces
  • application/json

Log in to Cloud Manager.

POST /auth/login
Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

UserPasswordRequest

Responses
HTTP Code Description Schema

401

Incorrect email/password combination

No Content

408

Failed Communicating with Active Directory

No Content

Consumes
  • application/json

Produces
  • application/json

Log out of Cloud Manager.

POST /auth/logout
Responses
HTTP Code Description Schema

401

No user is currently logged in

No Content

Consumes
  • application/json

Produces
  • application/json

User-mng:roles

Retrieves all roles.

GET /roles
Responses
HTTP Code Description Schema

default

success

Role array

Consumes
  • application/json

Produces
  • application/json

Retrieves a specific role.

GET /roles/{roleId}
Parameters
Type Name Description Required Schema Default

PathParameter

roleId

Role public Id

true

string

Responses
HTTP Code Description Schema

200

success

Role

404

Role with the given public ID does not exist

No Content

Consumes
  • application/json

Produces
  • application/json

User-mng:users

Grants or revokes permissions to the given user for performing operations over the given working environments.

POST /users/{userId}/working-environments-grant-revoke
Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

GrantPermission

PathParameter

userId

Public Id of the user whose permissions are to be changed

true

string

Responses
HTTP Code Description Schema

404

User with the given user id does not exist

No Content

Consumes
  • application/json

Produces
  • application/json

Deletes an existing user. It is not possible to delete a user that has created existing working environments. It is not possible to delete the logged in user.

DELETE /users/{userId}
Parameters
Type Name Description Required Schema Default

PathParameter

userId

Public Id of the user to be deleted

true

string

Responses
HTTP Code Description Schema

404

User with the given user id does not exist

No Content

Consumes
  • application/json

Produces
  • application/json

Updates an existing user.

PUT /users/{userId}
Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

UpdateUserRequest

PathParameter

userId

Public Id of user

true

string

Responses
HTTP Code Description Schema

200

success

UserResponse

404

User with the given user id does not exist

No Content

Consumes
  • application/json

Produces
  • application/json

Retrieves a specific user.

GET /users/{userId}
Parameters
Type Name Description Required Schema Default

PathParameter

userId

Public Id of user

true

string

Responses
HTTP Code Description Schema

default

success

UserResponse

Consumes
  • application/json

Produces
  • application/json

Resets the password of the given user.

PUT /users/{userId}/reset-password
Parameters
Type Name Description Required Schema Default

PathParameter

userId

Public Id of the user whose password is to be reset

true

string

BodyParameter

body

Reset password request

true

ResetUserPasswordRequest

Responses
HTTP Code Description Schema

403

The current user does not have permissions to perform this operation for the given user

No Content

Consumes
  • application/json

Produces
  • application/json

Creates a new user.

POST /users
Parameters
Type Name Description Required Schema Default

BodyParameter

body

true

UserRequest

Responses
HTTP Code Description Schema

200

success

UserResponse

404

Either the provided tenant or role assigned to the new user does not exist

No Content

Consumes
  • application/json

Produces
  • application/json

Retrieves all users visible to the current user.

GET /users
Responses
HTTP Code Description Schema

default

success

UserResponse array

Consumes
  • application/json

Produces
  • application/json

Add existing NetApp Cloud Central user to Cloud Manager.

POST /users/add-user
Parameters
Type Name Description Required Schema Default

BodyParameter

body

true

AddPortalUserRequest

Responses
HTTP Code Description Schema

200

success

UserResponse

404

Either the provided tenant or role assigned to the new user does not exist

No Content

Consumes
  • application/json

Produces
  • application/json

Remove user from Cloud Manager.

DELETE /users/{userId}/remove-user
Parameters
Type Name Description Required Schema Default

PathParameter

userId

Public Id of user

true

string

Consumes
  • application/json

Produces
  • application/json

Volume-view:general

Return actions required.

GET /managed/aws/vsa/volumes/actions-required
Responses
HTTP Code Description Schema

default

success

ActionRequiredResponse array

Consumes
  • application/json

Produces
  • application/json

Register managed volumes to NetApp Support Site.

PUT /managed/aws/vsa/volumes/nss-keys
Parameters
Type Name Description Required Schema Default

BodyParameter

body

true

SetNssKeysRequest

Consumes
  • application/json

Produces
  • application/json

Return NSS user name.

GET /managed/aws/vsa/volumes/nss-keys
Responses
HTTP Code Description Schema

default

success

NssUserName

Consumes
  • application/json

Produces
  • application/json

Set Cloud Volumes ONTAP password.

PUT /managed/aws/vsa/volumes/ontap-cloud-password
Parameters
Type Name Description Required Schema Default

BodyParameter

body

true

OntapCloudPasswordRequest

Consumes
  • application/json

Produces
  • application/json

Return true if Cloud Volumes ONTAP password exists.

GET /managed/aws/vsa/volumes/ontap-cloud-password
Responses
HTTP Code Description Schema

default

success

OntapCloudPasswordExists

Consumes
  • application/json

Produces
  • application/json

Set Volume View AWS tags.

PUT /managed/aws/vsa/volumes/aws-tags
Parameters
Type Name Description Required Schema Default

BodyParameter

body

true

AddTagsRequest

Consumes
  • application/json

Produces
  • application/json

Retrieves AWS tags set for Volume View.

GET /managed/aws/vsa/volumes/aws-tags
Responses
HTTP Code Description Schema

default

success

AwsTag array

Consumes
  • application/json

Produces
  • application/json

Updates current user - email and name.

PUT /managed/aws/vsa/volumes/update-user
Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

UpdateUserRequest

Consumes
  • application/json

Produces
  • application/json

Volume-view:instances

Starts a specific Cloud Volumes ONTAP instance.

POST /managed/aws/vsa/instances/{workingEnvironmentId}/start
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Consumes
  • application/json

Produces
  • application/json

Retrieves all valid instance types for a given Cloud Volumes ONTAP instance.

GET /managed/aws/vsa/instances/{workingEnvironmentId}/target-instance-types
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Responses
HTTP Code Description Schema

default

success

ManagedInstanceTypeResponse array

Consumes
  • application/json

Produces
  • application/json

Return existing instance IDs.

GET /managed/aws/vsa/instances
Responses
HTTP Code Description Schema

default

success

ManagedInstanceIdResponse array

Consumes
  • application/json

Produces
  • application/json

Deletes an existing Cloud Volumes ONTAP instance, including all Cloud resources created for this instance.

DELETE /managed/aws/vsa/instances/{workingEnvironmentId}
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Consumes
  • application/json

Produces
  • application/json

Return instance info.

GET /managed/aws/vsa/instances/{workingEnvironmentId}
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Responses
HTTP Code Description Schema

default

success

ManagedInstanceResponse array

Consumes
  • application/json

Produces
  • application/json

Sets the instance type of a specific Cloud Volumes ONTAP.

PUT /managed/aws/vsa/instances/{workingEnvironmentId}/instance-type
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

true

ChangeInstanceTypeRequest

Consumes
  • application/json

Produces
  • application/json

Stops a specific Cloud Volumes ONTAP instance.

POST /managed/aws/vsa/instances/{workingEnvironmentId}/stop
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Consumes
  • application/json

Produces
  • application/json

Volume-view:volumes

Change managed volume underlying disk type.Operation may only be performed on working environments whose status is: ON

POST /managed/aws/vsa/volumes/{managedVolumeId}/change-disk-type
Parameters
Type Name Description Required Schema Default

PathParameter

managedVolumeId

Public Id of managed volume

true

string

BodyParameter

body

true

ManagedVolumeChangeDiskTypeRequest

Consumes
  • application/json

Produces
  • application/json

Check possible placement for new volume.

POST /managed/aws/vsa/volumes/possible-placement
Parameters
Type Name Description Required Schema Default

BodyParameter

body

Managed volume create request

true

ManagedVolumeCreateRequest

Responses
HTTP Code Description Schema

default

success

PlacementResult

Consumes
  • application/json

Produces
  • application/json

Check possible placement for new HA volume.

POST /managed/aws/vsa/volumes/ha/possible-placement
Parameters
Type Name Description Required Schema Default

BodyParameter

body

Managed HA volume create request

true

ManagedHaVolumeCreateRequest

Responses
HTTP Code Description Schema

default

success

HaPlacementResult

Consumes
  • application/json

Produces
  • application/json

Creates a new highly available volume.

POST /managed/aws/vsa/volumes/ha
Parameters
Type Name Description Required Schema Default

BodyParameter

body

Create volume request

true

ExtendedManagedHaVolumeCreateRequest

Responses
HTTP Code Description Schema

default

success

ManagedVolume

Consumes
  • application/json

Produces
  • application/json

Deletes an existing volume.

DELETE /managed/aws/vsa/volumes/{managedVolumeId}
Parameters
Type Name Description Required Schema Default

PathParameter

managedVolumeId

Public Id of managed volume

true

string

Consumes
  • application/json

Produces
  • application/json

Modify an existing volume.

PUT /managed/aws/vsa/volumes/{managedVolumeId}
Parameters
Type Name Description Required Schema Default

PathParameter

managedVolumeId

Public Id of managed volume

true

string

BodyParameter

body

Modify volume request

true

ManagedVolumeModifyRequest

Consumes
  • application/json

Produces
  • application/json

Retrieves managed volume by id.

GET /managed/aws/vsa/volumes/{managedVolumeId}
Parameters
Type Name Description Required Schema Default

PathParameter

managedVolumeId

Public Id of managed volume

true

string

Responses
HTTP Code Description Schema

default

success

ManagedVolume

Consumes
  • application/json

Produces
  • application/json

Quotes an existing volume.Operation may only be performed on working environments whose status is: ON

POST /managed/aws/vsa/volumes/{managedVolumeId}/quote
Parameters
Type Name Description Required Schema Default

PathParameter

managedVolumeId

Public Id of managed volume

true

string

BodyParameter

body

Managed volume change disk type request

true

ManagedVolumeQuoteRequest

Responses
HTTP Code Description Schema

default

success

PlacementResult

Consumes
  • application/json

Produces
  • application/json

Creates a new volume.

POST /managed/aws/vsa/volumes
Parameters
Type Name Description Required Schema Default

BodyParameter

body

Create volume request

true

ExtendedManagedVolumeCreateRequest

Responses
HTTP Code Description Schema

default

success

ManagedVolume

Consumes
  • application/json

Produces
  • application/json

Retrieves all available volumes.

GET /managed/aws/vsa/volumes
Parameters
Type Name Description Required Schema Default

QueryParameter

volumeName

Volume name to filter

false

string

Responses
HTTP Code Description Schema

default

success

ManagedVolumesResponse

Consumes
  • application/json

Produces
  • application/json

Clones an existing volume.

POST /managed/aws/vsa/volumes/{managedVolumeId}/clone
Parameters
Type Name Description Required Schema Default

PathParameter

managedVolumeId

Public Id of managed volume

true

string

BodyParameter

body

true

ManagedVolumeCloneRequest

Consumes
  • application/json

Produces
  • application/json

Vsa:aggregates

Adds disks to an existing aggregate

POST /vsa/aggregates/{workingEnvironmentId}/{aggregateName}/disks
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

PathParameter

aggregateName

Name of aggregate to be updated

true

string

BodyParameter

body

Add disk to aggregate request

true

AddDisksToAggregateRequest

Consumes
  • application/json

Produces
  • application/json

Deletes an existing aggregate

DELETE /vsa/aggregates/{workingEnvironmentId}/{aggregateName}
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

PathParameter

aggregateName

Name of aggregate to be deleted

true

string

Consumes
  • application/json

Produces
  • application/json

Creates a new aggregate

POST /vsa/aggregates
Parameters
Type Name Description Required Schema Default

BodyParameter

body

Create Aggregate Request

true

VsaAggregateCreateRequest

Consumes
  • application/json

Produces
  • application/json

Retrieves aggregates

GET /vsa/aggregates
Parameters
Type Name Description Required Schema Default

QueryParameter

workingEnvironmentId

Public Id of working environment

false

string

Responses
HTTP Code Description Schema

default

success

AggregateResponse array

Consumes
  • application/json

Produces
  • application/json

Vsa:discovery

Retrieves a list of discovered working environments visible to the current user in the specified AWS region.

GET /vsa/discover
Parameters
Type Name Description Required Schema Default

QueryParameter

region

Region to discover working environments

true

string

QueryParameter

cloudProviderAccountId

false

string

Responses
HTTP Code Description Schema

default

success

DiscoveredVsaResponse array

Consumes
  • application/json

Produces
  • application/json

Saves a previously discovered Cloud Volumes ONTAP working environment to the Cloud Manager database.

POST /vsa/recover
Parameters
Type Name Description Required Schema Default

BodyParameter

body

Working environment

true

RecoverVsaRequest

Responses
HTTP Code Description Schema

default

success

VsaWorkingEnvironmentResponse

Consumes
  • application/json

Produces
  • application/json

Vsa:encryption

Updates the key manager CA certificate on the Cloud Volumes ONTAP system

POST /vsa/encryption/{workingEnvironmentId}/update-key-manager-ca-certificate
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

Update Cloud Volumes ONTAP key manager CA certificate request parameters

true

UpdateKeyManagerCaCertificateRequest

Responses
HTTP Code Description Schema

default

success

CertificateResponse

Consumes
  • application/json

Produces
  • application/json

Updates the client certificate on the Cloud Volumes ONTAP system

POST /vsa/encryption/{workingEnvironmentId}/update-client-certificate
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Responses
HTTP Code Description Schema

default

success

CertificateResponse

Consumes
  • application/json

Produces
  • application/json

Deletes a key manager from the Cloud Volumes ONTAP system

DELETE /vsa/encryption/{workingEnvironmentId}/key-managers/{keyManagerIp}
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

PathParameter

keyManagerIp

Key manager IP address

true

string

Consumes
  • application/json

Produces
  • application/json

Adds a key manager to the Cloud Volumes ONTAP system

POST /vsa/encryption/{workingEnvironmentId}/key-managers/{keyManagerIp}
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

PathParameter

keyManagerIp

Key manager IP address

true

string

Consumes
  • application/json

Produces
  • application/json

Vsa:metadata

Retrieves supported features

GET /vsa/metadata/supported-features
Parameters
Type Name Description Required Schema Default

QueryParameter

region

true

string

QueryParameter

ontapVersion

true

string

QueryParameter

dataEncryptionType

true

string

QueryParameter

licenseType

true

string

QueryParameter

instanceType

true

string

Responses
HTTP Code Description Schema

default

success

SupportedFeaturesResponse

Consumes
  • application/json

Produces
  • application/json

Validates the current user is subscribed to Cloud Volumes ONTAP product in Amazon marketplace

POST /vsa/metadata/validate-subscribed-to-ontap-cloud
Parameters
Type Name Description Required Schema Default

BodyParameter

body

Validate subscribed to Cloud Volumes ONTAP request

true

AwsValidateSubscribedToOntapCloudRequest

Responses
HTTP Code Description Schema

default

success

AwsValidateSubscribedToOntapCloudResponse

Consumes
  • application/json

Produces
  • application/json

Retrieves AWS user Key Pairs for specific region

GET /vsa/metadata/key-pairs
Parameters
Type Name Description Required Schema Default

QueryParameter

region

true

string

QueryParameter

roleArn

false

string

QueryParameter

cloudProviderAccountId

false

string

Responses
HTTP Code Description Schema

default

success

string array

Consumes
  • application/json

Produces
  • application/json

Retrieves AWS user Key Pairs for all regions

GET /vsa/metadata/key-pairs-by-region
Parameters
Type Name Description Required Schema Default

QueryParameter

roleArn

false

string

QueryParameter

cloudProviderAccountId

false

string

Responses
HTTP Code Description Schema

default

success

KeyPairsByRegionResponse

Consumes
  • application/json

Produces
  • application/json

Retrieves packages configuration

GET /vsa/metadata/packages
Responses
HTTP Code Description Schema

default

success

PackageInfoResponse array

Consumes
  • application/json

Produces
  • application/json

Retrieves all the Tag names

GET /vsa/metadata/tag-keys
Parameters
Type Name Description Required Schema Default

QueryParameter

roleArn

false

string

QueryParameter

cloudProviderAccountId

false

string

Responses
HTTP Code Description Schema

default

success

TagKeyResponse array

Consumes
  • application/json

Produces
  • application/json

Retrieves instance types not supporting acceleration and capacity tiering

GET /vsa/metadata/instance-types-not-supporting-acceleration-and-capacity-tiering
Responses
HTTP Code Description Schema

default

success

InstanceTypesNotSupportingAccelerationAndCapacityTieringResponse

Consumes
  • application/json

Produces
  • application/json

Retrieves all Cloud Manager manifests. Refer to the API Developers Guide in order to understand how to extract valid region codes, license types, instance types and Cloud Volumes ONTAP version parameters for the creation of a Cloud Volumes ONTAP working environment.

GET /vsa/metadata/manifests
Responses
HTTP Code Description Schema

default

success

MetadataResponse

Consumes
  • application/json

Produces
  • application/json

Retrieves default snapshot policies available on a cluster

GET /vsa/metadata/default-snapshot-policies
Responses
HTTP Code Description Schema

default

success

SnapshotPolicy array

Consumes
  • application/json

Produces
  • application/json

Retrieves the minimum number of required IPs for a single Cloud Volumes ONTAP system, an HA node, and HA mediator

GET /vsa/metadata/network-requirements
Responses
HTTP Code Description Schema

default

success

NetworkRequirementsResponse

Consumes
  • application/json

Produces
  • application/json

Retrieves supported capacity tiers for EBS volume types

GET /vsa/metadata/supported-capacity-tiers
Parameters
Type Name Description Required Schema Default

QueryParameter

region

true

string

QueryParameter

ontapVersion

true

string

QueryParameter

dataEncryptionType

true

string

QueryParameter

licenseType

true

string

QueryParameter

instanceType

true

string

Responses
HTTP Code Description Schema

default

success

SupportedCapacityTiers

Consumes
  • application/json

Produces
  • application/json

Retrieves AWS encryption keys for specific region

GET /vsa/metadata/aws-encryption-keys
Parameters
Type Name Description Required Schema Default

QueryParameter

region

true

string

QueryParameter

roleArn

false

string

QueryParameter

cloudProviderAccountId

false

string

Responses
HTTP Code Description Schema

default

success

AwsEncryptionKey array

Consumes
  • application/json

Produces
  • application/json

Retrieves all Cloud Volumes ONTAP configurations.

GET /vsa/metadata/permutations
Parameters
Type Name Description Required Schema Default

QueryParameter

region

Filter by region

false

string

QueryParameter

version

Filter by version

false

string

QueryParameter

license

Filter by license

false

string

QueryParameter

instance_type

Filter by instance type

false

string

QueryParameter

default_instance_type

Filter by default instance type

false

string

QueryParameter

feature

Filter by feature

false

string

QueryParameter

latest_only

Filter latest only

false

string

QueryParameter

ami

Filter by ami id

false

string

Responses
HTTP Code Description Schema

default

success

Configuration array

Consumes
  • application/json

Produces
  • application/json

Retrieves AWS regions over which an Cloud Volumes ONTAP working environment may be created

GET /vsa/metadata/regions
Responses
HTTP Code Description Schema

default

success

Region array

Consumes
  • application/json

Produces
  • application/json

Retrieves AWS instance profiles

GET /vsa/metadata/instance-profiles
Parameters
Type Name Description Required Schema Default

QueryParameter

roleArn

false

string

QueryParameter

cloudProviderAccountId

false

string

Responses
HTTP Code Description Schema

default

success

InstanceProfileResponse array

Consumes
  • application/json

Produces
  • application/json

Retrieves VPCs

GET /vsa/metadata/vpcs
Parameters
Type Name Description Required Schema Default

QueryParameter

region

true

string

QueryParameter

roleArn

false

string

QueryParameter

cloudProviderAccountId

false

string

Responses
HTTP Code Description Schema

default

success

VpcExtendedResponse array

Consumes
  • application/json

Produces
  • application/json

Retrieves supported EBS volume types

GET /vsa/metadata/ebs-volume-types
Responses
HTTP Code Description Schema

default

success

EbsVolumeType array

Consumes
  • application/json

Produces
  • application/json

Vsa:volumes

Quotes a new volume. Returns a resource quote needed to satisfy the requested volume.Operation may only be performed on working environments whose status is: ON, DEGRADED

POST /vsa/volumes/quote
Parameters
Type Name Description Required Schema Default

BodyParameter

body

Quote volume request

true

VsaVolumeQuoteRequest

Responses
HTTP Code Description Schema

default

success

VsaVolumeQuoteResponse

Consumes
  • application/json

Produces
  • application/json

Change underlying volume tier.Operation may only be performed on working environments whose status is: ON, DEGRADED

POST /vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/change-tier
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

PathParameter

svmName

true

string

PathParameter

volumeName

true

string

BodyParameter

body

true

ChangeVolumeTierRequest

Consumes
  • application/json

Produces
  • application/json

Delete snapshot manually.Operation may only be performed on working environments whose status is: ON, DEGRADED

DELETE /vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

PathParameter

svmName

true

string

PathParameter

volumeName

true

string

BodyParameter

body

Create snapshot request

true

SnapshotDeleteRequest

Consumes
  • application/json

Produces
  • application/json

Create snapshot manually.Operation may only be performed on working environments whose status is: ON, DEGRADED

POST /vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

PathParameter

svmName

true

string

PathParameter

volumeName

true

string

BodyParameter

body

Create snapshot request

true

SnapshotCreateRequest

Consumes
  • application/json

Produces
  • application/json

Deletes an existing volume.Operation may only be performed on working environments whose status is: ON, DEGRADED

DELETE /vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

PathParameter

svmName

true

string

PathParameter

volumeName

true

string

Consumes
  • application/json

Produces
  • application/json

Modify an existing volume.Operation may only be performed on working environments whose status is: ON, DEGRADED

PUT /vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

PathParameter

svmName

true

string

PathParameter

volumeName

true

ref

BodyParameter

body

Modify volume request

true

VolumeModifyRequest

Consumes
  • application/json

Produces
  • application/json

Creates a new volume. If the properties aggregateName and maxNumOfDisksApprovedToAdd are not filled in, then the response will fail with a suggested aggregate name and the number of disks that will need to be created in order to fulfill the request.Operation may only be performed on working environments whose status is: ON, DEGRADED

POST /vsa/volumes
Parameters
Type Name Description Required Schema Default

QueryParameter

createAggregateIfNotFound

On create volume request, allow creating not-found aggregate

false

boolean

BodyParameter

body

Create volume request

true

VsaVolumeCreateRequest

Consumes
  • application/json

Produces
  • application/json

Retrieves volumes.Operation may only be performed on working environments whose status is: ON, DEGRADED

GET /vsa/volumes
Parameters
Type Name Description Required Schema Default

QueryParameter

workingEnvironmentId

Filter volumes by this working environment

true

string

Responses
HTTP Code Description Schema

default

success

VolumeResponse array

Consumes
  • application/json

Produces
  • application/json

Return a list of snapshot descriptions for the volume.Operation may only be performed on working environments whose status is: ON, DEGRADED

GET /vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshots
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

PathParameter

svmName

true

string

PathParameter

volumeName

true

string

Responses
HTTP Code Description Schema

default

success

[SnapshotResponse] array

Consumes
  • application/json

Produces
  • application/json

Clones an existing volume.Operation may only be performed on working environments whose status is: ON, DEGRADED

POST /vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/clone
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

PathParameter

svmName

true

string

PathParameter

volumeName

true

string

BodyParameter

body

true

VolumeCloneRequest

Consumes
  • application/json

Produces
  • application/json

Move an existing volume.Operation may only be performed on working environments whose status is: ON, DEGRADED

POST /vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/move
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

PathParameter

svmName

true

string

PathParameter

volumeName

true

string

BodyParameter

body

true

VolumeMoveRequest

Consumes
  • application/json

Produces
  • application/json

Vsa:working-environments

Setup NTP server.Operation may only be performed on working environments whose status is: ON, DEGRADED

POST /vsa/working-environments/{workingEnvironmentId}/ntp
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

NTP Configuration request

true

NTPConfigurationRequest

Consumes
  • application/json

Produces
  • application/json

Starts a specific Cloud Volumes ONTAP instance.Operation may only be performed on working environments whose status is: OFF

POST /vsa/working-environments/{workingEnvironmentId}/start
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Consumes
  • application/json

Produces
  • application/json

Enable capacity tiering.Operation may only be performed on working environments whose status is: ON

POST /vsa/working-environments/{workingEnvironmentId}/enable-capacity-tiering
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

Enable capacity tiering request

true

EnableCapacityTieringRequest

Consumes
  • application/json

Produces
  • application/json

Disable FPolicy for ransomeware files.Operation may only be performed on working environments whose status is: ON, DEGRADED

PUT /vsa/working-environments/{workingEnvironmentId}/disable-fpolicy
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

Consumes
  • application/json

Produces
  • application/json

Retrieves a list of versions to which this Cloud Volumes ONTAP can be upgraded.Operation may only be performed on working environments whose status is: ON

GET /vsa/working-environments/{workingEnvironmentId}/occm-provided-upgrade-versions
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Responses
HTTP Code Description Schema

default

success

OntapUpdateImageMetadata array

Consumes
  • application/json

Produces
  • application/json

Registers a Cloud Volumes ONTAP system with NetApp.Operation may only be performed on working environments whose status is: ON

POST /vsa/working-environments/{workingEnvironmentId}/support-registration
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

QueryParameter

nssAccountId

false

string

Responses
HTTP Code Description Schema

default

success

SupportRegistrationResponse

Consumes
  • application/json

Produces
  • application/json

Retrieves the support registration status of a Cloud Volumes ONTAP system.Operation may only be performed on working environments whose status is: ON

GET /vsa/working-environments/{workingEnvironmentId}/support-registration
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Responses
HTTP Code Description Schema

default

success

SupportRegistrationResponse

Consumes
  • application/json

Produces
  • application/json

Working Environment Ontap Saving.Operation may only be performed on working environments whose status is: ON, DEGRADED

GET /vsa/working-environments/{workingEnvironmentId}/ontap-saving
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Responses
HTTP Code Description Schema

default

success

WorkingEnvironmentOntapSavingResponse

Consumes
  • application/json

Produces
  • application/json

Retrieves images already installed on the Cloud Volumes ONTAP.Operation may only be performed on working environments whose status is: ON, DEGRADED

GET /vsa/working-environments/{workingEnvironmentId}/ontap-available-images
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Responses
HTTP Code Description Schema

default

success

UpdateLocalImage array

Consumes
  • application/json

Produces
  • application/json

Modify the net port broadcast domain mtu of the Cloud Volumes ONTAP.Operation may only be performed on working environments whose status is: ON, DEGRADED

PUT /vsa/working-environments/{workingEnvironmentId}/networkOptimization
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

Use optimization

true

ChangeNetworkOptimizationRequest

Consumes
  • application/json

Produces
  • application/json

Modify user tags for cloud resources of a given Cloud Volumes ONTAP instance.Operation may only be performed on working environments whose status is: ON, DEGRADED, OFF

PUT /vsa/working-environments/{workingEnvironmentId}/user-tags
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

Modify user tags request

true

ModifyUserTagsRequest

Consumes
  • application/json

Produces
  • application/json

Retrieves editable tags for cloud resources of a given Cloud Volumes ONTAP instance.Operation may only be performed on working environments whose status is: ON, DEGRADED, OFF

GET /vsa/working-environments/{workingEnvironmentId}/user-tags
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Responses
HTTP Code Description Schema

default

success

UserTagsResponse

Consumes
  • application/json

Produces
  • application/json

Stops a specific Cloud Volumes ONTAP instance.Operation may only be performed on working environments whose status is: ON, DEGRADED

POST /vsa/working-environments/{workingEnvironmentId}/stop
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

QueryParameter

takeSnapshots

Take snapshots before stopping Cloud Volumes ONTAP

true

boolean

true

Consumes
  • application/json

Produces
  • application/json

Set schedules for Cloud Volumes ONTAP.

PUT /vsa/working-environments/{workingEnvironmentId}/schedules
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

Cloud Volumes ONTAP working environment update schedule request

true

VsaSchedulesRequest

Consumes
  • application/json

Produces
  • application/json

List start-stop schedules for Cloud Volumes ONTAP.

GET /vsa/working-environments/{workingEnvironmentId}/schedules
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Responses
HTTP Code Description Schema

default

success

VsaSchedule array

Consumes
  • application/json

Produces
  • application/json

Setup a new CIFS using workgroup configuration to an existing Cloud Volumes ONTAP working environment.Operation may only be performed on working environments whose status is: ON, DEGRADED

POST /vsa/working-environments/{workingEnvironmentId}/cifs-workgroup
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

CIFS Configuration request

true

CIFSWorkgroupConfigurationRequest

Consumes
  • application/json

Produces
  • application/json

Creates a new Cloud Volumes ONTAP working environment. Refer to the API Developers Guide in order to understand how to fill in the values for region, licenseType, instanceType and version.

POST /vsa/working-environments
Parameters
Type Name Description Required Schema Default

BodyParameter

body

Working environment

true

CreateVSAWorkingEnvironmentRequest

Responses
HTTP Code Description Schema

default

success

VsaWorkingEnvironmentResponse

Consumes
  • application/json

Produces
  • application/json

Retrieves Cloud Volumes ONTAP working environments visible to the currently logged in user.

GET /vsa/working-environments
Parameters
Type Name Description Required Schema Default

QueryParameter

fields

false

string

QueryParameter

tenantId

false

string

Responses
HTTP Code Description Schema

default

success

VsaWorkingEnvironmentResponse array

Consumes
  • application/json

Produces
  • application/json

Create snapshot policy.Operation may only be performed on working environments whose status is: ON, DEGRADED

POST /vsa/working-environments/{workingEnvironmentId}/snapshot-policy
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

BodyParameter

body

Create snapshot policy request

true

SnapshotPolicyCreateRequest

Consumes
  • application/json

Produces
  • application/json

Retrieves action parameters used in create request of a given Cloud Volumes ONTAP instance.

GET /vsa/working-environments/{workingEnvironmentId}/create-request-parameters
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Responses
HTTP Code Description Schema

default

success

CreateRequestParametersResponse

Consumes
  • application/json

Produces
  • application/json

Updates Cloud Manager password of a specific Cloud Volumes ONTAP.Operation may only be performed on working environments whose status is: ON

PUT /vsa/working-environments/{workingEnvironmentId}/update-credentials
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

Update Cloud Manager password request

true

UpdateCredentialsRequest

Consumes
  • application/json

Produces
  • application/json

Performs a complete image update operation on the single node of the specified Cloud Volumes ONTAP.Operation may only be performed on working environments whose status is: ON

POST /vsa/working-environments/{workingEnvironmentId}/update-image
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

Update system image request

true

UpdateSystemImageRequest

Consumes
  • application/json

Produces
  • application/json

Sets the writing speed for Cloud Volumes ONTAP.Operation may only be performed on working environments whose status is: ON

PUT /vsa/working-environments/{workingEnvironmentId}/writing-speed
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

Writing speed request

true

WritingSpeedRequest

Consumes
  • application/json

Produces
  • application/json

Activate FPolicy for ransomeware files.Operation may only be performed on working environments whose status is: ON, DEGRADED

PUT /vsa/working-environments/{workingEnvironmentId}/activate-fpolicy
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

Consumes
  • application/json

Produces
  • application/json

Activate snapshot policy assignment to all not protected rw volumes.Operation may only be performed on working environments whose status is: ON, DEGRADED

PUT /vsa/working-environments/{workingEnvironmentId}/activate-snapshot-policy
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Consumes
  • application/json

Produces
  • application/json

Change tier level.Operation may only be performed on working environments whose status is: ON, DEGRADED

POST /vsa/working-environments/{workingEnvironmentId}/change-tier-level
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

Change tier level request

true

ChangeTierLevelRequest

Consumes
  • application/json

Produces
  • application/json

Working Environment Cost And Usage.

GET /vsa/working-environments/{workingEnvironmentId}/cost-and-usage
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

QueryParameter

start

cost and usage start period

false

string

QueryParameter

end

cost and usage end period

false

string

Responses
HTTP Code Description Schema

default

success

WorkingEnvironmentCostAndUsageResponse

Consumes
  • application/json

Produces
  • application/json

Sets the cluster password of a specific Cloud Volumes ONTAP.

PUT /vsa/working-environments/{workingEnvironmentId}/set-password
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

QueryParameter

occmOnly

false

boolean

BodyParameter

body

Set password request

true

PasswordWrapper

Consumes
  • application/json

Produces
  • application/json

Modify the svm name of the Cloud Volumes ONTAP.Operation may only be performed on working environments whose status is: ON

PUT /vsa/working-environments/{workingEnvironmentId}/svm
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

Svm name modification request

true

SvmNameModificationRequest

Consumes
  • application/json

Produces
  • application/json

Update Backup to S3 Service settings.Operation may only be performed on working environments whose status is: ON, DEGRADED

PUT /vsa/working-environments/{workingEnvironmentId}/cbs-settings
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

BodyParameter

body

true

CbsInfo

Consumes
  • application/json

Produces
  • application/json

Sets the instance type of a specific Cloud Volumes ONTAP.Operation may only be performed on working environments whose status is: ON, OFF

PUT /vsa/working-environments/{workingEnvironmentId}/license-instance-type
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

Instance type modification request

true

LicenseAndInstanceTypeModificationRequest

Consumes
  • application/json

Produces
  • application/json

Retrieves all license types and their associated instance types for a given Cloud Volumes ONTAP instance.

GET /vsa/working-environments/{workingEnvironmentId}/license-instance-type
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Responses
HTTP Code Description Schema

default

success

LicenseAndInstanceType array

Consumes
  • application/json

Produces
  • application/json

Parses an uploaded Cloud license file.

POST /vsa/working-environments/parse-license-file
Parameters
Type Name Description Required Schema Default

HeaderParameter

filename

Cloud license file name

false

string

BodyParameter

license

license

false

string

Responses
HTTP Code Description Schema

default

success

ProvidedLicenseResponse

Consumes
  • multipart/form-data

Produces
  • application/json

Activate offbox configuration.Operation may only be performed on working environments whose status is: ON

PUT /vsa/working-environments/{workingEnvironmentId}/offbox
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Consumes
  • application/json

Produces
  • application/json

Uploads a Cloud license file content on the provided Cloud Volumes ONTAP.Operation may only be performed on working environments whose status is: ON

POST /vsa/working-environments/{workingEnvironmentId}/upload-licenses
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

license file content request

true

LicenseFileContent

Consumes
  • application/json

Produces
  • application/json

Deletes an existing Cloud Volumes ONTAP working environment, including all Cloud resources created for this working environment (unless the localDelete flag is set to true).

DELETE /vsa/working-environments/{workingEnvironmentId}
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

QueryParameter

localDelete

If true, the Cloud Volumes ONTAP instance is not terminated in Cloud, but Cloud Manager no longer manages the working environment.

false

boolean

false

QueryParameter

forceDelete

If true, the working environment will be deleted even if it is part of one or more SnapMirror relationships.

false

boolean

false

Consumes
  • application/json

Produces
  • application/json

Retrieves an Cloud Volumes ONTAP working environment.

GET /vsa/working-environments/{workingEnvironmentId}
Parameters
Type Name Description Required Schema Default

QueryParameter

fields

false

string

PathParameter

workingEnvironmentId

true

string

Responses
HTTP Code Description Schema

default

success

VsaWorkingEnvironmentResponse

Consumes
  • application/json

Produces
  • application/json

Setup a new CIFS Configuration to an existing Cloud Volumes ONTAP working environment.Operation may only be performed on working environments whose status is: ON, DEGRADED

POST /vsa/working-environments/{workingEnvironmentId}/cifs
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

CIFS Configuration request

true

CIFSConfigurationRequest

Consumes
  • application/json

Produces
  • application/json

Retrieves CIFS Configuration to an existing Cloud Volumes ONTAP working environment.Operation may only be performed on working environments whose status is: ON, DEGRADED

GET /vsa/working-environments/{workingEnvironmentId}/cifs
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Responses
HTTP Code Description Schema

default

success

CIFSConfigurationResponse array

Consumes
  • application/json

Produces
  • application/json

Retrieves eligibility support status of a Cloud Volumes ONTAP system. Valid values - NSS_NOT_VALID, NOT_REGISTERED, IPA_PROBLEM, VALID, NSS_NOT_EXISTS, LICENSE_EXPIRED.Operation may only be performed on working environments whose status is: ON, UPDATING

GET /vsa/working-environments/{workingEnvironmentId}/update-eligibility
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

Responses
HTTP Code Description Schema

200

success

EligibilityResponse

400

Working Environment must be ON or UPDATING in order to check eligibility

No Content

Consumes
  • application/json

Produces
  • application/json

Uploads a Cloud license file on the provided Cloud Volumes ONTAP.Operation may only be performed on working environments whose status is: ON

POST /vsa/working-environments/{workingEnvironmentId}/upload-license-file
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

HeaderParameter

filename

Cloud license file name

false

string

BodyParameter

license

license

false

string

Consumes
  • multipart/form-data

Produces
  • application/json

Manually triggers subscription sync for all Cloud Volumes ONTAP working environments.Operation may only be performed on working environments whose status is: ON

POST /vsa/working-environments/sync-subscription
Consumes
  • application/json

Produces
  • application/json

Change serial number of Cloud Volumes ONTAP.Operation may only be performed on working environments whose status is: ON

POST /vsa/working-environments/{workingEnvironmentId}/change-serial
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

Change serial number request

true

ChangeSerialNumberRequest

Consumes
  • application/json

Produces
  • application/json

Delete FPolicy for ransomeware files.Operation may only be performed on working environments whose status is: ON, DEGRADED

DELETE /vsa/working-environments/{workingEnvironmentId}/fpolicy
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string

Consumes
  • application/json

Produces
  • application/json

Working-environments

Retrieves all working environments.

GET /working-environments
Parameters
Type Name Description Required Schema Default

QueryParameter

tenantId

Filter working environments by tenantId. Required for Oncloud Admin if performing operation requesting specific fields

false

string

QueryParameter

fields

false

string

Responses
HTTP Code Description Schema

default

success

WorkingEnvironments

Consumes
  • application/json

Produces
  • application/json

Returns all non prem working environment actions required in a given tenant.

GET /working-environments/actionRequired/{tenantId}
Parameters
Type Name Description Required Schema Default

PathParameter

tenantId

Public Id of tenant

true

string

Responses
HTTP Code Description Schema

default

success

TenantActionsRequiredResponse

Consumes
  • application/json

Produces
  • application/json

Returns true if working environment with that name already exists, false otherwise.

GET /working-environments/exists/{workingEnvironmentName}
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentName

Working environment name

true

string

Responses
HTTP Code Description Schema

default

success

boolean

Consumes
  • application/json

Produces
  • application/json

Definitions

This section describes existing data format definitions.

About

Name Description Required Schema Default

version

true

string

build

true

string

buildTimestamp

true

integer (int64)

systemId

true

string

environment

true

string

siteIdentifier

true

SiteIdentifier

serverTimeZone

true

ServerTimeZone

beta

true

boolean

releaseNumber

true

integer (int32)

simplicatorUrl

true

string

migrationPerformed

true

boolean

demoMode

true

boolean

AccountWorkingEnvironmentResponse

Name Description Required Schema Default

publicId

true

string

name

true

string

workingEnvironmentType

true

string

ActionRequired

Name Description Required Schema Default

actionType

The type of the Action

true

string

parameters

The relevant parameters of the action

true

ActionRequiredParameters

severity

Action Severity

true

string

ActionRequiredParameters

Name Description Required Schema Default

aggregateName

Aggregate name

true

string

numOfDisks

Number of disks relevant to the action

true

integer (int32)

diskSize

The size of the disks needed

true

Capacity

volumeNames

A limited list of volumes on the aggregate

true

string array

maxCapacity

The maximum capacity of the Cloud Volumes ONTAP instance

true

Capacity

licenseExpiryDate

License expiry date

true

integer (int64)

serialNumber

Platform Serial number

true

string

volumeMoveParameters

Volume Move Parameters

false

VolumeMoveParameters

workingEnvironmentId

Working environment public id

true

string

licenseParameters

License and instance parameters

false

ChangeLicenseParameters

resourcesToDelete

Resources to delete if not been utilized

false

ResourcesToDelete

instances

Instances info

true

InstanceNameIdAndType array

moreInfo

More info

false

string

providerVolumeType

Provider volume type

false

string

volumeInfo

volume Information

false

VolumeInfo

currentInstanceType

Current instance type

false

string

ActionRequiredResponse

Name Description Required Schema Default

actionRequired

true

ActionRequired

affectedVolumes

true

string array

ActiveDirectoryCheckConnectionRequest

Name Description Required Schema Default

host

host

true

string

port

port

true

integer (int32)

userName

user name

true

string

password

password

true

string

ActiveDirectoryCreateRequest

Name Description Required Schema Default

name

connection name

true

string

host

host

true

string

port

port

true

integer (int32)

ActiveDirectoryEntry

Name Description Required Schema Default

id

false

integer (int32)

publicId

false

string

name

false

string

host

false

string

port

false

integer (int32)

ActiveDirectoryUpdateRequest

Name Description Required Schema Default

name

false

string

host

false

string

port

false

integer (int32)

AddDisksToAggregateRequest

Name Description Required Schema Default

numberOfDisks

Number of Disks

true

integer (int32)

AddPortalUserRequest

Name Description Required Schema Default

email

User email address

true

string

roleId

Role ID of the user

true

string

tenantId

Tenant ID of the user

false

string

AddTagsRequest

Name Description Required Schema Default

tags

Tags

true

AwsTag array

AddTenantRequest

Name Description Required Schema Default

name

Tenant name

true

string

description

Tenant description

false

string

costCenter

Tenant cost center

false

string

nssKeys

NSS keys

false

SetNssKeysRequest

AggregateResponse

Name Description Required Schema Default

name

Aggregate name

true

string

availableCapacity

Available capacity

true

Capacity

totalCapacity

Total capacity

true

Capacity

usedCapacity

Used capacity

true

Capacity

volumes

Volumes

true

Volume array

providerVolumes

Provider volumes

true

ProviderVolumeResponse array

disks

Disks

true

Disk array

state

State

true

string

encryptionType

Encryption Type

true

string

encryptionKeyId

Encryption Key

false

string

homeNode

Home node

true

string

ownerNode

Owner node

true

string

capacityTier

Capacity tier

false

enum (S3, Blob, cloudStorage)

capacityTierUsed

Object store used

false

Capacity

sidlEnabled

SIDL enabled

true

boolean

snaplockType

Snaplock type

true

enum (non_snaplock, compliance, enterprise)

root

true

boolean

AssociatedSubscription

Name Description Required Schema Default

subscriptionId

true

string

name

true

string

default

true

boolean

AssumeRole

Name Description Required Schema Default

roleName

true

string

accountId

true

string

AsupConfiguration

Name Description Required Schema Default

enabled

true

boolean

site

true

string

company

true

string

hostName

true

string

os

true

string

schedule

true

AsupSchedule

url

true

string

AsupConfigurationRequest

Name Description Required Schema Default

enabled

true

boolean

schedule

false

AsupSchedule

AsupInterval

Name Description Required Schema Default

length

true

integer (int32)

unit

true

string

AsupSchedule

Name Description Required Schema Default

dayOfWeek

true

integer (int32)

hourOfDay

true

integer (int32)

interval

true

AsupInterval

minuteOfHour

true

integer (int32)

AuditGroupSummary

Name Description Required Schema Default

_id

false

integer (int32)

id

Audit group public ID

false

string

requestId

Request ID of action associated with audit group

false

string

startDate

Start date

false

integer (int64)

endDate

End date

false

integer (int64)

actionName

Audit group name

false

string

status

Audit group status

false

string

userName

Name of user who performed the action

false

string

tenantName

Name of tenant

false

string

workingEnvironmentName

Name of working environment related to the user action

false

string

actionParameters

Parameters of the user action

false

string

records

List of audit records

false

AuditGroupSummaryRecord array

errorMessage

Audit failure information (if relevant)

false

string

version

Version of Cloud Manager used to create this audit

false

string

parentId

false

integer (int32)

containsFailedRecords

false

boolean

AuditGroupSummaryRecord

Name Description Required Schema Default

id

Audit record public ID

false

string

date

Date

false

integer (int64)

actionName

Action

false

string

status

Status

false

string

parameters

Action parameters

false

string

errorMessage

Audit failure information (if relevant)

false

string

count

Aggregated count of similar records

false

integer (int32)

Auth0Information

Name Description Required Schema Default

domain

true

string

audience

true

string

clientId

true

string

AvailableIpsResponse

Name Description Required Schema Default

availableIps

true

integer (int32)

AwsAccessKeys

Name Description Required Schema Default

accessKey

false

string

secretKey

false

string

AwsAccountRequest

Name Description Required Schema Default

accountName

true

string

providerKeys

true

AwsKeysRequest

AwsAccountResponse

Name Description Required Schema Default

publicId

true

string

accountName

true

string

accountType

true

string

accountId

true

string

accessKey

true

string

assumeRole

false

AssumeRole

occmRole

false

string

vsaList

true

AccountWorkingEnvironmentResponse array

AwsDisksConstraints

Name Description Required Schema Default

numReservedDisksSingleNode

true

integer (int32)

numReservedDisksHa

true

integer (int32)

maxDisksSingleNode

true

integer (int32)

maxDisksHa

true

integer (int32)

numDisksWarnSingleNode

true

integer (int32)

numDisksWarnHa

true

integer (int32)

aggregatesNumToDiskSize

true

AggregateNumToDiskSize array

maxDisksSingleNodeKvm

true

integer (int32)

maxDisksHaKvm

true

integer (int32)

deltaDiskWarn

true

integer (int32)

AggregateNumToDiskSize

Name Description Required Schema Default

from

false

integer (int32)

to

true

integer (int32)

stepsUp

true

integer (int32)

AwsEncryption

Name Description Required Schema Default

kmsKeyId

false

string

kmsKeyArn

false

string

AwsEncryptionKey

Name Description Required Schema Default

alias

false

string

keyId

true

string

status

true

string

validTo

false

integer (int64)

origin

false

string

default

true

boolean

AwsHaFloatingIpValidationData

Name Description Required Schema Default

floatingIps

true

AwsHaFloatingIpValidationData:FloatingIps

routeTablesIds

true

string array

vpcId

true

string

region

true

string

roleArn

false

string

cloudProviderAccountId

false

string

AwsHaFloatingIpValidationResponse

Name Description Required Schema Default

result

true

boolean

reasons

true

string array

AwsKeysRequest

Name Description Required Schema Default

awsAccessKeys

false

AwsAccessKeys

assumeRoleArn

false

string

AwsProperties

Name Description Required Schema Default

regionName

true

string

availabilityZones

true

string array

instances

true

InstanceResponse array

vpc

true

VpcBasicResponse

accountId

true

string

roleArn

false

string

cloudProviderAccountId

false

string

AwsTag

Name Description Required Schema Default

tagKey

true

string

tagValue

false

string

AwsValidateSubscribedToOntapCloudRequest

Name Description Required Schema Default

region

true

string

subnetId

true

string

vsaMetadata

true

VsaMetadataRequest

roleArn

false

string

cloudProviderAccount

false

string

securityGroupId

false

string

AwsValidateSubscribedToOntapCloudResponse

Name Description Required Schema Default

failureInfo

false

string

subscribed

true

boolean

AzureAccountRequest

Name Description Required Schema Default

accountName

true

string

providerKeys

true

AzureKeys

AzureAccountResponse

Name Description Required Schema Default

publicId

true

string

accountName

true

string

accountType

true

string

tenantId

true

string

applicationId

true

string

occmRole

false

string

vsaList

true

AccountWorkingEnvironmentResponse array

AzureAvailabilitySet

Name Description Required Schema Default

faultDomain

true

integer (int32)

updateDomain

true

integer (int32)

AzureDiskSize

Name Description Required Schema Default

size

true

Capacity

description

true

string

supportedOccmLicenses

true

string array

default

true

boolean

AzureDisksConstraints

Name Description Required Schema Default

numReservedDisksSingleNode

true

integer (int32)

AzureHaNodeInfo

Name Description Required Schema Default

instanceName

true

string

instanceId

true

string

primaryIp

true

string

state

true

string

serialNumber

true

string

availabilitySet

true

AzureAvailabilitySet

AzureHaParameters

Name Description Required Schema Default

platformSerialNumberNode1

false

string

platformSerialNumberNode2

false

string

AzureHaProperties

Name Description Required Schema Default

loadBalancerName

true

string

node1Info

true

AzureHaNodeInfo

node2Info

true

AzureHaNodeInfo

AzureKeys

Name Description Required Schema Default

tenantId

true

string

applicationId

true

string

applicationKey

true

string

AzureNetworkExtendedResponse

Name Description Required Schema Default

virtualNetworks

true

AzureVirtualNetworkResponse array

securityGroups

true

AzureSecurityGroupResponse array

AzureNetworkRequirementsResponse

Name Description Required Schema Default

vsaMinimumRequiredIps

true

integer (int32)

haVsaMinimumRequiredIps

true

integer (int32)

AzureRegionResponse

Name Description Required Schema Default

displayName

true

string

name

true

string

vnets

false

AzureNetworkExtendedResponse

AzureResourceGroupResponse

Name Description Required Schema Default

name

true

string

location

true

string

tags

true

Map[string,string]

AzureSecurityGroupResponse

Name Description Required Schema Default

id

Security Group Id

true

string

name

Security Group Name

true

string

resourceGroup

Resource Group

true

string

AzureStorageAccountTypeResponse

Name Description Required Schema Default

diskType

true

string

availabilityTypes

true

string array

sizes

true

AzureDiskSize array

AzureSubnetResponse

Name Description Required Schema Default

id

Subnet Id

true

string

cidr

CIDR

true

string

name

Subnet name

true

string

availableIps

The number of available IPs on the subnet

true

integer (int32)

minimumRequiredIps

The minimum needed IP addresses for the Cloud Volumes ONTAP creation

true

integer (int32)

AzureTag

Name Description Required Schema Default

tagKey

true

string

tagValue

false

string

AzureValidateSubscribedToOntapCloudRequest

Name Description Required Schema Default

region

true

string

vsaMetadata

true

VsaMetadataRequest

subscriptionId

false

string

cloudProviderAccount

false

string

AzureValidateSubscribedToOntapCloudResponse

Name Description Required Schema Default

failureInfo

false

string

subscribed

true

boolean

AzureVirtualNetworkCidrData

Name Description Required Schema Default

cidr

CIDR

true

string

subnets

Subnets

true

AzureSubnetResponse array

AzureVirtualNetworkResponse

Name Description Required Schema Default

name

Virtual Network Name

true

string

id

Virtual Network ID

true

string

cidrs

CIDRs

true

AzureVirtualNetworkCidrData array

resourceGroup

Resource Group

true

string

tags

Tags

true

TagResponse array

AzureVsaWorkingEnvironmentResponse

Name Description Required Schema Default

publicId

true

string

name

true

string

tenantId

true

string

svmName

false

string

creatorUserEmail

true

string

status

false

StatusProperties

providerProperties

false

ProviderProperties

reservedSize

false

Capacity

clusterProperties

false

VsaClusterProperties

ontapClusterProperties

false

OntapClusterProperties

cloudProviderName

true

string

snapshotPolicies

false

SnapshotPolicy array

actionsRequired

false

ActionRequired array

activeActions

Actions currently being performed on this working environment

false

string array

replicationProperties

false

ReplicationProperties

schedules

false

VsaSchedule array

svms

false

Svm array

workingEnvironmentType

true

string

supportRegistrationProperties

false

SupportRegistrationProperties

supportRegistrationInformation

false

SupportRegistrationInformation array

capacityFeatures

false

CapacityFeatures

encryptionProperties

false

EncryptionProperties

supportedFeatures

false

SupportedFeatures

haProperties

false

AzureHaProperties

k8sProperties

false

K8sProperties

fpolicyProperties

false

FpolicyProperties

saasProperties

false

CvoSaasProperties

complianceProperties

false

CloudComplianceStatusResponse

hA

true

boolean

BackupToS3Information

Name Description Required Schema Default

enabled

true

boolean

disableReason

false

string

notSubscribedReason

true

boolean

BasicManagedHaParameters

Name Description Required Schema Default

node1SubnetId

true

string

node2SubnetId

true

string

mediatorSubnetId

true

string

BroadcastDomainInfo

Name Description Required Schema Default

broadcastDomain

true

string

ipSpace

true

string

mtu

true

integer (int32)

BucketInformation

Name Description Required Schema Default

bucketName

Bucket’s name

true

string

fullPath

Object’s full path

true

string

CIFSConfigurationRequest

Name Description Required Schema Default

dnsDomain

DNS domain name

true

string

ipAddresses

DNS server ip addresses

true

string array

netBIOS

CIFS server NetBIOS name

true

string

organizationalUnit

Organizational Unit to register in

true

string

activeDirectoryDomain

Active Directory domain name

true

string

activeDirectoryUsername

Active Directory username

true

string

activeDirectoryPassword

Active Directory password

true

string

CIFSConfigurationResponse

Name Description Required Schema Default

dnsDomain

DNS domain name

true

string

activeDirectoryDomain

Active Directory domain name

true

string

ipAddresses

DNS server ip addresses

true

string array

netBIOS

CIFS server NetBIOS name

true

string

organizationalUnit

Organizational Unit to register in

true

string

authenticationType

Authentication type

true

string

CIFSWorkgroupConfigurationRequest

Name Description Required Schema Default

serverName

Workgroup name

true

string

workgroupName

Workgroup name

true

string

Capacity

Name Description Required Schema Default

size

Size

true

number (double)

unit

Unit

true

enum (Byte, KB, MB, GB, TB)

CapacityFeatures

Name Description Required Schema Default

providerVolumesType

true

ProviderVolumeTypeResponse array

defaultProviderVolumeType

true

DefaultProviderVolume

supportedCapacityTiers

true

SupportedCapacityTiers

maxDisksPerAggregate

true

integer (int32)

existingIops

true

integer (int32) array

CapacityTierInfo

Name Description Required Schema Default

capacityTierUsedSize

true

Capacity

s3BucketName

true

string

tierLevel

true

string

CbsBackupInfo

Name Description Required Schema Default

backupName

true

string

backupId

true

string

creationTime

true

string

CbsInfo

Name Description Required Schema Default

cbsEnabled

Backup to S3 enabled

true

boolean

cbsScheduleRules

S3 Backup schedule rules

true

CbsSchedule array

CbsProperties

Name Description Required Schema Default

cbsBackupStatus

true

string

cbsRules

true

CbsSchedule array

numberOfBackedUpVolumes

true

integer (int32)

CbsRelationshipStatus

Name Description Required Schema Default

snapMirrorStatus

true

string

activeStatus

true

boolean

CbsSchedule

Name Description Required Schema Default

snapmirrorLabel

true

string

snapshotsToKeep

true

integer (int32)

CbsVolumeInfoForRestore

Name Description Required Schema Default

workingEnvironmentId

true

string

size

true

PositiveCapacity

snapsotPolicy

true

string

thinVolume

true

boolean

providerDiskType

true

string

providerDiskIops

false

integer (int32)

tieringPolicy

false

string

exportPolicyInfo

false

ExportPolicyInfo

shareInfo

false

CifsShareUserPermissions

CbsVolumeList

Name Description Required Schema Default

volumes

true

CbsVolumeResponse array

totalNumberOfVolumes

true

integer (int32)

CbsVolumeResponse

Name Description Required Schema Default

fileSystemId

true

string

workingEnvironmentName

true

string

workingEnvironmentId

true

string

workingEnvironmentStatus

true

string

volumeName

true

string

volumeStatus

true

string

cifsVolume

true

boolean

backups

true

CbsBackupInfo array

vsaCandidatesForRestore

true

VsaCandidateForCbsRestore array

policy

false

SnapMirrorPolicy

relationshipStatus

false

CbsRelationshipStatus

CertificateResponse

Name Description Required Schema Default

publicId

true

string

directIssuerName

true

string

subjectName

true

string

startDate

true

integer (int64)

endDate

true

integer (int64)

serialNumber

true

string

certificate

true

string

certificateType

true

string

CertificateSigningRequest

Name Description Required Schema Default

commonName

true

string

ChangeInstanceTypeRequest

Name Description Required Schema Default

instanceType

true

string

ChangeLicenseParameters

Name Description Required Schema Default

newLicenseType

true

OntapLicenseType

newInstanceType

true

string

ChangeNetworkOptimizationRequest

Name Description Required Schema Default

optimize

true

boolean

ChangeSerialNumberRequest

Name Description Required Schema Default

nodeOne

true

string

nodeTwo

false

string

ChangeTierLevelRequest

Name Description Required Schema Default

level

Change tier level

true

enum (normal, ia, ia-single, , intelligent, cool)

ChangeVolumeTierRequest

Name Description Required Schema Default

aggregateName

Target aggregate name

true

string

numOfDisks

Number of new disks needed

true

integer (int32)

newAggregate

Is it a newly created aggregate

true

boolean

newDiskTypeName

New disk type name

true

string

newCapacityTier

New capacity tier

false

enum (S3, Blob, cloudStorage)

iops

Provisioned IOPS

false

integer (int32)

newTieringPolicy

New tiering policy

false

enum (none, snapshot_only, auto)

CifsShareInfo

Name Description Required Schema Default

shareName

Share name

true

string

accessControlList

List of CIFS share permissions

true

CifsShareUserPermissions array

CifsShareUserPermissions

Name Description Required Schema Default

permission

CIFS share permission type

true

string

users

List of users with the permission

true

string array

CloudComplianceStatusResponse

Name Description Required Schema Default

scanStatus

true

enum (SCAN_ENABLED, SCAN_DISABLED, DEPLOYING, FEATURE_DISABLED, UNKNOWN)

complianceStatus

false

ComplianceStatusResponse

CloudOntapManifest

Name Description Required Schema Default

ontap_version

true

string

ontap_image_versions_allowed_to_upgrade_from

true

string array

encryption_enabled_instance_types

true

string array

license_to_ami_mapping

true

LicenseToAmis array

CloudProviderAccountResponse

Name Description Required Schema Default

awsAccounts

true

AwsAccountResponse array

azureAccounts

true

AzureAccountResponse array

gcpStorageAccounts

true

GcpAccountResponse array

nssAccounts

true

NssAccountResponse array

CloudResourceTag

Name Description Required Schema Default

tagKey

true

string

tagValue

false

string

CloudSyncConstants

Name Description Required Schema Default

reminderPeriod

true

integer (int32)

warningPeriod

true

integer (int32)

CloudSyncLicenseInformation

Name Description Required Schema Default

cloudSyncLicenseTypes

Cloud Sync License types

true

string array

licenseExpirationDate

Cloud Sync License Expiration Date

false

integer (int64)

CloudSyncProperties

Name Description Required Schema Default

status

false

CloudSyncStatus

dataBrokerProperties

false

DataBrokerProperties

s3Location

false

string

relationships

true

CloudSyncRelationship array

synced

true

boolean

CloudSyncRelationship

Name Description Required Schema Default

volumeName

true

string

svmName

true

string

relationshipStatus

true

string

s3Location

true

string

id

true

string

progress

true

integer (int32)

failureMessage

false

string

CloudSyncStatus

Name Description Required Schema Default

status

true

string

failureMessage

false

string

ClusterCredentialsRequest

Name Description Required Schema Default

userName

true

string

password

true

string

ClusterInfoResponse

Name Description Required Schema Default

serialNumber

true

string

clusterName

true

string

clusterUuid

true

string

ontapVersion

true

string

nodeModels

true

string array

ComplianceStatusResponse

Name Description Required Schema Default

sensitivePersonalHits

true

integer (int32)

personalHits

true

integer (int32)

nonSensitiveHits

true

integer (int32)

ConfigResponse

Name Description Required Schema Default

uri

true

string

status

true

Status

redirected

true

boolean

pollingIntervalSeconds

true

integer (int64)

debugLogLevel

true

string

cacheConfig

true

string

startInstanceDelaySeconds

true

integer (int64)

ConfigValuesResponse

Name Description Required Schema Default

simplicatorUri

true

string

proxyUri

true

string

debugLogLevel

true

string

cacheConfig

true

string

keyManagerPort

true

integer (int32)

ipaManualUrl

true

string

certificateValidityPeriod

true

integer (int32)

maxAggregateFreeSpacePercentage

true

integer (int32)

asupSite

true

string

asupCompany

true

string

maxVolumeGrowSizePercentage

true

integer (int32)

autoVsaCapacityManagement

true

boolean

useVolumeViewAsDefault

true

boolean

proxyUserName

true

string

proxyPassword

true

string

proxyDomain

true

string

autoUpgrade

true

boolean

cotRollback

true

boolean

cloudSyncConstants

true

CloudSyncConstants

licenseMaxCapacityUsedPercentage

true

integer (int32)

s3EbsRatio

true

integer (int32)

ebsSizeToPiopsRatio

true

integer (int32)

autoOntapUpgrade

true

boolean

ConfigValuesUpdateRequest

Name Description Required Schema Default

simplicatorUri

false

string

proxyUri

false

string

debugLogLevel

false

string

cacheConfig

false

string

keyManagerPort

false

integer (int32)

maxAggregateFreeSpacePercentage

false

integer (int32)

maxVolumeGrowSizePercentage

false

integer (int32)

autoVsaCapacityManagement

false

boolean

proxyUserName

false

string

proxyPassword

false

string

proxyDomain

false

string

autoUpgrade

false

boolean

cotRollback

false

boolean

s3EbsRatio

false

integer (int32)

autoOntapUpgrade

false

boolean

Configuration

Name Description Required Schema Default

ontapVersion

false

string

license

false

OntapLicenseType

instanceType

false

string

region

false

Region

defaultInstance

false

boolean

features

false

string array

upgradeableFrom

false

string array

ConnectRequest

Name Description Required Schema Default

ips

Custom export policy list of IPs

true

string array

setDefaultStorageClass

true

boolean

setSanDefaultStorageClass

true

boolean

CostByService

Name Description Required Schema Default

name

Name of the cost domain (compute, disk/blob storage, object storage, data transfer

false

string

total

Saving for this month for that cost domain

false

Money

costByUsage

Cost domain breakdown

false

CostByUsage array

CostByTime

Name Description Required Schema Default

start

Cost period start date

false

string

end

Cost period end date

false

string

estimated

Is the cost estimated

false

boolean

total

Total money saved

false

Money

costByService

Month cost and usage details

false

CostByService array

CostByUsage

Name Description Required Schema Default

name

Breakdown element name

false

string

cost

Saving for that breakdown element

false

Money

usage

Usage details for that breakdown element

false

Usage

CreateAwsHaWorkingEnvironmentRequest

Name Description Required Schema Default

name

true

string

svmPassword

true

string

vpcId

true

string

description

false

string

region

true

string

tenantId

true

string

volume

Optionally create a volume with this working environment

false

VsaVolumeOnNewVsaCreateRequest

ebsVolumeSize

EBS volume size

true

Capacity

ebsVolumeType

EBS volume type

true

enum (gp2, st1, io1)

vsaMetadata

true

VsaMetadataRequest

dataEncryptionType

Type of encryption to use for this working environment

true

enum (NONE, AWS, ONTAP)

ontapEncryptionParameters

Parameters required if using ontap encryption

false

OntapEncryption

awsEncryptionParameters

Parameters required if using aws encryption

false

AwsEncryption

haParams

true

HaParameters

securityGroupId

false

string

skipSnapshots

Take snapshot flag

true

boolean

awsTags

Optionally provide up to four key-value pairs with which to tag all AWS entities created by Cloud Manager

false

AwsTag array

cifsConfigurationRequest

false

CIFSConfigurationRequest

optimizedNetworkUtilization

Use optimized network utilization

false

boolean

clusterKeyPairName

Support SSH using key-pair

false

string

instanceTenancy

Instance tenancy

false

enum (default, dedicated)

failedToCreateWorkingEnvironmentId

Public ID of failed-to-create working environment

false

string

capacityTier

Capacity tier

false

enum (S3)

iops

Provisioned IOPS

false

integer (int32)

packageName

Pre-configured package name

false

string

instanceProfileName

Instance profile name

false

string

svmName

Svm name

false

string

wormRequest

WORM request

false

WormRequest

cloudProviderAccount

Cloud Provider Account

false

string

nssAccount

Nss Account

false

string

saasSubscriptionId

SaaS Subscription ID

false

string

backupVolumesToCbs

Automatically backup all volumes to S3

false

boolean

ontapEncryptionDefined

true

boolean

CreateAzureNetappFileVolumeDetailsRequest

Name Description Required Schema Default

name

true

string

protocol

true

string

exportRuleIp

true

string

size

true

integer (int64)

CreateAzureNetappFileVolumePlacementRequest

Name Description Required Schema Default

subscription

true

string

account

true

string

resourceGroup

true

string

pool

true

string

subnet

true

string

CreateAzureNetappFileVolumeRequest

Name Description Required Schema Default

placement

true

CreateAzureNetappFileVolumePlacementRequest

details

true

CreateAzureNetappFileVolumeDetailsRequest

CreateAzureVSAWorkingEnvironmentRequest

Name Description Required Schema Default

name

true

string

svmPassword

true

string

vnetId

true

string

cidr

true

string

description

false

string

volume

Optionally create a volume with this working environment

false

VsaVolumeOnNewVsaCreateRequest

region

true

string

tenantId

true

string

subnetId

Subnet ID for a single node cluster

true

string

dataEncryptionType

Type of encryption to use for this working environment

true

enum (NONE, AZURE, ONTAP)

ontapEncryptionParameters

Parameters required if using ontap encryption

false

OntapEncryption

securityGroupId

false

string

serialNumber

false

string

cifsConfigurationRequest

false

CIFSConfigurationRequest

skipSnapshots

Take snapshot flag

true

boolean

diskSize

Disk size

true

Capacity

storageType

Storage type

true

enum (Standard_LRS, Premium_LRS , StandardSSD_LRS)

azureTags

Optionally provide up to four key-value pairs with which to tag the Resource group created by Cloud Manager

false

AzureTag array

writingSpeedState

Writing speed state

false

string

vsaMetadata

true

VsaMetadataRequest

failedToCreateWorkingEnvironmentId

Public ID of failed-to-create working environment

false

string

packageName

Pre-configured package name

false

string

vhdImageRequest

Optionally provide parameters for VHD image deployment

false

VhdImageRequest

resourceGroup

Custom resource group name

false

string

subscriptionId

Subscription Id

false

string

capacityTier

Capacity tier

false

enum (Blob)

haParams

false

AzureHaParameters

allowDeployInExistingRg

Allow Deploy In Existing Resource Group

false

boolean

svmName

Svm name

false

string

wormRequest

WORM request

false

WormRequest

cloudProviderAccount

Cloud Provider Account

false

string

nssAccount

Nss Account

false

string

saasSubscriptionId

SaaS Subscription ID

false

string

storageAccountPrefix

Storage Account prefix

false

string

CreateCifsShareInfoRequest

Name Description Required Schema Default

shareName

Share name

true

string

accessControl

CIFS share permissions

true

CifsShareUserPermissions

CreateGcpVsaWorkingEnvironmentRequest

Name Description Required Schema Default

name

true

string

svmPassword

true

string

vpcId

true

string

volume

Optionally create a volume with this working environment

false

VsaVolumeOnNewVsaCreateRequest

region

true

string

tenantId

true

string

subnetPath

Subnet path for a single node cluster

false

string

subnetId

Subnet ID for a single node cluster

true

string

firewallRule

Firewall name for a single node cluster

false

string

firewallTagNameRule

Firewall tag name for a single node cluster

false

string

dataEncryptionType

Type of encryption to use for this working environment

true

enum (GCP)

securityGroupId

false

string

vsaMetadata

true

VsaMetadataRequest

cifsConfigurationRequest

false

CIFSConfigurationRequest

serialNumber

Serial number for BYOL

false

string

skipSnapshots

Take snapshot flag

true

boolean

gcpVolumeSize

GCP volume size

true

Capacity

gcpVolumeType

GCP volume type

true

enum (pd-standard, pd-ssd)

gcpLabels

Optionally provide up to four key-value pairs with which to all GCP entities created by Cloud Manager

false

GcpLabel array

writingSpeedState

Writing speed state

false

string

failedToCreateWorkingEnvironmentId

Public ID of failed-to-create working environment

false

string

capacityTier

Capacity tier

false

enum (cloudStorage)

packageName

Pre-configured package name

false

string

svmName

Svm name

false

string

wormRequest

WORM request

false

WormRequest

nssAccount

NSS account

false

string

gcpStorageAccount

Gcp Storage account

false

string

saasSubscriptionId

SaaS Subscription ID

false

string

cloudProviderAccount

false

string

project

Gcp Optional Project

false

string

gcpEncryptionParameters

Parameters required if using gcp encryption with custom key

false

GcpEncryption

providedImage

Provided external CVO image

false

string

CreateReplicationRequestToOnPrem

Name Description Required Schema Default

replicationRequest

Replication Request

true

ReplicationRequest

replicationVolume

Replication volume

true

OnPremVolumeRequest

CreateReplicationRequestToVsa

Name Description Required Schema Default

replicationRequest

Replication Request

true

ReplicationRequest

replicationVolume

Replication volume

true

VsaVolumeRequest

CreateRequestParametersResponse

Name Description Required Schema Default

parameters

false

Map[string,any]

CreateSyncRequest

Name Description Required Schema Default

volumeNames

Volume’s name

true

string array

s3Location

S3 path location (i.e. s3://BucketName/Folder1/Folder11), maximum length - 255 characters

true

string

dataBrokerNetworkInformation

Data Broker Network information

true

DataBrokerNetworkInformation

CreateVSAWorkingEnvironmentRequest

Name Description Required Schema Default

name

true

string

svmPassword

true

string

vpcId

true

string

description

false

string

volume

Optionally create a volume with this working environment

false

VsaVolumeOnNewVsaCreateRequest

region

true

string

tenantId

true

string

subnetId

Subnet ID for a single node cluster

true

string

dataEncryptionType

Type of encryption to use for this working environment

true

enum (NONE, AWS, ONTAP)

ontapEncryptionParameters

Parameters required if using ontap encryption

false

OntapEncryption

awsEncryptionParameters

Parameters required if using aws encryption

false

AwsEncryption

securityGroupId

false

string

vsaMetadata

true

VsaMetadataRequest

cifsConfigurationRequest

false

CIFSConfigurationRequest

skipSnapshots

Take snapshot flag

true

boolean

ebsVolumeSize

EBS volume size

true

Capacity

ebsVolumeType

EBS volume type

true

enum (gp2, st1, sc1, io1)

awsTags

Optionally provide up to four key-value pairs with which to tag all AWS entities created by Cloud Manager

false

AwsTag array

writingSpeedState

Writing speed state

false

string

optimizedNetworkUtilization

Use optimized network utilization

false

boolean

clusterKeyPairName

Support SSH using key-pair

false

string

instanceTenancy

Instance tenancy

false

enum (default, dedicated)

failedToCreateWorkingEnvironmentId

Public ID of failed-to-create working environment

false

string

capacityTier

Capacity tier

false

enum (S3)

iops

Provisioned IOPS

false

integer (int32)

packageName

Pre-configured package name

false

string

instanceProfileName

Instance profile name

false

string

svmName

Svm name

false

string

wormRequest

WORM request

false

WormRequest

cloudProviderAccount

Cloud Provider Account

false

string

nssAccount

Nss Account

false

string

saasSubscriptionId

SaaS Subscription ID

false

string

backupVolumesToCbs

Automatically backup all volumes to S3

false

boolean

ontapEncryptionDefined

true

boolean

CronJobSchedule

Name Description Required Schema Default

name

true

string

description

true

string

months

true

integer (int32) array

days

true

integer (int32) array

weekDays

true

integer (int32) array

hours

true

integer (int32) array

minutes

true

integer (int32) array

CronJobScheduleResponse

Name Description Required Schema Default

months

List of months

true

integer (int32) array

days

List of days of the month

true

integer (int32) array

weekDays

List of week days

true

integer (int32) array

hours

List of hours

true

integer (int32) array

minutes

List of minutes

true

integer (int32) array

CsrResponse

Name Description Required Schema Default

csr

true

string

CvoSaasProperties

Name Description Required Schema Default

subscription

false

SaasSubscription

freeTrialExpiry

false

integer (int64)

saasEnabled

false

boolean

CvsAccountCredentials

Name Description Required Schema Default

accessKey

true

string

secretKey

true

string

region

true

string

CvsAccountRequest

Name Description Required Schema Default

providerKeys

true

CvsAccountCredentials

CvsAccountResponse

Name Description Required Schema Default

publicId

true

string

accountName

true

string

accountType

true

string

cvsAccessKey

true

string

cvsSecretKey

true

string

cvsRegion

true

string

DataBrokerNetworkInformation

Name Description Required Schema Default

vpcId

Data Broker Vpc Id

true

string

subnetId

Data Broker Subnet Id

true

string

keyPair

Data Broker Key pair

true

string

region

Data Broker Region

true

string

DataBrokerPlacement

Name Description Required Schema Default

vpcId

true

string

subnetId

true

string

instanceType

true

string

instanceId

true

string

keyPair

true

string

DataBrokerProperties

Name Description Required Schema Default

id

true

string

name

true

string

dataBrokerPlacement

false

DataBrokerPlacement

DefaultProviderVolume

Name Description Required Schema Default

size

true

Capacity

diskType

true

string

capacityTier

false

string

iops

false

integer (int32)

DeleteCbsBackupRequest

Name Description Required Schema Default

backupNames

S3 Backup names to delete

true

string array

fileSystemIdSrcVol

File System Id of source volume in Backup to S3 Service

true

string

DescribeCvoSubscriptionResponse

Name Description Required Schema Default

subscription

false

SubscriptionResponse

freeTrialExpiry

false

integer (int64)

DiscoveredAwsHaResponse

Name Description Required Schema Default

name

true

string

publicId

true

string

region

true

string

vpcName

true

string

vpcId

true

string

availabilityZones

true

string array

subnetIds

true

string array

stackName

true

string

stackId

true

string

clusterAddress

true

string

recoverable

true

boolean

byol

true

boolean

registered

true

boolean

DiscoveredAzureHaResponse

Name Description Required Schema Default

name

true

string

publicId

true

string

region

true

string

vnetName

true

string

vnetId

true

string

subnetId

true

string

subnetName

true

string

resourceGroup

true

string

clusterAddress

true

string

recoverable

true

boolean

byol

true

boolean

registered

true

boolean

DiscoveredAzureVSAResponse

Name Description Required Schema Default

name

true

string

id

true

string

publicId

true

string

region

true

string

vnetName

true

string

vnetId

true

string

subnetId

true

string

subnetName

true

string

resourceGroup

true

string

clusterAddress

true

string

recoverable

true

boolean

byol

true

boolean

registered

true

boolean

DiscoveredGcpVsaResponse

Name Description Required Schema Default

name

true

string

id

true

string

publicId

true

string

zone

true

string

vnetName

true

string

vnetId

true

string

projectName

true

string

subnetName

true

string

clusterAddress

true

string

recoverable

true

boolean

DiscoveredVsaResponse

Name Description Required Schema Default

name

true

string

publicId

true

string

region

true

string

vpcName

true

string

vpcId

true

string

availabilityZone

true

string

subnetId

true

string

stackName

true

string

stackId

true

string

clusterAddress

true

string

recoverable

true

boolean

registered

true

boolean

byol

true

boolean

Disk

Name Description Required Schema Default

name

Name

true

string

position

Position

true

string

ownerNode

Owner node

true

string

device

Device

true

string

vmDiskProperties

VmDiskProperties

false

VmDiskProperties

DisksConfiguration

Name Description Required Schema Default

aws

true

AwsDisksConstraints

azure

true

AzureDisksConstraints

gcp

true

GcpDisksConstraints

DisksDetails

Name Description Required Schema Default

numberOfDisks

Number of disks

true

integer (int32)

diskSize

Disk size

true

Capacity

diskType

Disk type

true

string

Duration

Name Description Required Schema Default

length

Length

true

integer (int64)

unit

Unit

true

enum (DAYS, HOURS, MINUTES, SECONDS, MILLISECONDS, MICROSECONDS, NANOSECONDS)

EbsVolumeDetails

Name Description Required Schema Default

numOfVolumes

true

integer (int32)

size

true

Capacity

volumeType

true

string

EbsVolumeType

Name Description Required Schema Default

description

true

string

size

true

Capacity

supportedVolumeTypes

true

string array

supportedOccmLicenses

true

string array

default

true

boolean

EligibilityResponse

Name Description Required Schema Default

eligibilityResponse

true

string

EnableCapacityTieringRequest

Name Description Required Schema Default

instanceProfileName

false

string

gcpStorageAccountId

false

string

storageAccountPrefix

false

string

EncryptionProperties

Name Description Required Schema Default

ontapEncryption

true

boolean

awsVolumeEncryption

true

boolean

azureVolumeEncryption

true

boolean

gcpVolumeEncryption

true

boolean

keyManagers

true

KeyManagerResponse array

encryptionCertificates

true

CertificateResponse array

awsEncryptionKey

false

AwsEncryptionKey

EvaluationOntapLicenses

Name Description Required Schema Default

worm

true

string

EvaluationSerialNumbers

Name Description Required Schema Default

single_aws

true

string

single_azure

true

string

ha_aws_node1

true

string

ha_aws_node2

true

string

ha_azure_node1

true

string

ha_azure_node2

true

string

gcp_single

true

string

Expand

Name Description Required Schema Default

name

false

string

expands

false

Expand array

Expands

Name Description Required Schema Default

raw

false

string

expands

false

Expand array

ExportPolicyInfo

Name Description Required Schema Default

policyType

Export policy type

true

string

ips

Custom export policy list of IPs

true

string array

ExtendedManagedHaParameters

Name Description Required Schema Default

node1SubnetId

true

string

node2SubnetId

true

string

mediatorSubnetId

true

string

clusterFloatingIP

true

string

dataFloatingIP

true

string

dataFloatingIP2

true

string

mediatorKeyPairName

true

string

routeTableIds

true

string array

ExtendedManagedHaVolumeCreateRequest

Name Description Required Schema Default

name

Volume name

true

string

size

Size as Capacity

true

PositiveCapacity

diskType

Disk type

true

enum (gp2, st1)

region

true

string

vpcId

true

string

haParams

true

ExtendedManagedHaParameters

skipSnapshots

Take snapshot flag

true

boolean

upgradeCreateRequest

Instance upgrade information

false

UpgradeCreateRequest

ExtendedManagedVolumeCreateRequest

Name Description Required Schema Default

name

Volume name

true

string

size

Size as Capacity

true

PositiveCapacity

diskType

Disk type

true

enum (gp2, st1, sc1)

region

true

string

vpcId

true

string

subnetId

Subnet ID

true

string

skipSnapshots

Take snapshot flag

true

boolean

upgradeCreateRequest

Instance upgrade information

false

UpgradeCreateRequest

ExtendedObjectStoreConfigInfo

Name Description Required Schema Default

objectStoreConfig

false

ObjectStoreConfigInfo

tierLevel

false

string

FailureCauses

Name Description Required Schema Default

invalidOntapCredentials

true

boolean

noCloudProviderConnection

true

boolean

invalidCloudProviderCredentials

true

boolean

FeatureFlag

Name Description Required Schema Default

azure

true

boolean

FloatingIps

Name Description Required Schema Default

clusterFloatingIP

true

string

dataFloatingIP

true

string

dataFloatingIP2

true

string

AwsHaFloatingIpValidationData:FloatingIps

Name Description Required Schema Default

clusterFloatingIP

false

string

dataFloatingIP

false

string

dataFloatingIP2

false

string

svmFloatingIP

false

string

FpolicyProperties

Name Description Required Schema Default

status

true

integer (int32)

fPolicyProtocolStatus

true

FpolicyProtocolStatus

fileExtensions

true

string array

FpolicyProtocolStatus

Name Description Required Schema Default

nfsv3

true

integer (int32)

nfsv4

true

integer (int32)

cifs

true

integer (int32)

GcpAccountResponse

Name Description Required Schema Default

publicId

true

string

accountName

true

string

accountType

true

string

accessKey

true

string

vsaList

true

AccountWorkingEnvironmentResponse array

GcpDiskTypeResponse

Name Description Required Schema Default

size

true

Capacity

supportedDiskTypes

true

string array

supportedOccmLicenses

true

string array

GcpDisksConstraints

Name Description Required Schema Default

numReservedDisksSingleNode

true

integer (int32)

maxDisksSingleNode

true

integer (int32)

numDisksWarnSingleNode

true

integer (int32)

deltaDiskWarn

true

integer (int32)

GcpEncryption

Name Description Required Schema Default

key

false

string

GcpEncryptionKey

Name Description Required Schema Default

name

true

string

id

true

string

keyRing

true

string

location

true

string

GcpFirewallResponse

Name Description Required Schema Default

name

Firewall Name

true

string

vpc

VPC

true

string

GcpKeysForCloudStorageWithValidation

Name Description Required Schema Default

accessKey

true

string

secretKey

true

string

GcpLabel

Name Description Required Schema Default

labelKey

true

string

labelValue

true

string

GcpNetworkRequirementsResponse

Name Description Required Schema Default

vsaMinimumRequiredIps

true

integer (int32)

haVsaMinimumRequiredIps

true

integer (int32)

GcpProjectResponse

Name Description Required Schema Default

projectNumber

true

string

projectId

true

string

lifecycleState

true

string

name

true

string

createTime

true

string

parent

true

Map[string,string]

default

true

boolean

GcpProjectsResponse

Name Description Required Schema Default

projects

true

GcpProjectResponse array

GcpProperties

Name Description Required Schema Default

name

true

string

regionName

true

string

zoneName

true

string

instanceType

true

string

subnetCidr

true

string

numOfNics

true

integer (int32)

labels

true

Map[string,string]

projectName

true

string

deploymentName

true

string

GcpRegionResponse

Name Description Required Schema Default

displayName

true

string

name

true

string

zones

true

GcpZoneResponse array

vpcs

true

GcpVirtualNetworkResponse array

GcpStorageAccountRequest

Name Description Required Schema Default

accountName

true

string

providerKeys

true

GcpKeysForCloudStorageWithValidation

GcpSubnetResponse

Name Description Required Schema Default

ipCidrRange

CIDR

true

string

name

Subnet name

true

string

path

Subnet path

true

string

availableIps

The number of available IPs on the subnet

true

integer (int32)

minimumRequiredIps

The minimum needed IP addresses for the Cloud Volumes ONTAP creation

true

integer (int32)

GcpVirtualNetworkResponse

Name Description Required Schema Default

name

Virtual Network Name

true

string

subnets

Subnets

true

GcpSubnetResponse array

firewalls

Firewalls

true

GcpFirewallResponse array

GcpVsaWorkingEnvironmentResponse

Name Description Required Schema Default

publicId

true

string

name

true

string

tenantId

true

string

svmName

false

string

creatorUserEmail

true

string

status

false

StatusProperties

providerProperties

false

GcpProperties

reservedSize

false

Capacity

clusterProperties

false

VsaClusterProperties

ontapClusterProperties

false

OntapClusterProperties

cloudProviderName

true

string

snapshotPolicies

false

SnapshotPolicy array

actionsRequired

false

ActionRequired array

activeActions

Actions currently being performed on this working environment

false

string array

replicationProperties

false

ReplicationProperties

schedules

false

VsaSchedule array

svms

false

Svm array

workingEnvironmentType

true

string

supportRegistrationProperties

false

SupportRegistrationProperties

supportRegistrationInformation

false

SupportRegistrationInformation array

capacityFeatures

false

CapacityFeatures

encryptionProperties

false

EncryptionProperties

supportedFeatures

false

SupportedFeatures

k8sProperties

false

K8sProperties

fpolicyProperties

false

FpolicyProperties

saasProperties

false

CvoSaasProperties

complianceProperties

false

CloudComplianceStatusResponse

hA

true

boolean

GcpZoneResponse

Name Description Required Schema Default

name

Zone Name

true

string

GlobalManifest

Name Description Required Schema Default

license_types

true

OntapLicenseType array

regions

true

Region array

azureRegions

true

Region array

gcpRegions

true

Region array

cot_versions

true

Map[string,Map[string,List[string]]]

cot_versions_to_upgrade_to

true

Map[string,Map[string,List[string]]]

supportedFeatures

true

Map[string,Map[string,FeatureProperties]]

GrantPermission

Name Description Required Schema Default

addWorkingEnvironments

List of working environment public IDs for which permissions should be added

true

string array

removeWorkingEnvironments

List of working environment public IDs for which permissions should be removed

true

string array

HaParameters

Name Description Required Schema Default

node1SubnetId

true

string

node2SubnetId

true

string

mediatorSubnetId

true

string

clusterFloatingIP

false

string

dataFloatingIP

false

string

dataFloatingIP2

false

string

svmFloatingIP

false

string

mediatorKeyPairName

true

string

routeTableIds

false

string array

platformSerialNumberNode1

false

string

platformSerialNumberNode2

false

string

providedLicenseNode1

false

string

providedLicenseNode2

false

string

failoverMode

HA failover mode

false

enum (FloatingIP, PrivateIP)

mediatorProxy

false

MediatorProxy

mediatorAssignPublicIP

false

boolean

mediatorInstanceProfileName

false

string

mediatorSecurityGroupId

false

string

HaPlacementResult

Name Description Required Schema Default

vsaAndVolume

true

VsaAndVolumeParams

floatingIps

true

FloatingIps

upgradeInfo

false

ChangeInstanceTypeRequest

affectedVolumes

true

string array

HaProperties

Name Description Required Schema Default

mediatorVersionInfo

true

MediatorVersionInfo

mediatorStatus

true

MediatorStatus

routeTables

true

string array

mediatorVersionsToUpdate

true

MediatorUpdateVersionMetadata array

failoverMode

true

string

InitialSetupResponse

Name Description Required Schema Default

upgradeToVersion

false

string

InstallCertificatesAndPrivateKeyRequest

Name Description Required Schema Default

occmCertificate

true

string

privateKey

true

string

InstallCertificatesRequest

Name Description Required Schema Default

occmCertificate

true

string

InstanceConfiguration

Name Description Required Schema Default

mediator

true

Map[string,InstanceConfigurationMapping]

probes

true

Map[string,InstanceConfigurationMapping]

InstanceNameIdAndType

Name Description Required Schema Default

instanceName

Instance name

true

string

instanceType

Instance type

true

string

instanceId

Instance Id

true

string

InstancePlacementResponse

Name Description Required Schema Default

region

Region

true

string

vpcId

VPC

false

string

subnetId

Subnet

false

string

keyPair

KeyPair

false

string

installLocation

Install Location

true

string

role

Role

false

string

providerRoleType

Provider Role Type

false

string

ic

IC

true

boolean

publicIp

Public IP

false

string

account

Account

false

string

govCloud

Gov cloud

true

boolean

china

China

true

boolean

InstanceProfileResponse

Name Description Required Schema Default

instanceProfileId

true

string

name

true

string

InstanceResponse

Name Description Required Schema Default

id

Instance Id

true

string

name

Instance name

true

string

instanceType

Instance type

true

string

state

Instance state

true

string

publicIpAddress

Public IP address that is assigned to the instance

true

string

privateIpAddress

Private IP address that is assigned to the instance

true

string

publicDnsName

Public DNS

true

string

privateDnsName

Private DNS name

true

string

imageId

Image Id

true

string

subnetId

Subnet Id

true

string

availabilityZone

Availability Zone

true

string

tags

Instance tags

true

Map[string,string]

productCode

Product code

true

string

tenancy

Instance Tenancy

true

string

placementGroup

Placement Group

true

string

keyPairName

Key Pair

true

string

instanceProfileId

Instance profile ID

false

string

vsaInstance

true

boolean

oCCMInstance

true

boolean

InstanceTypeInfo

Name Description Required Schema Default

instanceType

true

string

supportsEncryption

true

boolean

supportedFeatures

true

string array

default

true

boolean

InstanceTypeResponse

Name Description Required Schema Default

instanceType

true

string

InstanceTypesNotSupportingAccelerationAndCapacityTieringResponse

Name Description Required Schema Default

instanceTypes

true

InstanceTypeResponse array

InterClusterLif

Name Description Required Schema Default

name

true

string

address

true

string

port

true

string

node

true

string

status

true

string

peered

true

boolean

K8sContext

Name Description Required Schema Default

contextName

false

string

clusterName

false

string

clusterEndpoint

false

string

currentContext

false

boolean

connectivity

false

boolean

alreadyExists

false

boolean

K8sFileInfo

Name Description Required Schema Default

k8sconfig

true

string

contexts

true

K8sContext array

K8sProperties

Name Description Required Schema Default

mainClusterIds

true

string array

connectedClusterIds

true

string array

connected

true

boolean

KeyManagerCaCertificateRequest

Name Description Required Schema Default

certificate

true

string

KeyManagerRequest

Name Description Required Schema Default

name

true

string

address

true

string

usernameField

false

string

usernameValue

false

string

KeyManagerResponse

Name Description Required Schema Default

publicId

true

string

name

true

string

address

true

string

usernameField

true

string

usernameValue

true

string

status

true

string

KeyPairsByRegionResponse

Name Description Required Schema Default

regionToKeyPairs

true

Map[string,List[string]]

LegacyInstanceTypes

Name Description Required Schema Default

instanceTypes

true

ProviderLegacyInstanceTypes

LicenseAndInstanceType

Name Description Required Schema Default

licenseType

true

string

name

true

string

description

true

string

capacityLimit

true

Capacity

instanceTypes

true

InstanceTypeInfo array

LicenseAndInstanceTypeModificationRequest

Name Description Required Schema Default

instanceType

New instance type

true

string

licenseType

New license type

true

string

LicenseFileContent

Name Description Required Schema Default

licenseOne

true

string

licenseTwo

false

string

LicenseToAmis

Name Description Required Schema Default

license_type

true

string

instance_types

true

string array

amis

true

RegionalAmi array

LifResponse

Name Description Required Schema Default

ip

Lif ip

true

string

netmask

Lif netmask

true

string

lifType

Lif type

true

string

dataProtocols

List of supported protocols

true

string array

nodeName

Node name

true

string

privateIp

Whether this Lif ip is a private address

true

boolean

ManagedHaVolumeCreateRequest

Name Description Required Schema Default

name

Volume name

true

string

size

Size as Capacity

true

PositiveCapacity

diskType

Disk type

true

enum (gp2, st1)

region

true

string

vpcId

true

string

haParams

true

BasicManagedHaParameters

ManagedInstanceIdResponse

Name Description Required Schema Default

workingEnvironmentId

true

string

ManagedInstanceResponse

Name Description Required Schema Default

workingEnvironmentId

Working environment id

true

string

instanceId

Instance id

true

string

name

Instance name

true

string

instanceType

Instance type

true

string

status

Status

true

enum (ON, INITIALIZING, UPDATING, STARTING, STOPPING, DELETING, OFF, FAILED, NOT_FOUND, DEGRADED, DEGRADED_ON, DEGRADED_OFF, DEGRADED_FAILED, DEGRADED_IN_TAKEOVER)

region

Region

true

string

availabilityZone

Availability zone

true

string

subnetCidr

Subnet CIDR

true

string

ebsVolumes

EBS volumes

true

EbsVolumeDetails array

volumes

Volumes

true

string array

awsTags

AWS tags

true

Map[string,string]

mediator

true

boolean

ManagedInstanceTypeResponse

Name Description Required Schema Default

instanceType

true

string

ManagedVolume

Name Description Required Schema Default

id

true

string

name

true

string

cloudOntapInstanceName

true

string

size

true

Capacity

usedSize

true

Capacity

compressionSavedSpace

true

Capacity

deduplicationSpaceSaved

true

Capacity

mountPoint

false

string

exportPolicyInfo

true

NamedExportPolicyInfo

parentVolumeName

true

string

cloneNames

true

string array

status

true

enum (ONLINE, OFFLINE, CREATING, ADDING_RESOURCES_AND_CREATING, ALLOCATING_NEW_RESOURCES_AND_CREATING, DELETING, DEGRADED)

statusReason

false

string

region

true

string

availabilityZone

DEPRECATED

true

string

subnetId

DEPRECATED

true

string

diskType

true

enum (gp2, standard, st1, sc1)

subnetCidr

DEPRECATED

true

string

sourceOrTarget

true

SourceOrTargetReplication

subnetIds

true

string array

subnetCidrs

true

string array

supportMixedAggregate

true

boolean

moving

true

boolean

ha

true

boolean

encrypted

true

boolean

ManagedVolumeChangeDiskTypeRequest

Name Description Required Schema Default

aggregateName

Target aggregate name

true

string

diskType

Target disk type

true

enum (gp2, st1, sc1, standard)

upgradeCreateRequest

Instance upgrade information

false

UpgradeCreateRequest

allowVsaUpgrade

Allow vsa upgrade

true

boolean

ManagedVolumeCloneRequest

Name Description Required Schema Default

newVolumeName

New volume name

true

string

ManagedVolumeCreateRequest

Name Description Required Schema Default

name

Volume name

true

string

size

Size as Capacity

true

PositiveCapacity

diskType

Disk type

true

enum (gp2, st1, sc1)

region

true

string

vpcId

true

string

subnetId

Subnet ID

true

string

ManagedVolumeModifyRequest

Name Description Required Schema Default

exportPolicyInfo

Export policy info for NFS

false

NamedExportPolicyInfo

ManagedVolumeQuoteRequest

Name Description Required Schema Default

diskType

Target disk type

true

enum (gp2, st1, sc1, standard)

ManagedVolumesResponse

Name Description Required Schema Default

volumes

true

ManagedVolume array

errors

DEPRECATED

true

string array

unavailableInstances

true

UnavailableInstanceInfo array

MaxDisksAllow

Name Description Required Schema Default

numOfDisks

true

integer (int32)

reason

false

string

MediatorProxy

Name Description Required Schema Default

url

false

string

userName

false

string

password

false

string

MediatorStatus

Name Description Required Schema Default

statusCode

true

integer (int32)

statusMessage

true

string

MediatorUpdateVersionMetadata

Name Description Required Schema Default

mediatorVersion

true

string

timeStamp

true

integer (int64)

metadataFileName

true

string

major

true

boolean

manifestFileName

false

string

MediatorUpgradeConfiguration

Name Description Required Schema Default

dependencies

true

Map[string,List[string]]

MediatorVersionInfo

Name Description Required Schema Default

version

true

string

description

true

string

state

true

string

MetadataResponse

Name Description Required Schema Default

globalManifest

Global Manifest

true

GlobalManifest

ontapManifests

ONTAP manifests

true

CloudOntapManifest array

ModifyUserTagsRequest

Name Description Required Schema Default

tags

true

CloudResourceTag array

Money

Name Description Required Schema Default

amount

Amount

false

number (double)

currency

Currency

false

string

NTPConfigurationRequest

Name Description Required Schema Default

ntpServer

NTPS server

true

string

NamedExportPolicyInfo

Name Description Required Schema Default

name

Export policy name

false

string

policyType

Export policy type

true

string

ips

Custom export policy list of IPs

true

string array

NetworkRequirementsResponse

Name Description Required Schema Default

nonHaNodeMinimumRequiredIps

true

integer (int32)

haNodeMinimumRequiredIps

true

integer (int32)

haMediatorMinimumRequiredIps

true

integer (int32)

NssAccountCredentials

Name Description Required Schema Default

nssUserName

true

string

nssPassword

true

string

NssAccountRequest

Name Description Required Schema Default

accountName

true

string

providerKeys

true

NssAccountCredentials

vsaList

true

string array

NssAccountResponse

Name Description Required Schema Default

publicId

true

string

accountName

true

string

accountType

true

string

nssUserName

true

string

vsaList

true

AccountWorkingEnvironmentResponse array

NssAccountVsaListRequest

Name Description Required Schema Default

vsaList

true

string array

NssUserName

Name Description Required Schema Default

nssUserName

true

string

ObjectStoreConfigInfo

Name Description Required Schema Default

objectStoreName

true

string

s3Name

true

string

usedSpace

true

Capacity

server

true

string

providerType

true

string

OccmExternalConfiguration

Name Description Required Schema Default

email

true

string

aws_product_page

true

string

cot_aws_product_page

true

string

ha_cot_aws_product_page

true

string

intercom_prod_app_id

true

string

intercom_test_app_id

true

string

livechat_license

true

string

features

true

OccmFeaturesFlags

upgrade_path

true

OnCloudUpgradePath array

occm_release_notes_url

true

string

evaluation_serial_numbers

true

EvaluationSerialNumbers

legacyInstanceTypes

true

LegacyInstanceTypes

aws_cross_account_tutorial_url

true

string

disksConfiguration

true

DisksConfiguration

migration

true

OccmMigration

evaluation_ontap_licenses

true

EvaluationOntapLicenses

mediatorUpgradeConfiguration

true

MediatorUpgradeConfiguration

instanceConfiguration

true

InstanceConfiguration

cvsRegions

true

[CvsRegion] array

regions

true

Map[string,List[string]]

OccmFeaturesFlags

Name Description Required Schema Default

intercom

true

boolean

aws_environment_collector

true

boolean

OccmMigration

Name Description Required Schema Default

migrateAll

true

boolean

blackList

true

string array

OnCloudUpgradePath

Name Description Required Schema Default

version

true

string

path

true

string array

OnPremAggregateResponse

Name Description Required Schema Default

name

true

string

totalCapacity

true

Capacity

availableCapacity

true

Capacity

state

true

string

objectStoreName

false

string

usedCapacity

true

Capacity

tieringRestriction

false

TieringRestriction

availabilityState

false

string

objectStoreAttachEligible

true

boolean

inactiveDataReportingEnabled

true

boolean

OnPremCapacityFeatures

Name Description Required Schema Default

objectStoreConfigExtended

false

ExtendedObjectStoreConfigInfo

performanceTierUsedCapacity

true

Capacity

inactiveUserData

false

Capacity

rawCapacity

true

Capacity

fiveYearSavings

true

number (double)

OnPremClusterProperties

Name Description Required Schema Default

clusterAddress

true

string

ontapVersion

true

string

clusterName

true

string

serialNumber

true

string

systemId

true

string

licenses

true

string array

systemManagerUrl

true

string

location

true

enum (ON_PREM, AZURE, AWS, SOFTLAYER, GOOGLE, CLOUD_TIERING)

clusterUuid

true

string

nodeModels

true

string array

lifs

true

LifResponse array

snapmirrorLicenseExists

true

boolean

OnPremVolumeCreateRequest

Name Description Required Schema Default

workingEnvironmentId

Target working environment ID

true

string

svmName

SVM name

true

string

aggregateName

Aggregate in which to create the volume

true

string

name

Volume name, unique within the SVM

true

string

size

Size as Capacity

true

PositiveCapacity

initialSize

Initial size as Capacity. Relevant for thin provisioned volumes only. Default to 0.

false

Capacity

snapshotPolicyName

Snapshot policy name

true

string

exportPolicyInfo

NFS protocol parameters

false

ExportPolicyInfo

shareInfo

CIFS protocol parameters

false

CreateCifsShareInfoRequest

enableThinProvisioning

Enable thin provisioning

true

boolean

enableCompression

Enable compression

true

boolean

enableDeduplication

Enable deduplication

true

boolean

syncToS3

Add Cloud Sync relationship

true

boolean

OnPremVolumeModifyRequest

Name Description Required Schema Default

snapshotPolicyName

Snapshot Policy name

false

string

shareInfo

Share names, permissions and users for CIFS

false

CifsShareInfo

exportPolicyInfo

Export policy info for NFS

false

NamedExportPolicyInfo

tieringPolicy

Tiering policy

false

enum (none, snapshot_only, auto, backup, all)

minimumCoolingDays

Tiering minimum cooling days

false

integer (int32)

OnPremVolumeRequest

Name Description Required Schema Default

sourceSvmName

Source SVM name

true

string

sourceVolumeName

Source volume name

true

string

destinationVolumeName

Destination volume name

true

string

destinationAggregateName

Destination aggregate name

true

string

destinationSvmName

Destination SVM name

true

string

destinationCapacityTier

Destination aggregate capacity tier

false

enum (S3, Blob)

OnPremWorkingEnvironmentDiscoverRequest

Name Description Required Schema Default

tenantId

true

string

description

false

string

name

true

string

clusterAddress

true

string

clusterUserName

true

string

clusterPassword

true

string

location

true

enum (ON_PREM, AZURE, AWS, SOFTLAYER, GOOGLE, CLOUD_TIERING)

OnPremWorkingEnvironmentResponse

Name Description Required Schema Default

publicId

true

string

tenantId

true

string

description

true

string

name

true

string

discoverUserEmail

true

string

location

true

string

reservedSize

false

Capacity

status

false

StatusProperties

interClusterLifs

false

InterClusterLif array

cronJobSchedules

false

CronJobSchedule array

svms

false

Svm array

snapshotPolicies

false

SnapshotPolicy array

replicationProperties

Working environments in which a SnapMirror relationship exists between volumes on this working environment

false

ReplicationProperties

clusterProperties

false

OnPremClusterProperties

ontapClusterProperties

false

OnPremClusterProperties

workingEnvironmentType

true

string

cloudSyncProperties

false

CloudSyncProperties

actionsRequired

false

ActionRequired array

capacityFeatures

false

OnPremCapacityFeatures

aff

true

boolean

k8sProperties

false

K8sProperties

OntapCloudPasswordExists

Name Description Required Schema Default

exists

true

boolean

OntapCloudPasswordRequest

Name Description Required Schema Default

ontapCloudPassword

Cloud Volumes ONTAP password

true

string

OntapClusterProperties

Name Description Required Schema Default

nodes

true

OntapNodeProperties array

clusterName

true

string

ontapVersion

true

string

systemManagerUrl

true

string

creationTime

true

integer (int64)

licenseType

true

VsaLicense

lastModifiedOffbox

false

integer (int64)

offboxTarget

true

boolean

upgradeVersions

false

OntapUpdateImageMetadata array

writingSpeedState

false

string

broadcastDomainInfos

true

BroadcastDomainInfo array

evaluation

true

boolean

capacityTierInfo

false

CapacityTierInfo

canConfigureCapacityTier

true

boolean

usedCapacity

true

Capacity

userName

true

string

wormEnabled

true

boolean

OntapEncryption

Name Description Required Schema Default

keyManagerIds

true

string array

keyManagerCaCertificateId

true

string

OntapLicenseType

Name Description Required Schema Default

type

true

string

name

true

string

description

true

string

subName

true

string

subDescription

true

string

capacity_limit

true

string

platformLicenseRequired

true

boolean

default

true

boolean

capacityLimit

true

Capacity

OntapNodeProperties

Name Description Required Schema Default

name

true

string

lifs

true

LifResponse array

serialNumber

true

string

systemId

true

string

platformLicense

false

string

platformSerialNumber

false

string

cloudProviderId

true

string

healthy

true

boolean

inTakeover

true

boolean

OntapUpdateImageMetadata

Name Description Required Schema Default

imageVersion

true

string

lastModified

true

integer (int64)

autoUpdateAllowed

true

boolean

PackageInfoResponse

Name Description Required Schema Default

name

true

string

displayName

true

string

description

true

string

licenseType

true

string

instanceTypeMapping

true

[InstanceTypeRegionMapping] array

diskType

true

string

diskSize

true

Capacity

capacityTier

false

string

instanceTenancy

false

string

writingSpeedState

true

string

PasswordWrapper

Name Description Required Schema Default

password

true

string

PlacementResult

Name Description Required Schema Default

vsaAndVolume

true

VsaAndVolumeParams

upgradeInfo

false

ChangeInstanceTypeRequest

affectedVolumes

true

string array

PolicySchedule

Name Description Required Schema Default

frequency

Frequency

true

string

retention

Retention

true

integer (int32)

PortalInformation

Name Description Required Schema Default

edit_user_url

true

string

PortalService

Name Description Required Schema Default

usePortalAuthentication

true

boolean

auth0Information

false

Auth0Information

portalInformation

false

PortalInformation

PortalSetupAsServiceConnectorRequest

Name Description Required Schema Default

site

Site

true

string

company

Company

true

string

tenancyAccountId

Tenancy account Id

false

string

PositiveCapacity

Name Description Required Schema Default

size

Size

true

number (double)

unit

Unit

true

string

ProvidedLicenseResponse

Name Description Required Schema Default

license

true

string

serialNumber

true

string

contractEndDate

false

integer (int64)

ProviderLegacyInstanceTypes

Name Description Required Schema Default

aws

true

string array

azure

true

string array

ProviderProperties

Name Description Required Schema Default

regionName

true

string

resourceGroup

Resource group

true

AzureResourceGroupResponse

vnetCidr

true

string

tags

true

Map[string,string]

subscriptionId

true

string

deploymentId

true

string

creationTime

true

integer (int64)

instanceType

true

string

numOfNics

true

integer (int32)

singleNetworkInterface

true

boolean

subscriptionName

true

string

cloudProviderAccountId

false

string

ProviderSupportedRegions

Name Description Required Schema Default

aws

true

Region array

azure

true

Region array

ProviderVolumeResponse

Name Description Required Schema Default

id

Id

true

string

name

Name

true

string

size

Size

true

Capacity

state

State

true

string

device

Device

true

string

instanceId

InstanceId

true

string

diskType

Type

true

string

encrypted

Encrypted

true

boolean

iops

Provisioned IOPS

false

integer (int32)

ProviderVolumeTypeResponse

Name Description Required Schema Default

size

true

Capacity

supportedVolumeTypes

true

string array

maxDisksAllow

true

MaxDisksAllow

ProxyUri

Name Description Required Schema Default

uri

false

string

proxyUserName

false

string

proxyPassword

false

string

proxyDomain

false

string

RecoverAzureHARequest

Name Description Required Schema Default

region

true

string

resourceGroupName

true

string

clusterCredentials

true

ClusterCredentialsRequest

tenantId

true

string

providerAccount

ID of subscription where VSA is located

false

string

cloudProviderAccount

Cloud Provider Account

false

string

nssAccountId

Nss Account

false

string

RecoverAzureVSARequest

Name Description Required Schema Default

region

true

string

id

true

string

resourceGroupName

true

string

instanceName

true

string

clusterCredentials

true

ClusterCredentialsRequest

tenantId

true

string

providerAccount

ID of subscription where VSA is located

false

string

cloudProviderAccount

Cloud Provider Account

false

string

nssAccountId

Nss Account

false

string

RecoverGcpVsaRequest

Name Description Required Schema Default

zone

true

string

instanceName

true

string

clusterCredentials

true

ClusterCredentialsRequest

tenantId

true

string

projectId

false

string

nssAccountId

Nss Account

false

string

RecoverVsaRequest

Name Description Required Schema Default

region

true

string

stackId

true

string

clusterCredentials

true

ClusterCredentialsRequest

tenantId

true

string

cloudProviderAccount

Cloud Provider Account

false

string

nssAccountId

Nss Account

false

string

Region

Name Description Required Schema Default

name

true

string

code

true

string

location

true

string

s3Region

false

string

RegionalAmi

Name Description Required Schema Default

region

true

string

ami_id

true

string

saas_mp

true

boolean

RegistrationResponse

Name Description Required Schema Default

clientId

true

string

ReplicationInterClusterLif

Name Description Required Schema Default

name

Name

true

string

address

Address

true

string

netmaskLength

Netmask Length

true

integer (int32)

port

Port

true

string

node

Node

true

string

status

Status

true

string

peered

true

boolean

ReplicationInterClusterLifs

Name Description Required Schema Default

interClusterLifs

Working Environment Intercluster Lifs

true

ReplicationInterClusterLif array

peerInterClusterLifs

Peer Working Environment Intercluster Lifs

true

ReplicationInterClusterLif array

ReplicationProperties

Name Description Required Schema Default

peers

true

string array

replicationTargets

true

string array

ReplicationRequest

Name Description Required Schema Default

sourceWorkingEnvironmentId

Source working environment Id

true

string

destinationWorkingEnvironmentId

Destination working environment Id

true

string

sourceInterclusterLifIps

Source intercluster LIF IPs

true

string array

destinationInterclusterLifIps

Destination intercluster LIF IPs

true

string array

policyName

SnapMirror policy name

true

string

scheduleName

Schedule name

false

string

maxTransferRate

Maximum transfer rate limit (KB/s). Use 0 for no limit, otherwise use number between 1024 and 2,147,482,624

false

integer (int32)

ReplicationSchedule

Name Description Required Schema Default

name

Name

true

string

description

Description

false

string

cronJobSchedule

Cron jobs schedule

true

CronJobScheduleResponse

ReplicationStatusCurrentTransferInfo

Name Description Required Schema Default

transferType

Current transfer type

true

enum (initialize, update, resync, restore, check, file_restore)

transferPriority

Current transfer priority

true

enum (low, normal)

transferError

Current transfer error

true

string

ReplicationStatusLastTransferInfo

Name Description Required Schema Default

transferType

Last transfer type

true

enum (initialize, update, resync, restore, check, file_restore)

transferSize

Last transfer size

true

Capacity

transferDuration

Last transfer duration

true

Duration

transferEnded

Last transfer end time

true

string (date-time)

transferError

Last transfer error

true

string

ReplicationStatusResponse

Name Description Required Schema Default

source

Source Details

true

ReplicationStatusSide

destination

Destination Details

true

ReplicationStatusSide

mirrorState

SnapMirror status

true

enum (uninitialized, snapmirrored, brokenoff, undefined)

relationshipType

SnapMirror relationship type

true

enum (data_protection, load_sharing, vault, restore, transition_data_protection, extended_data_protection)

relationshipStatus

SnapMirror relationship status

true

enum (idle, transferring, checking, quiescing, quiesced, queued, preparing, finalizing, aborting, breaking)

relationshipProgress

SnapMirror relationship progress

true

Capacity

policy

Policy name

true

string

policyType

Policy type

true

enum (vault, async_mirror, mirror_vault, sync_mirror)

schedule

Schedule name

true

string

maxTransferRate

Maximum transfer rate limit

true

Capacity

networkCompressionRatio

Network compression ratio

true

string

healthy

SnapMirror healthiness

true

boolean

unhealthyReason

SnapMirror un-healthiness reason

true

string

lagTime

Replication lag time

true

Duration

newestSnapshotName

Newest snapshot name

true

string

newestSnapshotCreated

Newest snapshot creation time

true

string (date-time)

lastTransferInfo

Last transfer Information

true

ReplicationStatusLastTransferInfo

currentTransferInfo

Current transfer Information

true

ReplicationStatusCurrentTransferInfo

totalTransferTime

Total transfer time

true

Duration

totalTransferSize

Total transfer size

true

Capacity

volumeUsedSize

Volume used size

true

Capacity

volumeCapacityTier

Volume capacity tier

true

Capacity

ReplicationStatusSide

Name Description Required Schema Default

workingEnvironmentId

Working environment ID

true

string

workingEnvironmentType

Working environment type

true

string

workingEnvironmentStatus

Working environment status

true

string

clusterName

Cluster name

true

string

region

AWS region name

false

string

availabilityZone

AWS availability zone name

false

string

svmName

Svm name

true

string

nodeName

Node name

false

string

volumeName

Volume name

true

string

ReplicationUpdateRequest

Name Description Required Schema Default

schedule

New replication schedule name name

false

string

maxTransferRate

New maximum transfer rate limit (KB/s). Use 0 for no limit, otherwise use number between 1024 and 2,147,482,624

false

integer (int32)

ResetPassword

Name Description Required Schema Default

oldPassword

User’s current password

true

string

newPassword

User’s new password

true

string

ResetUserPasswordRequest

Name Description Required Schema Default

password

New password

true

string

ResourcesToDelete

Name Description Required Schema Default

instanceNameAndType

true

InstanceNameIdAndType array

numberOfDisksAndDiskSize

true

DisksDetails array

RestoreCbsBackupRequest

Name Description Required Schema Default

workingEnvironmentId

Destination working environment Id

true

string

fileSystemIdSrcVol

File System Id of source volume in Backup to S3 Service

true

string

backupName

S3 Backup Name of File System Id

true

string

destinationVolumeName

Destination volume name

true

string

maxTransferRate

Maximum transfer rate (KB/s), use 0 for unlimited rate

false

integer (int32)

Role

Name Description Required Schema Default

name

Role name

true

string

publicId

Role public ID

true

string

permissions

List of permissions available to this role

true

string array

RouteTableResponse

Name Description Required Schema Default

id

true

string

main

true

boolean

subnets

true

string array

tags

true

RouteTableTag array

RouteTableTag

Name Description Required Schema Default

key

true

string

value

true

string

SaasMpAccountResponse

Name Description Required Schema Default

awsSubscriptions

AWS Subscriptions

true

SubscriptionResponse array

azureSubscriptions

Azure Subscriptions

true

SubscriptionResponse array

gcpSubscriptions

Gcp Subscriptions

true

SubscriptionResponse array

eligibleForFreeTrialAws

Eligible For Free Trial AWS

true

boolean

eligibleForFreeTrialGcp

Eligible For Free Trial Gcp

true

boolean

eligibleForFreeTrialAzure

Eligible For Free Trial Azure

true

boolean

SaasMpServiceInformation

Name Description Required Schema Default

productUrlAws

true

string

productUrlGcp

true

string

SaasSubscription

Name Description Required Schema Default

id

true

string

name

true

string

active

true

boolean

SaveRequest

Name Description Required Schema Default

k8sconfig

Kubernetes config file contents in YAML format

true

string

contextNames

Context names to use

true

string array

SavingsInfo

Name Description Required Schema Default

name

Name of saving element

false

string

monthlySaving

Savings for that element

false

Money

ScheduledBackupToCbsRequest

Name Description Required Schema Default

workingEnvironmentId

Working environment Id

true

string

svmName

Volume SVM name

true

string

volumeName

Volume Name

true

string

cbsScheduleRules

S3 Backup schedule rules

true

CbsSchedule array

SecurityGroupResponse

Name Description Required Schema Default

securityGroupId

Security group ID

true

string

description

Description

true

string

name

Name

true

string

ServerTimeZone

Name Description Required Schema Default

timeZoneName

true

string

formattedTimeZone

true

string

ServiceUrl

Name Description Required Schema Default

url

url

true

string

SetNssKeysRequest

Name Description Required Schema Default

nssUserName

NSS username

false

string

nssPassword

NSS password

false

string

SetProxyRequest

Name Description Required Schema Default

uri

true

string

proxyUserName

false

string

proxyPassword

false

string

proxyDomain

false

string

SetupRequest

Name Description Required Schema Default

tenantRequest

true

AddTenantRequest

userRequest

true

UserRequest

site

true

string

company

true

string

proxyUrl

true

ProxyUri

autoVsaCapacityManagement

true

boolean

autoUpgrade

true

boolean

SiteIdentifier

Name Description Required Schema Default

company

true

string

host

true

string

site

true

string

SnapMirrorPolicy

Name Description Required Schema Default

name

true

string

comment

true

string

policyType

true

enum (vault, async_mirror, mirror_vault, sync_mirror)

rules

true

[SnapMirrorRule] array

SnapMirrorPolicyResponse

Name Description Required Schema Default

name

true

string

comment

true

string

policyType

true

string

rules

true

SnapMirrorRuleResponse array

reason

false

string

default

true

boolean

supported

true

boolean

SnapMirrorRuleResponse

Name Description Required Schema Default

snapMirrorLabel

true

string

retention

true

integer (int32)

SnapshotCreateRequest

Name Description Required Schema Default

snapshotName

Snapshot name

true

string

SnapshotDeleteRequest

Name Description Required Schema Default

snapshotName

Snapshot name

true

string array

SnapshotPolicy

Name Description Required Schema Default

name

Name

true

string

schedules

Schedules

true

PolicySchedule array

description

Description

true

string

SnapshotPolicyCreateRequest

Name Description Required Schema Default

snapshotPolicyName

Snapshot policy name

true

string

schedules

Snapshot policy schedules

true

SnapshotPolicyScheduleRequest array

SnapshotPolicyScheduleRequest

Name Description Required Schema Default

scheduleType

Snapshot policy schedule type

true

enum (5min, 8hour, hourly, daily, weekly, monthly)

retention

Snapshot policy retention

true

integer (int32)

SourceOrTargetReplication

Name Description Required Schema Default

source

true

boolean

target

true

boolean

SourceSnapmirrorEndpoint

Name Description Required Schema Default

sourceWorkingEnvironmentId

working environment Id

true

string

sourceSvmName

SVM name

true

string

sourceVolumeName

volume name

true

string

StartStopRange

Name Description Required Schema Default

stop

true

TimePoint

start

true

TimePoint

Status

Name Description Required Schema Default

status

false

string

StatusProperties

Name Description Required Schema Default

status

true

string

message

true

string

failureCauses

true

FailureCauses

extendedFailureReason

false

string

SubnetResponse

Name Description Required Schema Default

subnetId

Subnet ID

true

string

cidr

CIDR

true

string

subnetName

Subnet name

false

string

availabilityZone

availability zone

true

string

availableIps

The number of available IPs on the subnet

true

integer (int32)

minimumRequiredIps

The minimum needed IP addresses for the Cloud Volumes ONTAP creation

true

integer (int32)

SubscriptionResponse

Name Description Required Schema Default

id

Id

true

string

name

Name

true

string

provider

true

enum (aws, azure, gcp)

active

Active

true

boolean

SupportRegistrationInformation

Name Description Required Schema Default

supportRegistrationStatus

true

string

serialNumber

true

string

licenseExpiryDate

false

integer (int64)

cloudLicenseExists

true

boolean

nssAccountId

false

string

SupportRegistrationProperties

Name Description Required Schema Default

supportRegistrationStatus

true

string

licenseExpiryDate

true

integer (int64)

SupportRegistrationResponse

Name Description Required Schema Default

status

true

string

licenseExpiryDate

false

integer (int64)

licenseStartDate

false

integer (int64)

nssAccountId

false

string

SupportServices

Name Description Required Schema Default

asupEnabled

true

boolean

cognitoEnabled

true

boolean

kinesisEnabled

true

boolean

intercomEnabled

true

boolean

liveChatEnabled

true

boolean

volumeViewEnabled

true

boolean

portalService

true

PortalService

intercomAppId

true

string

tenancyServiceInformation

false

TenancyServiceInformation

saasMpServiceInformation

false

SaasMpServiceInformation

cvsInformation

true

string

backupToS3Information

true

BackupToS3Information

complianceEnabled

true

boolean

SupportedCapacityTiers

Name Description Required Schema Default

supportedCapacityTiersPerVolumeType

true

SupportedCapacityTiersResponse array

capacityTiersDisableReasons

true

string array

compositeSupported

true

boolean

forceCompositeVersion

true

boolean

SupportedCapacityTiersResponse

Name Description Required Schema Default

volumeType

true

string

supportedCapacityTiers

true

string array

availableTieringPolicies

true

string array

SupportedFeatures

Name Description Required Schema Default

supportsMixedAggregates

true

boolean

SupportedFeaturesResponse

Name Description Required Schema Default

wormSupportedVersion

true

boolean

cbsSupportedVersion

true

boolean

Svm

Name Description Required Schema Default

name

true

string

state

true

string

language

true

string

allowedAggregates

true

string array

SvmNameModificationRequest

Name Description Required Schema Default

svmName

true

string

S3BucketInfo

Name Description Required Schema Default

bucketName

true

string

region

true

string

tags

true

Map[String, String]

TagKeyResponse

Name Description Required Schema Default

key

true

string

values

true

string array

TagResponse

Name Description Required Schema Default

key

tag key

true

string

value

tag value

true

string

TenancyServiceInformation

Name Description Required Schema Default

accountId

true

string

url

true

string

accountWidgetUrl

true

string

agentsMgmtUrl

true

string

TenantActionsRequiredResponse

Name Description Required Schema Default

weActions

true

WeActionRequiredResponse array

TenantResponse

Name Description Required Schema Default

name

true

string

publicId

true

string

workingEnvironmentsInformation

false

WorkingEnvironmentsInformation

TieringRestriction

Name Description Required Schema Default

restrictionReason

false

string

tieringRestricted

true

boolean

TimePoint

Name Description Required Schema Default

day

true

integer (int32)

hour

true

integer (int32)

minute

true

integer (int32)

TrustedCertificateResponse

Name Description Required Schema Default

id

ID

true

string

status

Status

true

enum (ACTIVE, PENDING_DELETED, PENDING_INSTALLED)

certificateInfo

Certificate Info

true

CertificateResponse

UnavailableInstanceInfo

Name Description Required Schema Default

name

true

string

instanceIds

true

string array

status

true

string

UpdateCredentialsRequest

Name Description Required Schema Default

username

Username

true

string

password

Password

true

string

UpdateInfo

Name Description Required Schema Default

name

true

string

date

true

integer (int64)

releaseNumber

true

integer (int32)

UpdateKeyManagerCaCertificateRequest

Name Description Required Schema Default

keyManagerCaCertificateId

true

string

UpdateLocalImage

Name Description Required Schema Default

name

true

string

version

true

string

current

true

boolean

UpdateRouteTablesRequest

Name Description Required Schema Default

routeTableIds

true

string array

UpdateServiceUser

Name Description Required Schema Default

cloudManagerNotificationsOptIn

true

boolean

UpdateSubscriptionRequest

Name Description Required Schema Default

newSubscriptionId

New SaaS Marketplace subscription id

true

string

UpdateSystemImageRequest

Name Description Required Schema Default

updateType

System update type. System update can be performed by providing either: an external URL from which ONTAP will download the image file, a local image already in ONTAP or a name of an image provided by Cloud Manager

true

enum (EXTERNAL_FILE, LOCAL_IMAGE, OCCM_PROVIDED)

updateParameter

Parameter specific to the specified update type. External file URL, local image name or Cloud Manager provided image name

true

string

UpdateTenantRequest

Name Description Required Schema Default

name

Tenant name

true

string

description

Tenant description

false

string

costCenter

Tenant cost center

false

string

UpdateUserRequest

Name Description Required Schema Default

firstName

User first name

true

string

lastName

User last name

true

string

email

User email

true

string

ldapUserName

AD user name

false

string

notificationsOptIn

Email notifications opt-in

false

boolean

UpgradeCreateRequest

Name Description Required Schema Default

vsaAndVolume

true

VsaAndVolumeParams

upgradeInfo

true

ChangeInstanceTypeRequest

Usage

Name Description Required Schema Default

amount

Amount

false

number (double)

units

Units

false

string

UserPasswordRequest

Name Description Required Schema Default

email

Email address of the user attempting to login

true

string

password

Password of the user attempting to login

true

string

UserRequest

Name Description Required Schema Default

firstName

User first name

true

string

lastName

User last name

true

string

email

User email

true

string

roleId

Role ID of the user

true

string

tenantId

Tenant ID of the user

false

string

password

User password

true

string

ldapUserName

LDAP User Name

false

string

notificationsOptIn

Email notifications opt-in

false

boolean

ldap

true

boolean

UserResponse

Name Description Required Schema Default

publicId

User public ID

true

string

assignedWorkingEnvironments

List of public IDs of all of the working environments visible to the user

true

string array

firstName

User first name

true

string

lastName

User last name

true

string

email

User email

true

string

roleId

Role ID of the user

true

string

tenantId

Tenant ID of the user

true

string

createdWorkingEnvironments

List of all working environments created by the user

true

UserWorkingEnvironmentResponse array

cloudSyncLicenseInformation

Cloud Sync license information

false

CloudSyncLicenseInformation

ldapUserName

LDAP User Name

true

string

notificationsOptIn

Notification OptIn

true

boolean

permissions

Permissions

true

string array

ldap

true

boolean

UserTagsResponse

Name Description Required Schema Default

tags

true

CloudResourceTag array

UserWorkingEnvironmentResponse

Name Description Required Schema Default

publicId

Working environment public ID

true

string

name

Working environment name

true

string

workingEnvironmentType

Working environment Type

true

string

VersionWrapper

Name Description Required Schema Default

name

true

string

date

true

integer (int64)

releaseNumber

true

integer (int32)

VhdImageRequest

Name Description Required Schema Default

storageAccount

true

string

container

true

string

vhdOsBlob

true

string

vhdDataBlob

true

string

blobUrl

false

string

VmDiskProperties

Name Description Required Schema Default

objectName

true

string

storageAccountName

true

string

containerName

true

string

Volume

Name Description Required Schema Default

name

Name

true

string

totalSize

Volume total size

true

Capacity

usedSize

Volume used size

true

Capacity

thinProvisioned

Is volume thin-provisioned

true

boolean

rootVolume

Is volume the root volume of the SVM

true

boolean

clone

true

boolean

VolumeCbsInfo

Name Description Required Schema Default

totalBackups

true

integer (int32)

VolumeCloneRequest

Name Description Required Schema Default

newVolumeName

New volume name

true

string

parentSnapshot

Snapshot name to use for clone

false

string

VolumeInfo

Name Description Required Schema Default

volumeName

true

string

svmName

true

string

newCapacity

true

Capacity

VolumeModifyRequest

Name Description Required Schema Default

snapshotPolicyName

Snapshot Policy name

false

string

shareInfo

Share names, permissions and users for CIFS

false

CifsShareInfo

exportPolicyInfo

Export policy info for NFS

false

NamedExportPolicyInfo

qualityOfService

Quality of service

false

VolumeQualityOfService

tieringPolicy

Tiering policy

false

enum (none, snapshot_only, auto)

minimumCoolingDays

Tiering minimum cooling days

false

integer (int32)

VolumeMoveParameters

Name Description Required Schema Default

volumeName

true

string

svmName

true

string

targetAggregateName

true

string

homeNode

false

string

newTargetAggregate

true

boolean

VolumeMoveRequest

Name Description Required Schema Default

targetAggregateName

Target aggregate name

true

string

numOfDisksToAdd

Target aggregate number of disks to add

true

integer (int32)

createTargetAggregate

Is new Target aggregate

true

boolean

newDiskTypeName

Volume’s new Disk type

false

string

newCapacityTier

New capacity tier

false

enum (S3, Blob, cloudStorage)

newTieringPolicy

New tiering policy

false

enum (none, snapshot_only, auto)

VolumeQualityOfService

Name Description Required Schema Default

maxIops

false

integer (int32)

maxDataRate

Max Data rate per second

false

Capacity

VolumeResponse

Name Description Required Schema Default

name

Volume name

true

string

svmName

Volume SVM name

true

string

size

Volume total size

true

Capacity

usedSize

Volume used size

true

Capacity

junctionPath

The junction path at which this volume is mounted

true

string

mountPoint

Mount Point

false

string

compressionSpaceSaved

The total disk capacity that is saved by compressing blocks

true

Capacity

deduplicationSpaceSaved

The disk space capacity that is saved by deduplication and file cloning

true

Capacity

thinProvisioning

Whether thin provisioning is enabled

true

boolean

compression

Whether compression is enabled

true

boolean

deduplication

Whether deduplication is enabled

true

boolean

snapshotPolicy

The name of the Snapshot policy

true

string

securityStyle

The type of the Security style

true

string

exportPolicyInfo

The export policy info for NFS

true

NamedExportPolicyInfo

shareNames

The share names for CIFS

true

string array

shareInfo

The share names, permissions and users for CIFS

true

CifsShareInfo array

parentVolumeName

Name of the parent flexible volume for the clone

true

string

rootVolume

Flag to indicate if the volume is a SVM root

true

boolean

state

Volume state

true

string

volumeType

Volume type

true

string

aggregateName

Aggregate name

true

string

parentSnapshot

The snapshot name the volume is based on

false

string

autoSizeMode

The operating mode of autosize

true

string

maxGrowSize

The maximum size to which the volume will grow automatically

true

Capacity

providerVolumeType

Cloud provider volume type

false

string

cloneNames

Names of cloned copies of the volume

true

string array

moving

Is Volume during move process

true

boolean

primaryNoFailoverMountPoint

Primary mount point without failover

false

string

secondaryNoFailoverMountPoint

Secondary mount point without failover

false

string

capacityTier

Capacity tier

false

enum ([S3, Blob])

capacityTierUsedSize

Capacity tier used size

false

Capacity

cifsShareAccessPoint

CIFS share access point

false

string

primaryCifsShareAccessPoint

Primary CIFS share access point

false

string

secondaryCifsShareAccessPoint

Secondary CIFS share access point

false

string

tieringPolicy

Tiering policy

false

string

tierInactiveUserData

Tier inactive user data

false

Capacity

tierInactiveUserDataPercent

Tier inactive user data percent

false

integer (int32)

comment

Volume comment

false

string

qosPolicyGroupName

Quality of service policy group name

false

string

snaplockType

Snaplock type

false

enum (non_snaplock, compliance, enterprise)

constituentsAggregates

Aggregates which are used for FlexGroup constituents

true

string array

snapshotsUsedSize

The size that is used by snapshots in the volume

false

Capacity

cbsBackupsInfo

Backup to S3 Service info

false

VolumeCbsInfo

VolumeViewSetupRequest

Name Description Required Schema Default

userRequest

true

UserRequest

company

true

string

proxyUrl

true

ProxyUri

autoUpgrade

true

boolean

VpcBasicResponse

Name Description Required Schema Default

vpcId

VPC ID

true

string

state

VPC state

true

string

cidrBlock

VPC CIDR block

true

string

tags

VPC tags

true

VpcTagResponse array

default

Is the VPC a default one

true

boolean

VpcExtendedResponse

Name Description Required Schema Default

vpcId

VPC ID

true

string

state

VPC state

true

string

cidrBlock

VPC CIDR block

true

string

tags

VPC tags

true

VpcTagResponse array

default

Is the VPC a default one

true

boolean

subnets

Subnets associated with vpc

true

SubnetResponse array

securityGroups

Security groups associated with vpc

true

SecurityGroupResponse array

tenancy

VPC Tenancy

true

string

VpcTagResponse

Name Description Required Schema Default

key

VPC tag key

true

string

value

VPC tag value

true

string

VsaAggregateCreateRequest

Name Description Required Schema Default

name

true

string

workingEnvironmentId

true

string

numberOfDisks

true

integer (int32)

diskSize

true

Capacity

homeNode

false

string

providerVolumeType

false

string

capacityTier

false

enum (S3, Blob, cloudStorage)

iops

Provisioned IOPS

false

integer (int32)

VsaAndVolumeParams

Name Description Required Schema Default

vsaId

true

string

svmName

true

string

aggregateName

true

string

cidr

true

string

VsaCandidateForCbsRestore

Name Description Required Schema Default

workingEnvironmentName

true

string

workingEnvironmentId

true

string

exclusionReason

false

string

VsaClusterProperties

Name Description Required Schema Default

lifs

true

LifResponse array

serialNumber

true

string

systemId

true

string

clusterName

true

string

ontapVersion

true

string

accountId

true

string

productCode

true

string

amiId

true

string

systemManagerUrl

true

string

creationTime

true

integer (int64)

instanceId

true

string

platformLicense

true

string

licenseExpiryDate

true

integer (int64)

instanceType

true

string

publicIp

false

string

publicDnsName

false

string

licenseType

true

VsaLicense

lastModifiedOffbox

false

integer (int64)

offboxTarget

true

boolean

upgradeVersions

false

OntapUpdateImageMetadata array

writingSpeedState

false

string

VsaLicense

Name Description Required Schema Default

name

License name

true

string

capacityLimit

Capacity limit

true

Capacity

VsaMetadataRequest

Name Description Required Schema Default

ontapVersion

true

string

licenseType

true

string

instanceType

true

string

platformSerialNumber

false

string

providedLicense

false

string

useLatestVersion

false

boolean

VsaSchedule

Name Description Required Schema Default

name

true

string

schedule

true

StartStopRange array

enabled

true

boolean

VsaSchedulesRequest

Name Description Required Schema Default

schedules

true

VsaSchedule array

VsaVolumeCreateRequest

Name Description Required Schema Default

workingEnvironmentId

Cloud Volumes ONTAP Working Environment ID

true

string

svmName

SVM name

true

string

aggregateName

Aggregate in which the volume will be created

true

string

name

Volume name, unique within the SVM

true

string

size

Size as Capacity

true

PositiveCapacity

initialSize

Initial size as Capacity. Relevant for thin provisioned volumes only

false

Capacity

snapshotPolicyName

Snapshot Policy name

true

string

exportPolicyInfo

NFS protocol parameters

false

ExportPolicyInfo

shareInfo

CIFS protocol parameters

false

CreateCifsShareInfoRequest

enableThinProvisioning

Enable thin provisioning

true

boolean

enableCompression

Enable compression

true

boolean

enableDeduplication

Enable deduplication

true

boolean

maxNumOfDisksApprovedToAdd

Maximum number of disks approved to allocate

true

integer (int32)

providerVolumeType

Provider volume type

false

string

syncToS3

Add Cloud Sync relationship

true

boolean

capacityTier

Capacity tier

false

enum (S3, Blob, cloudStorage)

iops

Provisioned IOPS

false

integer (int32)

tieringPolicy

Tiering policy

false

enum (none, snapshot_only, auto)

junctionPath

Junction path

false

string

qualityOfService

Quality of service

false

VolumeQualityOfService

VsaVolumeOnNewVsaCreateRequest

Name Description Required Schema Default

name

Volume name, unique within the SVM

true

string

size

Size as Capacity

true

PositiveCapacity

initialSize

Initial size as Capacity. Relevant for thin provisioned volumes only.

false

Capacity

snapshotPolicyName

true

string

exportPolicyInfo

NFS protocol parameters

false

ExportPolicyInfo

shareInfo

CIFS protocol parameters

false

CreateCifsShareInfoRequest

enableThinProvisioning

Enable thin provisioning

true

boolean

enableCompression

Enable compression

true

boolean

enableDeduplication

Enable deduplication

true

boolean

tieringPolicy

Tiering policy

false

enum (none, snapshot_only, auto)

junctionPath

Junction path

false

string

qualityOfService

Quality of service

false

VolumeQualityOfService

VsaVolumeQuoteRequest

Name Description Required Schema Default

workingEnvironmentId

Cloud Volumes ONTAP Working Environment ID

true

string

svmName

SVM name

true

string

aggregateName

Optionally choose in which aggregate to create the volume

false

string

name

Volume name, unique within the SVM

true

string

size

Size as Capacity

true

PositiveCapacity

initialSize

Initial size as Capacity. Relevant for thin provisioned volumes only

false

Capacity

enableThinProvisioning

Enable thin provisioning

true

boolean

providerVolumeType

Provider volume type

false

string

verifyNameUniqueness

Verify volume name uniqueness within the SVM

true

boolean

capacityTier

Capacity tier

false

enum (S3, Blob, cloudStorage)

iops

Provisioned IOPS

false

integer (int32)

tieringPolicy

Tiering policy

false

enum (none, snapshot_only, auto)

replicationFlow

true

boolean

VsaVolumeQuoteResponse

Name Description Required Schema Default

numOfDisks

Number of new disks needed

true

integer (int32)

diskSize

New disks size

true

Capacity

aggregateName

The aggregate on which the requested volume will be created

true

string

newAggregate

Is it a newly created aggregate

true

boolean

autoVsaCapacityManagement

Is auto Cloud Volumes ONTAP capacity management enabled

true

boolean

VsaVolumeRequest

Name Description Required Schema Default

sourceSvmName

Source SVM name

true

string

sourceVolumeName

Source volume name

true

string

destinationVolumeName

Destination volume name

true

string

destinationAggregateName

Destination aggregate name

true

string

numOfDisksApprovedToAdd

Maximum number of disks approved to add

true

integer (int32)

advancedMode

Use advanced allocation for destination volume

true

boolean

destinationProviderVolumeType

Destination provider volume type

false

string

destinationCapacityTier

Destination aggregate capacity tier

false

enum (S3, Blob, cloudStorage)

VsaWorkingEnvironmentResponse

Name Description Required Schema Default

publicId

true

string

name

true

string

tenantId

true

string

svmName

false

string

creatorUserEmail

true

string

status

false

StatusProperties

awsProperties

false

AwsProperties

reservedSize

false

Capacity

encryptionProperties

false

EncryptionProperties

clusterProperties

false

VsaClusterProperties

ontapClusterProperties

false

OntapClusterProperties

actionsRequired

false

ActionRequired array

interClusterLifs

false

InterClusterLif array

cronJobSchedules

false

CronJobSchedule array

snapshotPolicies

false

SnapshotPolicy array

svms

false

Svm array

activeActions

Actions currently being performed on this working environment

false

string array

replicationProperties

Working environments in which a SnapMirror relationship exists between volumes on this working environment

false

ReplicationProperties

schedules

false

VsaSchedule array

cloudProviderName

true

string

workingEnvironmentType

true

string

supportRegistrationProperties

false

SupportRegistrationProperties

supportRegistrationInformation

false

SupportRegistrationInformation array

haProperties

false

HaProperties

capacityFeatures

false

CapacityFeatures

cloudSyncProperties

false

CloudSyncProperties

supportedFeatures

false

SupportedFeatures

k8sProperties

false

K8sProperties

fpolicyProperties

false

FpolicyProperties

saasProperties

false

CvoSaasProperties

cbsProperties

false

CbsProperties

complianceProperties

false

CloudComplianceStatusResponse

hA

true

boolean

WeActionRequiredResponse

Name Description Required Schema Default

publicId

true

string

actions

true

ActionRequired array

WorkingEnvironmentCostAndUsageResponse

Name Description Required Schema Default

hasPermissions

Has permissions to view cost and usage details

true

boolean

costByTime

Working environment cost and usage details

true

CostByTime array

WorkingEnvironmentOntapSavingResponse

Name Description Required Schema Default

savings

list of savings

true

SavingsInfo array

WorkingEnvironments

Name Description Required Schema Default

vsaWorkingEnvironments

true

VsaWorkingEnvironmentResponse array

onPremWorkingEnvironments

true

OnPremWorkingEnvironmentResponse array

azureVsaWorkingEnvironments

true

AzureVsaWorkingEnvironmentResponse array

gcpVsaWorkingEnvironments

true

GcpVsaWorkingEnvironmentResponse array

WorkingEnvironmentsInformation

Name Description Required Schema Default

regionsCount

Number of regions for which working environments exist over this tenant

true

integer (int32)

totalReservedSize

Total reserved size of all working environments created over this tenant

true

Capacity

workingEnvironmentsCount

Number of working environments created over this tenant

true

integer (int32)

WorkspaceResponse

Name Description Required Schema Default

workspacePublicId

true

string

workspaceName

true

string

associatedToAgent

true

boolean

WormRequest

Name Description Required Schema Default

activationCode

WORM Activation Code

true

string

retentionPeriod

WORM Retention period

true

WormRetentionPeriod

WormRetentionPeriod

Name Description Required Schema Default

length

Length

true

integer (int32)

unit

Unit

true

enum (years, months, days, hours, minutes, seconds)

WritingSpeedRequest

Name Description Required Schema Default

writingSpeedState

Writing speed state

true

enum (NORMAL, HIGH)

Copyright © 2019 NetApp, Inc. All rights reserved. Printed in the U.S.

No part of this document covered by copyright may be reproduced in any form or by any means—graphic, electronic, or mechanical, including photocopying, recording, taping, or storage in an electronic retrieval system—without prior written permission of the copyright owner.
Software derived from copyrighted NetApp material is subject to the following license and disclaimer:

THIS SOFTWARE IS PROVIDED BY NETAPP "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, WHICH ARE HEREBY DISCLAIMED. IN NO EVENT SHALL NETAPP BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

NetApp reserves the right to change any products described herein at any time, and without notice. NetApp assumes no responsibility or liability arising from the use of products described herein, except as expressly agreed to in writing by NetApp. The use or purchase of this product does not convey a license under any patent rights, trademark rights, or any other intellectual property rights of NetApp.

The product described in this manual may be protected by one or more U.S. patents, foreign patents, or pending applications.

Data contained herein pertains to a commercial item (as defined in FAR 2.101) and is proprietary to NetApp, Inc. The U.S. Government has a non-exclusive, non-transferrable, non-sublicensable, worldwide, limited irrevocable license to use the Data only in connection with and in support of the U.S. Government contract under which the Data was delivered. Except as provided herein, the Data may not be used, disclosed, reproduced, modified, performed, or displayed without the prior written approval of NetApp, Inc. United States Government license rights for the Department of Defense are limited to those rights identified in DFARS clause 252.227-7015(b).

Trademark

NETAPP, the NETAPP logo, and the marks listed on the NetApp Trademarks page are trademarks of
NetApp, Inc. Other company and product names may be trademarks of their respective owners.
http://www.netapp.com/us/legal/netapptmlist.aspx

How to send comments about documentation and receive update notifications

You can help us to improve the quality of our documentation by sending us your feedback. You can receive automatic notification when production-level (GA/FCS) documentation is initially released or important changes are made to existing production-level documents.

If you have suggestions for improving this document, send us your comments by email.

To help us direct your comments to the correct division, include in the subject line the product name, version, and operating system.

If you want to be notified automatically when production-level documentation is released or important changes are made to existing production-level documents, follow Twitter account @NetAppDoc.

You can also contact us in the following ways:

NetApp, Inc., 1395 Crossman Ave., Sunnyvale, CA 94089 U.S.
Telephone: +1 (408) 822-6000
Fax: +1 (408) 822-4501
Support telephone: +1 (888) 463-8277

December 2019