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\":\"latest\",\"licenseType\":\"cot-explore-paygo\",\"instanceType\":\"m5.xlarge\", \"useLatestVersion\":true},\"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\": \"latest\",\"licenseType\": \"ha-cot-explore-paygo\",\"instanceType\": \"m5.xlarge\", \"useLatestVersion\":true},\"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\": \"latest\",\"licenseType\": \"ha-cot-explore-paygo\",\"instanceType\": \"m5.xlarge\", \"useLatestVersion\":true},\"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\": \"latest\",\"licenseType\": \"ha-cot-explore-paygo\",\"instanceType\": \"m5.xlarge\", \"useLatestVersion\":true},\"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\": \"latest\",  \"licenseType\": \"azure-cot-explore-paygo\",  \"instanceType\": \"Standard_DS3_v2\", \"useLatestVersion\":true},\"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\": \"westus\",\"packageName\": \"azure_ha_standard\",\"dataEncryptionType\": \"AZURE\",\"capacityTier\": \"Blob\",\"vsaMetadata\": {\"ontapVersion\":\"latest\",\"licenseType\": \"azure-ha-cot-standard-paygo\",\"instanceType\":\"Standard_DS4_v2\", \"useLatestVersion\":true},\"writingSpeedState\": \"NORMAL\",\"subnetId\": \"$azureSubnetId\",\"svmPassword\": \"$svmPassword\",\"vnetId\": \"$azureVnetId\",\"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.7RC1.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\"]}"

Provisioning iSCSI volumes

The following example shows how to create an iSCSI volume:

curl --location --request POST 'http://localhost/occm/api/vsa/volumes' \
--header 'Content-Type: application/json' \
--data-raw '{
  "providerVolumeType": "gp2",
  "verifyNameUniqueness": true,
  "name": "voliscsi",
  "size": {
    "size": 100,
    "unit": "GB"
  },
  "enableCompression": true,
  "enableDeduplication": true,
  "createAggregateIfNotFound": "true",
  "enableThinProvisioning": true,
  "aggregateName": "aggr1",
  "maxNumOfDisksApprovedToAdd": 0,
  "svmName": “$svm",
  "iops": null,
  "snapshotPolicyName": "default",
  "autoVsaCapacityManagementEnabled": true,
  "iscsiInfo": {
    "osName": "windows",
    "igroupCreationRequest": {
      "initiators": [
        "iqn.1991-05.com.microsoft:win-v2h87dkhkmi"
     ],
      "igroupName": "iscsiIgroup"
    }
  },
  "workingEnvironmentId": "$weid "
}'

Resources

This section describes the API calls available for each resource.

Accounts

Retrieves accounts.

GET /accounts
Parameters
Type Name Description Required Schema Default

QueryParameter

providerType

false

enum (AWS, AZURE, GCP, NSS)
Responses
HTTP Code Description Schema

default

success

CloudProviderAccountResponse
Consumes

  • application/json

Produces

  • application/json

Validate an Azure account request.

POST /accounts/azure/validate-creds
Parameters
Type Name Description Required Schema Default

BodyParameter

body

true

AzureAccountRequest
Responses
HTTP Code Description Schema

default

success

AssociatedSubscription array
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

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

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

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

get aws cloud account id for the given creds.

POST /accounts/aws/validate-creds
Parameters
Type Name Description Required Schema Default

BodyParameter

body

true

AwsAccountRequest
Responses
HTTP Code Description Schema

default

success

string
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

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

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

validate gcp account request.

POST /accounts/gcp/validate-creds
Parameters
Type Name Description Required Schema Default

BodyParameter

body

true

GcpStorageAccountRequest
Responses
HTTP Code Description Schema

default

success

string
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 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

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

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

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

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

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

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

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

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

Anf

Get Azure NetApp Files Volumes summary.

GET /anf/summary
Responses
HTTP Code Description Schema

default

success

ANFSummary
Consumes

  • application/json

Produces

  • application/json

Get Azure NetApp Files Volumes.

GET /anf/volumes
Responses
HTTP Code Description Schema

default

success

