Skip to content
Console(the OVHcloud Console, opens in a new tab)

Snapshot Policies

All operations require authentication.

7 operationsv1/storage/netapp
OpenAPI
Agent setup

List snapshot policiesProduction

GET
/1.0/storage/netapp/{serviceName}/snapshotPolicy

Returns the snapshot policies, including the default one. Each item contains only the policy ID and name: get a snapshot policy to read its rules and status.

Path parameters

serviceName
required
stringuuid

Service name

Response

200NetAppSnapshotPolicy[]successful operation
createdAt
read-only
stringdate-time

Snapshot policy creation date

description
string

Snapshot policy description

id
read-only
stringuuid

Snapshot policy ID

isDefault
read-only
boolean

Is this the default snapshot policy?

name
string

Snapshot policy name

rules
required
NetAppSnapshotPolicyRule[]

Snapshot policy rules, 1 to 4

status
read-only
NetAppSnapshotPolicyStatusEnum

Snapshot policy status

Valuesavailablecreatingdeletingerrorupdating

Example uses serviceName = 00000000-0000-0000-0000-000000000000

$ curl https://api.eu.ovhcloud.com/1.0/storage/netapp/{serviceName}/snapshotPolicy \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[  {    "createdAt": "2024-01-01T12:00:00Z",    "description": "string",    "id": "00000000-0000-0000-0000-000000000000",    "isDefault": true,    "name": "string",    "rules": [      {        "copies": 0,        "prefix": "string",        "schedule": {          "days": [            0          ],          "hours": [            0          ],          "minutes": [            0          ],          "months": [            0          ],          "weekdays": [            0          ]        }      }    ],    "status": "available"  }]

Get a snapshot policyProduction

GET
/1.0/storage/netapp/{serviceName}/snapshotPolicy/{snapshotPolicyId}

Returns the snapshot policy with its rules and status. A policy can be updated, deleted or assigned to a share only when its status is available.

Path parameters

serviceName
required
stringuuid

Service name

snapshotPolicyId
required
stringuuid

Snapshot policy ID

Response

200NetAppSnapshotPolicysuccessful operation
createdAt
read-only
stringdate-time

Snapshot policy creation date

description
string

Snapshot policy description

id
read-only
stringuuid

Snapshot policy ID

isDefault
read-only
boolean

Is this the default snapshot policy?

name
string

Snapshot policy name

rules
required
NetAppSnapshotPolicyRule[]

Snapshot policy rules, 1 to 4

status
read-only
NetAppSnapshotPolicyStatusEnum

Snapshot policy status

Valuesavailablecreatingdeletingerrorupdating

Example uses serviceName = 00000000-0000-0000-0000-000000000000, snapshotPolicyId = 00000000-0000-0000-0000-000000000000

$ curl https://api.eu.ovhcloud.com/1.0/storage/netapp/{serviceName}/snapshotPolicy/{snapshotPolicyId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "createdAt": "2024-01-01T12:00:00Z",  "description": "string",  "id": "00000000-0000-0000-0000-000000000000",  "isDefault": true,  "name": "string",  "rules": [    {      "copies": 0,      "prefix": "string",      "schedule": {        "days": [          0        ],        "hours": [          0        ],        "minutes": [          0        ],        "months": [          0        ],        "weekdays": [          0        ]      }    }  ],  "status": "available"}

Get the share snapshot policyProduction

GET
/1.0/storage/netapp/{serviceName}/share/{shareId}/snapshotPolicy

Returns the snapshot policy applied to the share and the status of its assignment. A share that was never assigned a policy uses the default snapshot policy of the service.

Path parameters

serviceName
required
stringuuid

Service name

shareId
required
stringuuid

Share ID

Response

200NetAppShareSnapshotPolicysuccessful operation
id
read-only
stringuuid

Snapshot policy ID

status
read-only
NetAppShareSnapshotPolicyStatusEnum

Association status between the share and the snapshot policy

Valuesactiveerrorupdating

Example uses serviceName = 00000000-0000-0000-0000-000000000000, shareId = 00000000-0000-0000-0000-000000000000

$ curl https://api.eu.ovhcloud.com/1.0/storage/netapp/{serviceName}/share/{shareId}/snapshotPolicy \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "id": "00000000-0000-0000-0000-000000000000",  "status": "active"}

Create a snapshot policyProduction

POST
/1.0/storage/netapp/{serviceName}/snapshotPolicy

