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

Snapshots

All operations require authentication.

9 operationsv1/storage/netapp
OpenAPI
Agent setup

List snapshotsProduction

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

Returns the ID and name of each snapshot of the share, including the snapshots taken automatically and by the system. Set detail to true to get all snapshot properties, such as their type and status.

Path parameters

serviceName
required
stringuuid

Service name

shareId
required
stringuuid

Share ID

Query parameters

detail
boolean

Get detailed information about each snapshot

Response

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

Snapshot creation date

description
string

Snapshot description

id
read-only
stringuuid

Snapshot ID

name
string

Snapshot name

path
read-only
string

Snapshot path

status
read-only
NetAppSnapshotStatusEnum

Snapshot status

Valuesavailablecreatingdeletingerrorerror_deletingmanage_errormanage_startingrestoringunmanage_errorunmanage_starting
type
read-only
NetAppSnapshotTypeEnum

Snapshot type

Valuesautomaticmanualsystem

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}/snapshot \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[  {    "createdAt": "2024-01-01T12:00:00Z",    "description": "string",    "id": "00000000-0000-0000-0000-000000000000",    "name": "string",    "path": "string",    "status": "available",    "type": "automatic"  }]

Get a snapshotProduction

GET
/1.0/storage/netapp/{serviceName}/share/{shareId}/snapshot/{snapshotId}

Returns the snapshot properties, its status and its type: manual, automatic when taken by the snapshot policy, or system. Holding an automatic snapshot turns it into a manual snapshot with a new ID.

Path parameters

serviceName
required
stringuuid

Service name

shareId
required
stringuuid

Share ID

snapshotId
required
stringuuid

Snapshot ID

Response

200NetAppShareSnapshotsuccessful operation
createdAt
read-only
stringdate-time

Snapshot creation date

description
string

Snapshot description

id
read-only
stringuuid

Snapshot ID

name
string

Snapshot name

path
read-only
string

Snapshot path

status
read-only
NetAppSnapshotStatusEnum

Snapshot status

Valuesavailablecreatingdeletingerrorerror_deletingmanage_errormanage_startingrestoringunmanage_errorunmanage_starting
type
read-only
NetAppSnapshotTypeEnum

Snapshot type

Valuesautomaticmanualsystem

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

$ curl https://api.eu.ovhcloud.com/1.0/storage/netapp/{serviceName}/share/{shareId}/snapshot/{snapshotId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "createdAt": "2024-01-01T12:00:00Z",  "description": "string",  "id": "00000000-0000-0000-0000-000000000000",  "name": "string",  "path": "string",  "status": "available",  "type": "automatic"}

Get the snapshot reserveProduction

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

Returns the percentage of the share size reserved for snapshots and the status of its last update.

Path parameters

serviceName
required
stringuuid

Service name

shareId
required
stringuuid

Share ID

Response

200NetAppShareSnapshotReservesuccessful operation
percent
read-only
integer

Share space percentage reserved for snapshots, 5 by default

status
read-only
NetAppShareSnapshotReserveStatusEnum

Status

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}/snapshotReserve \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "percent": 0,  "status": "active"}

Create a snapshotProduction

POST
/1.0/storage/netapp/{serviceName}/share/{shareId}/snapshot

Creates a manual snapshot of the share. Creation is asynchronous: the snapshot is returned with status creating, follow its status until available. The share must be in status available.

Path parameters

serviceName
required
stringuuid

Service name

shareId
required
stringuuid

Share ID

Request body (required)

createdAt
read-only
stringdate-time

Snapshot creation date

description
string

Snapshot description

id
read-only
stringuuid

Snapshot ID

name
string

Snapshot name

path
read-only
string

Snapshot path

status
read-only
NetAppSnapshotStatusEnum

Snapshot status

Valuesavailablecreatingdeletingerrorerror_deletingmanage_errormanage_startingrestoringunmanage_errorunmanage_starting
type
read-only
NetAppSnapshotTypeEnum

Snapshot type

Valuesautomaticmanualsystem

Response

200NetAppShareSnapshotsuccessful operation
createdAt
read-only
stringdate-time

Snapshot creation date

description
string

Snapshot description

id
read-only
stringuuid

Snapshot ID

name
string

Snapshot name

path
read-only
string

Snapshot path

status
read-only
NetAppSnapshotStatusEnum

Snapshot status

Valuesavailablecreatingdeletingerrorerror_deletingmanage_errormanage_startingrestoringunmanage_errorunmanage_starting
type
read-only
NetAppSnapshotTypeEnum

Snapshot type

