/v3/snapshots/{id} | Qumulo Documentation

Endpoint

/v3/snapshots/{id}

GET

Returns information about a specific snapshot.

Parameters

Name	Description	Required
`id`	Snapshot identifier	Yes

Response

Codes

Code	Description
200	Return value on success

Schema

{
  "description": "api_snapshot_info",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique snapshot identifier.",
      "type": "number"
    },
    "name": {
      "description": "The snapshot name as it appears in the .snapshot directory over SMB or NFS.",
      "type": "string"
    },
    "timestamp": {
      "description": "The snapshot creation timestamp, encoded as RFC 3339, a normalized subset of ISO 8601.",
      "type": "string"
    },
    "source_file_id": {
      "description": "The source file ID of the directory for the snapshot.",
      "type": "string"
    },
    "policy_id": {
      "description": "The policy ID from which this snapshot was created, or null if this snapshot was created manually.",
      "type": "number"
    },
    "expiration": {
      "description": "The snapshot expiration time, encoded as RFC 3339, a normalized subset of ISO 8601. If expiration time is null, the snapshot never expires.",
      "type": "string"
    },
    "in_delete": {
      "description": "Specifies whether the snapshot is in the process of being deleted.",
      "type": "boolean"
    }
  }
}

PUT

Modifies a snapshot.

Parameters

Name	Description	Required
`id`	Snapshot identifier	Yes
`If-Match`	ETag for expected version	No

Request

Schema

{
  "description": "api_snapshot_info",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique snapshot identifier.",
      "type": "number"
    },
    "name": {
      "description": "The snapshot name as it appears in the .snapshot directory over SMB or NFS.",
      "type": "string"
    },
    "timestamp": {
      "description": "The snapshot creation timestamp, encoded as RFC 3339, a normalized subset of ISO 8601.",
      "type": "string"
    },
    "source_file_id": {
      "description": "The source file ID of the directory for the snapshot.",
      "type": "string"
    },
    "policy_id": {
      "description": "The policy ID from which this snapshot was created, or null if this snapshot was created manually.",
      "type": "number"
    },
    "expiration": {
      "description": "The snapshot expiration time, encoded as RFC 3339, a normalized subset of ISO 8601. If expiration time is null, the snapshot never expires.",
      "type": "string"
    },
    "in_delete": {
      "description": "Specifies whether the snapshot is in the process of being deleted.",
      "type": "boolean"
    }
  }
}

Response

Codes

Code	Description
200	Return value on success

Schema

{
  "description": "api_snapshot_info",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique snapshot identifier.",
      "type": "number"
    },
    "name": {
      "description": "The snapshot name as it appears in the .snapshot directory over SMB or NFS.",
      "type": "string"
    },
    "timestamp": {
      "description": "The snapshot creation timestamp, encoded as RFC 3339, a normalized subset of ISO 8601.",
      "type": "string"
    },
    "source_file_id": {
      "description": "The source file ID of the directory for the snapshot.",
      "type": "string"
    },
    "policy_id": {
      "description": "The policy ID from which this snapshot was created, or null if this snapshot was created manually.",
      "type": "number"
    },
    "expiration": {
      "description": "The snapshot expiration time, encoded as RFC 3339, a normalized subset of ISO 8601. If expiration time is null, the snapshot never expires.",
      "type": "string"
    },
    "in_delete": {
      "description": "Specifies whether the snapshot is in the process of being deleted.",
      "type": "boolean"
    }
  }
}

DELETE

Deletes a snapshot.

Parameters

Name	Description	Required
`id`	Snapshot identifier	Yes
`If-Match`	ETag for expected version	No

Response

Codes

Code	Description
202	Return value on success

PATCH

Modifies a snapshot.

Parameters

Name	Description	Required
`id`	Snapshot identifier	Yes
`If-Match`	ETag for expected version	No

Request

Schema

{
  "description": "api_snapshot_info",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique snapshot identifier.",
      "type": "number"
    },
    "name": {
      "description": "The snapshot name as it appears in the .snapshot directory over SMB or NFS.",
      "type": "string"
    },
    "timestamp": {
      "description": "The snapshot creation timestamp, encoded as RFC 3339, a normalized subset of ISO 8601.",
      "type": "string"
    },
    "source_file_id": {
      "description": "The source file ID of the directory for the snapshot.",
      "type": "string"
    },
    "policy_id": {
      "description": "The policy ID from which this snapshot was created, or null if this snapshot was created manually.",
      "type": "number"
    },
    "expiration": {
      "description": "The snapshot expiration time, encoded as RFC 3339, a normalized subset of ISO 8601. If expiration time is null, the snapshot never expires.",
      "type": "string"
    },
    "in_delete": {
      "description": "Specifies whether the snapshot is in the process of being deleted.",
      "type": "boolean"
    }
  }
}

Response

Codes

Code	Description
200	Return value on success

Schema

{
  "description": "api_snapshot_info",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique snapshot identifier.",
      "type": "number"
    },
    "name": {
      "description": "The snapshot name as it appears in the .snapshot directory over SMB or NFS.",
      "type": "string"
    },
    "timestamp": {
      "description": "The snapshot creation timestamp, encoded as RFC 3339, a normalized subset of ISO 8601.",
      "type": "string"
    },
    "source_file_id": {
      "description": "The source file ID of the directory for the snapshot.",
      "type": "string"
    },
    "policy_id": {
      "description": "The policy ID from which this snapshot was created, or null if this snapshot was created manually.",
      "type": "number"
    },
    "expiration": {
      "description": "The snapshot expiration time, encoded as RFC 3339, a normalized subset of ISO 8601. If expiration time is null, the snapshot never expires.",
      "type": "string"
    },
    "in_delete": {
      "description": "Specifies whether the snapshot is in the process of being deleted.",
      "type": "boolean"
    }
  }
}