ANFVolumeResponse array
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

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

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 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

Retrieve active task for this request ID.

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

PathParameter

requestId

request ID

true

string
Responses
HTTP Code Description Schema

default

success

TaskCacheEntry
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

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

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

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

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

Retrieve S3 buckets summary

GET /aws/ha/metadata/s3-summary
Responses
HTTP Code Description Schema

default

success

S3Summary
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

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 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 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

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

Retrieve S3 buckets policy status and tiering level

POST /aws/ha/metadata/get-buckets-application-info
Parameters
Type Name Description Required Schema Default

BodyParameter

body

Request for retrieving Buckets Additional info

true

BucketsPolicyAndTieringInfoRequest
Responses
HTTP Code Description Schema

default

success

BucketAdditionalData array
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 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

Retrieve all S3 buckets with additional info

GET /aws/ha/metadata/get-buckets-details
Responses
HTTP Code Description Schema

default

success

S3BucketsSummary
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 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 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

Create new S3 bucket

POST /aws/ha/metadata/create-bucket
Parameters
Type Name Description Required Schema Default

QueryParameter

region

true

string

QueryParameter

bucketName

true

string
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 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 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 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

Retrieve all S3 buckets

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

QueryParameter

tagsRequired

false

boolean
Responses
HTTP Code Description Schema

default

success

S3BucketInfo array
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 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

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 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

Aws-ha: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 /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

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

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

QueryParameter

workingEnvironmentId

Filter volumes by this working environment

true

string

QueryParameter

offset

offset

false

integer (int32)

QueryParameter

limit

limit

false

integer (int32)
Responses
HTTP Code Description Schema

default

success

VolumesListForBackup
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

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

Get all igroups.

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

PathParameter

workingEnvironmentId

true

string

PathParameter

svmName

true

string
Responses
HTTP Code Description Schema

default

success

[IGroup] array
Consumes

  • application/json

Produces

  • application/json

Add ISCSI initiator.

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

BodyParameter

body

ISCSI initiator request

true

Initiator
Consumes

  • application/json

Produces

  • application/json

Get all ISCSI initiators.

GET /aws/ha/volumes/initiator
Responses
HTTP Code Description Schema

default

success

InitiatorEntry array
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

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

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

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

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

Aws-ha:working-environments

Delete CIFS Configuration of an existing Cloud Volumes ONTAP working environment

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

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

CIFS Configuration request

true

CIFSDeleteRequest
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

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 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

QueryParameter

svm

false

string
Responses
HTTP Code Description Schema

default

success

CIFSConfigurationResponse array
Consumes

  • application/json

Produces

  • application/json

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

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

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

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

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

false

EnableCapacityTieringRequest
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

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

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

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

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

Update Backup to Cloud 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

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

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 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

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

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

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

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

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

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

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

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

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

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

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

Manually triggers subscription sync for all Cloud Volumes ONTAP working environments

POST /aws/ha/working-environments/sync-subscription
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

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

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

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

Register extra capacity serials

POST /aws/ha/working-environments/{workingEnvironmentId}/extra-capacity-serials/{licenseType}
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

PathParameter

licenseType

License type

true

enum (cvo, backup)

BodyParameter

body

extra capacity serial(s)

true

ExtraCapacitySerials
Consumes

  • application/json

Produces

  • application/json

Update extra capacity serials

PUT /aws/ha/working-environments/{workingEnvironmentId}/extra-capacity-serials/{licenseType}
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

PathParameter

licenseType

License type

true

enum (cvo, backup)

BodyParameter

body

extra capacity serial(s)

true

ExtraCapacitySerials
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

Register extra capacity license

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

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

PathParameter

licenseType

License type

true

enum (cvo, backup)

BodyParameter

body

extra capacity licenses(s)

true

ExtraCapacityLicenses
Consumes

  • application/json

Produces

  • application/json

Get extra capacity licenses for cvo

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

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

PathParameter

licenseType

License type

true

enum (cvo, backup)
Consumes

  • application/json

Produces

  • application/json

Update extra capacity license

PUT /aws/ha/working-environments/{workingEnvironmentId}/extra-capacity-licenses/{licenseType}
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