Valuesautomaticmanualsystem

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}/snapshot \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "createdAt": "2024-01-01T12:00:00Z",  "description": "string",  "id": "00000000-0000-0000-0000-000000000000",  "name": "string",  "path": "string",  "status": "available",  "type": "automatic"}

Revert a share to its latest snapshotBeta

POST
/1.0/storage/netapp/{serviceName}/share/{shareId}/revert

Restores the share content to the given snapshot, which must be the most recent snapshot of the share. Data written after this snapshot is permanently lost. The share and the snapshot must be available, and the revert is asynchronous: follow the share status until it is available, or reverting_error if it fails.

Path parameters

serviceName
required
stringuuid

Service name

shareId
required
stringuuid

Share ID

Request body (required)

snapshotID
required
stringuuid

Latest share snapshot

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}/revert \
  -H "authorization: Bearer $OVH_TOKEN"

Hold an automatic snapshotBeta

POST
/1.0/storage/netapp/{serviceName}/share/{shareId}/snapshot/{snapshotId}/hold

Converts an automatic snapshot into a manual snapshot with a new ID, which the snapshot policy no longer deletes. Holding is asynchronous: follow the status of the returned snapshot until it is available. A held snapshot will not be released and is kept until you delete it.

Path parameters

serviceName
required
stringuuid

Service name

shareId
required
stringuuid

Share ID

snapshotId
required
stringuuid

Snapshot ID

Response

200NetAppShareSnapshotsuccessful operation
createdAt
read-only
stringdate-time

Snapshot creation date

description
string

Snapshot description

id
read-only
stringuuid

Snapshot ID

name
string

Snapshot name

path
read-only
string

Snapshot path

status
read-only
NetAppSnapshotStatusEnum

Snapshot status

Valuesavailablecreatingdeletingerrorerror_deletingmanage_errormanage_startingrestoringunmanage_errorunmanage_starting
type
read-only
NetAppSnapshotTypeEnum

Snapshot type

Valuesautomaticmanualsystem

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

$ curl https://api.eu.ovhcloud.com/1.0/storage/netapp/{serviceName}/share/{shareId}/snapshot/{snapshotId}/hold \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "createdAt": "2024-01-01T12:00:00Z",  "description": "string",  "id": "00000000-0000-0000-0000-000000000000",  "name": "string",  "path": "string",  "status": "available",  "type": "automatic"}

Delete a snapshotProduction

DELETE
/1.0/storage/netapp/{serviceName}/share/{shareId}/snapshot/{snapshotId}

Permanently deletes the snapshot. Deletion is asynchronous: follow the snapshot until it no longer exists. System snapshots cannot be deleted, and a manual snapshot must be in status available or error.

Path parameters

serviceName
required
stringuuid

Service name

shareId
required
stringuuid

Share ID

snapshotId
required
stringuuid

Snapshot ID

Response

200—successful operation

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

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

Update a snapshotProduction

PUT
/1.0/storage/netapp/{serviceName}/share/{shareId}/snapshot/{snapshotId}

Updates the snapshot name and description. Only manual snapshots can be updated: hold an automatic snapshot first.

Path parameters

serviceName
required
stringuuid

Service name

shareId
required
stringuuid

Share ID

snapshotId
required
stringuuid

Snapshot ID

Request body (required)

description
string

New snapshot description

name
string

New snapshot name

Response

200NetAppShareSnapshotsuccessful operation
createdAt
read-only
stringdate-time

Snapshot creation date

description
string

Snapshot description

id
read-only
stringuuid

Snapshot ID

name
string

Snapshot name

path
read-only
string

Snapshot path

status
read-only
NetAppSnapshotStatusEnum

Snapshot status

Valuesavailablecreatingdeletingerrorerror_deletingmanage_errormanage_startingrestoringunmanage_errorunmanage_starting
type
read-only
NetAppSnapshotTypeEnum

Snapshot type

Valuesautomaticmanualsystem

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

$ curl https://api.eu.ovhcloud.com/1.0/storage/netapp/{serviceName}/share/{shareId}/snapshot/{snapshotId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "createdAt": "2024-01-01T12:00:00Z",  "description": "string",  "id": "00000000-0000-0000-0000-000000000000",  "name": "string",  "path": "string",  "status": "available",  "type": "automatic"}

Update the snapshot reserveProduction

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

Changes the percentage of the share size reserved for snapshots without changing the share size, so a higher reserve leaves less space for data. The share must be available. The update is asynchronous: follow the snapshot reserve status until it returns to active.

Path parameters

serviceName
required
stringuuid

Service name

shareId
required
stringuuid

Share ID

Request body (required)

percent
required
integer

Share space percentage reserved for snapshots

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}/snapshotReserve \
  -H "authorization: Bearer $OVH_TOKEN"