Creates a policy made of rules, each with a schedule, a snapshot name prefix and a number of copies to keep. Creation is asynchronous: follow the snapshot policy status until it is available. The policy takes effect only once it is assigned to a share.

Path parameters

serviceName
required
stringuuid

Service name

Request body (required)

createdAt
read-only
stringdate-time

Snapshot policy creation date

description
string

Snapshot policy description

id
read-only
stringuuid

Snapshot policy ID

isDefault
read-only
boolean

Is this the default snapshot policy?

name
string

Snapshot policy name

rules
required
NetAppSnapshotPolicyRule[]

Snapshot policy rules, 1 to 4

status
read-only
NetAppSnapshotPolicyStatusEnum

Snapshot policy status

Valuesavailablecreatingdeletingerrorupdating

Response

200NetAppSnapshotPolicysuccessful operation
createdAt
read-only
stringdate-time

Snapshot policy creation date

description
string

Snapshot policy description

id
read-only
stringuuid

Snapshot policy ID

isDefault
read-only
boolean

Is this the default snapshot policy?

name
string

Snapshot policy name

rules
required
NetAppSnapshotPolicyRule[]

Snapshot policy rules, 1 to 4

status
read-only
NetAppSnapshotPolicyStatusEnum

Snapshot policy status

Valuesavailablecreatingdeletingerrorupdating

Example uses serviceName = 00000000-0000-0000-0000-000000000000

$ curl https://api.eu.ovhcloud.com/1.0/storage/netapp/{serviceName}/snapshotPolicy \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "createdAt": "2024-01-01T12:00:00Z",  "description": "string",  "id": "00000000-0000-0000-0000-000000000000",  "isDefault": true,  "name": "string",  "rules": [    {      "copies": 0,      "prefix": "string",      "schedule": {        "days": [          0        ],        "hours": [          0        ],        "minutes": [          0        ],        "months": [          0        ],        "weekdays": [          0        ]      }    }  ],  "status": "available"}

Delete a snapshot policyProduction

DELETE
/1.0/storage/netapp/{serviceName}/snapshotPolicy/{snapshotPolicyId}

Deletes the snapshot policy and its schedules. A policy applied to a share cannot be deleted: apply another non-default policy to the share first. The default policy cannot be deleted, and deletion is asynchronous: follow the snapshot policy status until the policy is no longer found.

Path parameters

serviceName
required
stringuuid

Service name

snapshotPolicyId
required
stringuuid

Snapshot policy ID

Response

200—successful operation

Example uses serviceName = 00000000-0000-0000-0000-000000000000, snapshotPolicyId = 00000000-0000-0000-0000-000000000000

$ curl https://api.eu.ovhcloud.com/1.0/storage/netapp/{serviceName}/snapshotPolicy/{snapshotPolicyId} \
  -H "authorization: Bearer $OVH_TOKEN"

Update a snapshot policyProduction

PUT
/1.0/storage/netapp/{serviceName}/snapshotPolicy/{snapshotPolicyId}

Updates the policy name and description. Rules cannot be changed: create a new policy instead. The policy must be available, and the default policy cannot be updated.

Path parameters

serviceName
required
stringuuid

Service name

snapshotPolicyId
required
stringuuid

Snapshot policy ID

Request body (required)

description
string

New snapshot policy description

name
string

New snapshot policy name

Response

200—successful operation

Example uses serviceName = 00000000-0000-0000-0000-000000000000, snapshotPolicyId = 00000000-0000-0000-0000-000000000000

$ curl https://api.eu.ovhcloud.com/1.0/storage/netapp/{serviceName}/snapshotPolicy/{snapshotPolicyId} \
  -H "authorization: Bearer $OVH_TOKEN"

Update the share snapshot policyProduction

PUT
/1.0/storage/netapp/{serviceName}/share/{shareId}/snapshotPolicy

Applies one of the snapshot policies of the service to the share. The share and the policy must be available, and the default policy cannot be assigned, so a share cannot be moved back to it. The update is asynchronous: follow the snapshot policy status of the share until active.

Path parameters

serviceName
required
stringuuid

Service name

shareId
required
stringuuid

Share ID

Request body (required)

snapshotPolicyID
required
stringuuid

Snapshot policy ID

Response

200—successful operation

Example uses serviceName = 00000000-0000-0000-0000-000000000000, shareId = 00000000-0000-0000-0000-000000000000

$ curl https://api.eu.ovhcloud.com/1.0/storage/netapp/{serviceName}/share/{shareId}/snapshotPolicy \
  -H "authorization: Bearer $OVH_TOKEN"