PathParameter

licenseType

License type

true

enum (cvo, backup)

BodyParameter

body

extra capacity license(s)

true

ExtraCapacityLicenses
Consumes

  • application/json

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

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

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

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

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

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

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

Azure-ha:aggregates

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

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

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

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

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

Azure-ha:metadata

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

Retrieve all blob containers

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

QueryParameter

subscriptionId

false

string

QueryParameter

cloudProviderAccountId

false

string

QueryParameter

resourceGroupName

true

string

QueryParameter

storageAccountName

true

string
Responses
HTTP Code Description Schema

default

success

AzureBlobContainer 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 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 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

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 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 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

Create new blob container

POST /azure/ha/metadata/create-container
Parameters
Type Name Description Required Schema Default

BodyParameter

body

Create blob container request

true

CreateBlobContainerRequest
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 Azure resource groups by region

GET /azure/ha/metadata/resource-groups
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

AzureResourceGroupByRegionResponse 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 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

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 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 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

Azure-ha:volumes

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

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

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

Get all igroups.

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

PathParameter

workingEnvironmentId

true

string

PathParameter

svmName

true

string
Responses
HTTP Code Description Schema

default

success

[IGroup] array
Consumes

  • application/json

Produces

  • application/json

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

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

QueryParameter

workingEnvironmentId

Filter volumes by this working environment

true

string

QueryParameter

offset

offset

false

integer (int32)

QueryParameter

limit

limit

false

integer (int32)
Responses
HTTP Code Description Schema

default

success

VolumesListForBackup
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/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

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

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

Add ISCSI initiator.

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

BodyParameter

body

ISCSI initiator request

true

Initiator
Consumes

  • application/json

Produces

  • application/json

Get all ISCSI initiators.

GET /azure/ha/volumes/initiator
Responses
HTTP Code Description Schema

default

success

InitiatorEntry array
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

Azure-ha:working-environments

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

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

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

Manually triggers subscription sync for all Cloud Volumes ONTAP working environments

POST /azure/ha/working-environments/sync-subscription
Consumes

  • application/json

Produces

  • application/json

Register extra capacity serials

POST /azure/ha/working-environments/{workingEnvironmentId}/extra-capacity-serials/{licenseType}
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

PathParameter

licenseType

License type

true

enum (cvo, backup)

BodyParameter

body

extra capacity serial(s)

true

ExtraCapacitySerials
Consumes

  • application/json

Produces

  • application/json

Update extra capacity serials

PUT /azure/ha/working-environments/{workingEnvironmentId}/extra-capacity-serials/{licenseType}
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

PathParameter

licenseType

License type

true

enum (cvo, backup)

BodyParameter

body

extra capacity serial(s)

true

ExtraCapacitySerials
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

false

EnableCapacityTieringRequest
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

QueryParameter

svm

false

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 /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

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

Delete CIFS Configuration of an existing Cloud Volumes ONTAP working environment

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

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

CIFS Configuration request

true

CIFSDeleteRequest
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

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

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

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

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

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

Update Backup to Cloud 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

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

Register extra capacity license

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

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

PathParameter

licenseType

License type

true

enum (cvo, backup)

BodyParameter

body

extra capacity licenses(s)

true

ExtraCapacityLicenses
Consumes

  • application/json

Produces

  • application/json

Get extra capacity licenses for cvo

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

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

PathParameter

licenseType

License type

true

enum (cvo, backup)
Consumes

  • application/json

Produces

  • application/json

Update extra capacity license

PUT /azure/ha/working-environments/{workingEnvironmentId}/extra-capacity-licenses/{licenseType}
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

PathParameter

licenseType

License type

true

enum (cvo, backup)

BodyParameter

body

extra capacity license(s)

true

ExtraCapacityLicenses
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

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

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

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

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

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 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

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

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 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

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

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

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

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

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

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 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

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

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

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

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

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

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

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

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

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

Azure-vsa:metadata

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 Azure resource groups by region.

GET /azure/vsa/metadata/resource-groups
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

AzureResourceGroupByRegionResponse array
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 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 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 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

