Snapshot

All operations require authentication.

5 operationsv2/publicCloud/project

OpenAPI

Agent setup

List snapshotsProduction

GET

/v2/publicCloud/project/{projectId}/storage/file/snapshot

Returns the file storage snapshots of the project.

Path parameters

projectId

required

string

Project ID

Query parameters

shareId

stringuuid

Filter by source file storage ID

Headers

X-Pagination-Cursor

string

Pagination cursor

X-Pagination-Size

integer

Pagination size

Response

200FileStorageSnapshot[]successful operation

checksum

read-only

string

Computed hash representing the current target specification value

createdAt

read-only

stringdate-time

Creation date of the snapshot

currentState

read-only

FileStorageSnapshotCurrentState

Current observed state of the snapshot from the infrastructure

currentTasks

read-only

CurrentTask[]

Ongoing asynchronous tasks related to the snapshot

read-only

stringuuid

Unique identifier of the snapshot

resourceStatus

read-only

ResourceStatusEnum

Snapshot readiness in the system

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING

targetSpec

read-only

FileStorageSnapshotTargetSpec

Last target specification of the snapshot

updatedAt

read-only

stringdate-time

Last update date of the snapshot

Example uses projectId = string

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/storage/file/snapshot \
  -H "authorization: Bearer $OVH_TOKEN"

ResponseExample

1[2  {3    "checksum": "string",4    "createdAt": "2024-01-01T12:00:00Z",5    "currentState": {6      "description": "string",7      "location": {8        "availabilityZone": "string",9        "region": "string"10      },11      "name": "string",12      "share": {13        "id": "00000000-0000-0000-0000-000000000000"14      },15      "size": 016    },17    "currentTasks": [18      {19        "errors": [20          {21            "message": "string"22          }23        ],24        "id": "00000000-0000-0000-0000-000000000000",25        "link": "string",26        "status": "ERROR",27        "type": "string"28      }29    ],30    "id": "00000000-0000-0000-0000-000000000000",31    "resourceStatus": "CREATING",32    "targetSpec": {33      "description": "string",34      "name": "string",35      "share": {36        "id": "00000000-0000-0000-0000-000000000000"37      }38    },39    "updatedAt": "2024-01-01T12:00:00Z"40  }41]

Get a snapshotProduction

GET

/v2/publicCloud/project/{projectId}/storage/file/snapshot/{snapshotId}

Returns the snapshot and its current state, including its size and source file storage.

Path parameters

projectId

required

string

Project ID

snapshotId

required

stringuuid

Snapshot ID

Response

200FileStorageSnapshotsuccessful operation

checksum

read-only

string

Computed hash representing the current target specification value

createdAt

read-only

stringdate-time

Creation date of the snapshot

currentState

read-only

FileStorageSnapshotCurrentState

Current observed state of the snapshot from the infrastructure

currentTasks

read-only

CurrentTask[]

Ongoing asynchronous tasks related to the snapshot

read-only

stringuuid

Unique identifier of the snapshot

resourceStatus

read-only

ResourceStatusEnum

Snapshot readiness in the system

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING

targetSpec

read-only

FileStorageSnapshotTargetSpec

Last target specification of the snapshot

updatedAt

read-only

stringdate-time

Last update date of the snapshot

404objectError 404 response

Example uses projectId = string, snapshotId = 00000000-0000-0000-0000-000000000000

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/storage/file/snapshot/{snapshotId} \
  -H "authorization: Bearer $OVH_TOKEN"

ResponseExample

1{2  "checksum": "string",3  "createdAt": "2024-01-01T12:00:00Z",4  "currentState": {5    "description": "string",6    "location": {7      "availabilityZone": "string",8      "region": "string"9    },10    "name": "string",11    "share": {12      "id": "00000000-0000-0000-0000-000000000000"13    },14    "size": 015  },16  "currentTasks": [17    {18      "errors": [19        {20          "message": "string"21        }22      ],23      "id": "00000000-0000-0000-0000-000000000000",24      "link": "string",25      "status": "ERROR",26      "type": "string"27    }28  ],29  "id": "00000000-0000-0000-0000-000000000000",30  "resourceStatus": "CREATING",31  "targetSpec": {32    "description": "string",33    "name": "string",34    "share": {35      "id": "00000000-0000-0000-0000-000000000000"36    }37  },38  "updatedAt": "2024-01-01T12:00:00Z"39}

Create a snapshotProduction

POST

/v2/publicCloud/project/{projectId}/storage/file/snapshot

Creates a snapshot of a file storage. A new file storage can then be created from it.

Path parameters

projectId

required

string

Project ID

Request body (required)

targetSpec

required

FileStorageSnapshotTargetSpec

Desired target specification for the snapshot

Response

200FileStorageSnapshotsuccessful operation

checksum

read-only

string

Computed hash representing the current target specification value

createdAt

read-only

stringdate-time

Creation date of the snapshot

currentState

read-only

FileStorageSnapshotCurrentState

Current observed state of the snapshot from the infrastructure

currentTasks

read-only

CurrentTask[]

Ongoing asynchronous tasks related to the snapshot

read-only

stringuuid

Unique identifier of the snapshot

resourceStatus

read-only

ResourceStatusEnum

Snapshot readiness in the system

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING

targetSpec

read-only

FileStorageSnapshotTargetSpec

Last target specification of the snapshot

updatedAt

read-only

stringdate-time

Last update date of the snapshot

400objectError 400 response

404objectError 404 response

409objectError 409 response

Example uses projectId = string

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/storage/file/snapshot \
  -H "authorization: Bearer $OVH_TOKEN"