Create new blob container.

POST /azure/vsa/metadata/create-container
Parameters
Type Name Description Required Schema Default

BodyParameter

body

Create blob container request

true

CreateBlobContainerRequest
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 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 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

Retrieve all blob containers.

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

QueryParameter

subscriptionId

false

string

QueryParameter

cloudProviderAccountId

false

string

QueryParameter

resourceGroupName

true

string

QueryParameter

storageAccountName

true

string
Responses
HTTP Code Description Schema

default

success

AzureBlobContainer 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 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

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 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

Retrieves packages configuration

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

default

success

PackageInfoResponse array
Consumes

  • application/json

Produces

  • application/json

Azure-vsa:volumes

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

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

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

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

QueryParameter

workingEnvironmentId

Filter volumes by this working environment

true

string

QueryParameter

offset

offset

false

integer (int32)

QueryParameter

limit

limit

false

integer (int32)
Responses
HTTP Code Description Schema

default

success

VolumesListForBackup
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

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

Add ISCSI initiator.

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

BodyParameter

body

ISCSI initiator request

true

Initiator
Consumes

  • application/json

Produces

  • application/json

Get all ISCSI initiators.

GET /azure/vsa/volumes/initiator
Responses
HTTP Code Description Schema

default

success

InitiatorEntry array
Consumes

  • application/json

Produces

  • application/json

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

Get all igroups.

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

PathParameter

workingEnvironmentId

true

string

PathParameter

svmName

true

string
Responses
HTTP Code Description Schema

default

success

[IGroup] 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

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

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

Azure-vsa:working-environments

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

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

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

Register extra capacity license

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

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

PathParameter

licenseType

License type

true

enum (cvo, backup)

BodyParameter

body

extra capacity licenses(s)

true

ExtraCapacityLicenses
Consumes

  • application/json

Produces

  • application/json

Get extra capacity licenses for cvo

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

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

PathParameter

licenseType

License type

true

enum (cvo, backup)
Consumes

  • application/json

Produces

  • application/json

Update extra capacity license

PUT /azure/vsa/working-environments/{workingEnvironmentId}/extra-capacity-licenses/{licenseType}
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

PathParameter

licenseType

License type

true

enum (cvo, backup)

BodyParameter

body

extra capacity license(s)

true

ExtraCapacityLicenses
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

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

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

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

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

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

false

EnableCapacityTieringRequest
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

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

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

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

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

Delete CIFS Configuration of an existing Cloud Volumes ONTAP working environment

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

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

BodyParameter

body

CIFS Configuration request

true

CIFSDeleteRequest
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

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

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

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

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

Manually triggers subscription sync for all Cloud Volumes ONTAP working environments

POST /azure/vsa/working-environments/sync-subscription
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

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

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

Register extra capacity serials

POST /azure/vsa/working-environments/{workingEnvironmentId}/extra-capacity-serials/{licenseType}
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

PathParameter

licenseType

License type

true

enum (cvo, backup)

BodyParameter

body

extra capacity serial(s)

true

ExtraCapacitySerials
Consumes

  • application/json

Produces

  • application/json

Update extra capacity serials

PUT /azure/vsa/working-environments/{workingEnvironmentId}/extra-capacity-serials/{licenseType}
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string

PathParameter

licenseType

License type

true

enum (cvo, backup)

BodyParameter

body

extra capacity serial(s)

true

ExtraCapacitySerials
Consumes

  • application/json

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

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

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

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

QueryParameter

svm

false

string
Responses
HTTP Code Description Schema

default

success

CIFSConfigurationResponse 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

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

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

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

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

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

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

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

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

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

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

Update Backup to Cloud 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

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

Cbs

Restores a Cloud 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 Cloud backup request

true

RestoreCloudBackupRequest
Consumes

  • application/json

Produces

  • application/json

Retrieves CVO and OnPrem candidates for Cloud backup.

GET /cbs/all-candidates-for-backup
Responses
HTTP Code Description Schema

default

success

CandidateForCbsBackup array
Consumes

  • application/json

Produces

  • application/json

Updates a Backup to Cloud replication relationship.Operation may only be performed on working environments whose status is: ON

PUT /cbs/onprem/update-cbs-replication
Parameters
Type Name Description Required Schema Default

BodyParameter

body

Replication update request

true

CbsReplicationUpdateRequest

QueryParameter

workingEnvironmentId

Public Id of working environment

true

string

QueryParameter

svmName

SVM name

true

string

QueryParameter

volumeName

Volume name

true

string
Consumes

  • application/json

Produces

  • application/json

Retrieves list of volumes with Cloud backups information.

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

QueryParameter

offset

offset

false

integer (int32)

QueryParameter

limit

limit

false

integer (int32)
Responses
HTTP Code Description Schema

default

success

CbsVolumeList
Consumes

  • application/json

Produces

  • application/json

Add scheduled volume backup to Cloud 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 Cloud

true

ScheduledBackupToCbsRequest
Consumes

  • application/json

Produces

  • application/json

Updates a Backup to Cloud replication relationship.Operation may only be performed on working environments whose status is: ON, DEGRADED

PUT /cbs/vsa/update-cbs-replication
Parameters
Type Name Description Required Schema Default

BodyParameter

body

Replication update request

true

CbsReplicationUpdateRequest

QueryParameter

workingEnvironmentId

Public Id of working environment

true

string

QueryParameter

svmName

SVM name

true

string

QueryParameter

volumeName

Volume name

true

string
Consumes

  • application/json

Produces

  • application/json

Retrieves volume information for restore from Cloud 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

volumeUuid

Volume Uuid

true

string

QueryParameter

volumeWorkingEnvironmentId

Volume working environment Id

true

string

QueryParameter

backupName

Backup Name

true

string

QueryParameter

workingEnvironmentId

Destination working environment Id

true

string

QueryParameter

svmName

Destination svm name

false

string
Responses
HTTP Code Description Schema

default

success

CbsVolumeInfoForRestore
Consumes

  • application/json

Produces

  • application/json

Retrieves backup policies for Cloud backup.Operation may only be performed on working environments whose status is: ON, DEGRADED

GET /cbs/{workingEnvironmentId}/sm-policies-for-backup
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string
Responses
HTTP Code Description Schema

default

success

BackupPolicy array
Consumes

  • application/json

Produces

  • application/json

Backup to S3 by working environments.

POST /cbs/backup-by-working-environments
Parameters
Type Name Description Required Schema Default

BodyParameter

body

Backup to S3 request

true

EnableBackupRequest
Consumes

  • application/json

Produces

  • application/json

Retrieves VSA candidates for Cloud backup.

GET /cbs/vsa-candidates-for-backup
Responses
HTTP Code Description Schema

default

success

VsaCandidateForCbsBackup array
Consumes

  • application/json

Produces

  • application/json

Retrieves backup policies for Cloud backup.Operation may only be performed on working environments whose status is: ON

GET /cbs/onprem/{workingEnvironmentId}/sm-policies-for-backup
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

true

string
Responses
HTTP Code Description Schema

default

success

BackupPolicy array
Consumes

  • application/json

Produces

  • application/json

Delete all Cloud backups of a volume.Operation may only be performed on working environments whose status is: ON, DEGRADED

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

BodyParameter

body

Delete Cloud backup request

true

DeleteCbsBackupRequest
Consumes

  • application/json

Produces

  • application/json

Delete all Cloud backups of a volume.Operation may only be performed on working environments whose status is: ON

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

BodyParameter

body

Delete Cloud backup request

true

DeleteCbsBackupRequest
Consumes

  • application/json

Produces

  • application/json

Retrieves volume cloud backups.

GET /cbs/volume-backups
Parameters
Type Name Description Required Schema Default

QueryParameter

volumeUuid

Volume Uuid

true

string

QueryParameter

workingEnvironmentId

Volume working environment Id

true

string
Responses
HTTP Code Description Schema

default

success

CbsBackupInfo array
Consumes

  • application/json

Produces

  • application/json

Cloud-compliance

Disable scan.