ResponseExample

1{2  "checksum": "string",3  "createdAt": "2024-01-01T12:00:00Z",4  "currentState": {5    "description": "string",6    "location": {7      "availabilityZone": "string",8      "region": "string"9    },10    "name": "string",11    "share": {12      "id": "00000000-0000-0000-0000-000000000000"13    },14    "size": 015  },16  "currentTasks": [17    {18      "errors": [19        {20          "message": "string"21        }22      ],23      "id": "00000000-0000-0000-0000-000000000000",24      "link": "string",25      "status": "ERROR",26      "type": "string"27    }28  ],29  "id": "00000000-0000-0000-0000-000000000000",30  "resourceStatus": "CREATING",31  "targetSpec": {32    "description": "string",33    "name": "string",34    "share": {35      "id": "00000000-0000-0000-0000-000000000000"36    }37  },38  "updatedAt": "2024-01-01T12:00:00Z"39}

Delete a snapshotProduction

DELETE

/v2/publicCloud/project/{projectId}/storage/file/snapshot/{snapshotId}

Deletes the snapshot.

Path parameters

projectId

required

string

Project ID

snapshotId

required

stringuuid

Snapshot ID

Response

200FileStorageSnapshotsuccessful operation

checksum

read-only

string

Computed hash representing the current target specification value

createdAt

read-only

stringdate-time

Creation date of the snapshot

currentState

read-only

FileStorageSnapshotCurrentState

Current observed state of the snapshot from the infrastructure

currentTasks

read-only

CurrentTask[]

Ongoing asynchronous tasks related to the snapshot

read-only

stringuuid

Unique identifier of the snapshot

resourceStatus

read-only

ResourceStatusEnum

Snapshot readiness in the system

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING

targetSpec

read-only

FileStorageSnapshotTargetSpec

Last target specification of the snapshot

updatedAt

read-only

stringdate-time

Last update date of the snapshot

404objectError 404 response

409objectError 409 response

Example uses projectId = string, snapshotId = 00000000-0000-0000-0000-000000000000

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/storage/file/snapshot/{snapshotId} \
  -H "authorization: Bearer $OVH_TOKEN"

ResponseExample

1{2  "checksum": "string",3  "createdAt": "2024-01-01T12:00:00Z",4  "currentState": {5    "description": "string",6    "location": {7      "availabilityZone": "string",8      "region": "string"9    },10    "name": "string",11    "share": {12      "id": "00000000-0000-0000-0000-000000000000"13    },14    "size": 015  },16  "currentTasks": [17    {18      "errors": [19        {20          "message": "string"21        }22      ],23      "id": "00000000-0000-0000-0000-000000000000",24      "link": "string",25      "status": "ERROR",26      "type": "string"27    }28  ],29  "id": "00000000-0000-0000-0000-000000000000",30  "resourceStatus": "CREATING",31  "targetSpec": {32    "description": "string",33    "name": "string",34    "share": {35      "id": "00000000-0000-0000-0000-000000000000"36    }37  },38  "updatedAt": "2024-01-01T12:00:00Z"39}

Update a snapshotProduction

PUT

/v2/publicCloud/project/{projectId}/storage/file/snapshot/{snapshotId}

Updates the snapshot name and description. Send the current checksum to prevent overwriting a concurrent change.

Path parameters

projectId

required

string

Project ID

snapshotId

required

stringuuid

Snapshot ID

Request body (required)

checksum

string

Optional concurrency-control checksum. When supplied, it must match the resource's current checksum or the request is rejected with a 409 checksum-mismatch conflict. When omitted or empty, the concurrency check is skipped and the write is forced (last-write-wins).

targetSpec

required

FileStorageSnapshotUpdateTargetSpec

Desired target specification for the snapshot

Response

200FileStorageSnapshotsuccessful operation

checksum

read-only

string

Computed hash representing the current target specification value

createdAt

read-only

stringdate-time

Creation date of the snapshot

currentState

read-only

FileStorageSnapshotCurrentState

Current observed state of the snapshot from the infrastructure

currentTasks

read-only

CurrentTask[]

Ongoing asynchronous tasks related to the snapshot

read-only

stringuuid

Unique identifier of the snapshot

resourceStatus

read-only

ResourceStatusEnum

Snapshot readiness in the system

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING

targetSpec

read-only

FileStorageSnapshotTargetSpec

Last target specification of the snapshot

updatedAt

read-only

stringdate-time

Last update date of the snapshot

404objectError 404 response

409objectError 409 response

Example uses projectId = string, snapshotId = 00000000-0000-0000-0000-000000000000

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/storage/file/snapshot/{snapshotId} \
  -H "authorization: Bearer $OVH_TOKEN"

ResponseExample

1{2  "checksum": "string",3  "createdAt": "2024-01-01T12:00:00Z",4  "currentState": {5    "description": "string",6    "location": {7      "availabilityZone": "string",8      "region": "string"9    },10    "name": "string",11    "share": {12      "id": "00000000-0000-0000-0000-000000000000"13    },14    "size": 015  },16  "currentTasks": [17    {18      "errors": [19        {20          "message": "string"21        }22      ],23      "id": "00000000-0000-0000-0000-000000000000",24      "link": "string",25      "status": "ERROR",26      "type": "string"27    }28  ],29  "id": "00000000-0000-0000-0000-000000000000",30  "resourceStatus": "CREATING",31  "targetSpec": {32    "description": "string",33    "name": "string",34    "share": {35      "id": "00000000-0000-0000-0000-000000000000"36    }37  },38  "updatedAt": "2024-01-01T12:00:00Z"39}