POST /cloud-compliance/{serviceId}/disable-service-scan
Parameters
Type Name Description Required Schema Default

PathParameter

serviceId

Service ID

true

enum (ANF, S3)
Produces

  • application/json

Disable scan.

POST /cloud-compliance/{workingEnvironmentId}/disable-scan
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string
Produces

  • application/json

Enable scan.

POST /cloud-compliance/{serviceId}/enable-service-scan
Parameters
Type Name Description Required Schema Default

PathParameter

serviceId

Service ID

true

enum (ANF, S3)

BodyParameter

body

Enable Cloud Compliance request

false

EnableServiceScanRequest
Produces

  • application/json

Enable scan.

POST /cloud-compliance/{workingEnvironmentId}/enable-scan
Parameters
Type Name Description Required Schema Default

PathParameter

workingEnvironmentId

Public Id of working environment

true

string
Produces

  • application/json

Deploy Cloud Compliance instance by working environments.

POST /cloud-compliance/deploy-by-working-environments
Parameters
Type Name Description Required Schema Default

BodyParameter

body

deploy Cloud Compliance request

true

CreateCloudComplianceByWesRequest
Produces

  • application/json

Retrieve service Cloud Compliance status.

GET /cloud-compliance/{serviceId}/compliance-status
Parameters
Type Name Description Required Schema Default

PathParameter

serviceId

Service ID

true

enum (ANF, S3)
Responses
HTTP Code Description Schema

default

success

CloudComplianceStatusResponse
Produces

  • application/json

Retrieve Cloud Compliance info.

GET /cloud-compliance/info
Responses
HTTP Code Description Schema

default

success

CloudComplianceInfoResponse
Produces

  • application/json

Cloudsync

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.

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

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 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

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

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

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

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

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

Cvs

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

Get CVS Credentials.

GET /cvs/credentials
Responses
HTTP Code Description Schema

default

success

CvsAccountResponse
Consumes

  • application/json

Produces

  • application/json

Gcp-ha:aggregates

Retrieves aggregates

GET /gcp/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

Deletes an existing aggregate

DELETE /gcp/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

Creates a new aggregate

POST /gcp/ha/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/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

Gcp-ha:discovery

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

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

BodyParameter

body

Working environment

true

RecoverGcpHaRequest
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 region.

GET /gcp/ha/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

DiscoveredGcpHaResponse array
Consumes

  • application/json

Produces

  • application/json

Gcp-ha:metadata

Create new bucket

POST /gcp/ha/metadata/create-bucket
Parameters
Type Name Description Required Schema Default

BodyParameter

body

Create new bucket request

true

CreateBucketReq
Consumes

  • application/json

Produces

  • application/json

Retrieves all Cloud Volumes ONTAP configurations.

GET /gcp/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

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 GCP networks and subnetworks over which an Cloud Volumes ONTAP working environment may be created.

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

QueryParameter

region

true

string

QueryParameter

project

false

string
Responses
HTTP Code Description Schema

default

success

[Object] array
Consumes

  • application/json

Produces

  • application/json

Retrieves default snapshot policies available on a cluster

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

default

success

SnapshotPolicy array
Consumes

  • application/json

Produces

  • application/json

Retrieves packages configuration

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

default

success

PackageInfoResponse array
Consumes

  • application/json

Produces

  • application/json

Retrieves all cloud storage buckets

GET /gcp/ha/metadata/buckets
Parameters
Type Name Description Required Schema Default

QueryParameter

projectId

false

string
Responses
HTTP Code Description Schema

default

success

[GcpBucket] array
Consumes

  • application/json

Produces

  • application/json

Retrieves supported capacity tiers for gcp disk types

GET /gcp/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 GCP encryption keys for specific region

GET /gcp/ha/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 list of Projects that the caller has permission on

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

default

success

GcpProjectsResponse
Consumes

  • application/json

Produces

  • application/json

Retrieves list of Service Accounts from the project

GET /gcp/ha/metadata/service-accounts
Parameters
Type Name Description Required Schema Default

QueryParameter

project

false

string
Responses
HTTP Code Description Schema

default

success

GcpServiceAccountsResponse

<