Endpoint

/v3/snapshots/

GET

Returns information about all snapshots.

Parameters

Name Description Required
filter Filter the list of snapshots to exclude snapshots in process of being deleted, or include only snapshots in process of being deleted. By default, includes all snapshots.: * `all` - all, * `exclude_in_delete` - exclude_in_delete, * `only_in_delete` - only_in_delete Yes

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "api_snapshots",
  "type": "object",
  "properties": {
    "entries": {
      "type": "array",
      "items": {
        "description": "List of snapshot information",
        "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"
          }
        }
      }
    }
  }
}

POST

Creates a new snapshot and returns snapshot information.

Parameters

This resource has no parameters.

Request

Schema

{
  "description": "api_snapshot_create",
  "type": "object",
  "properties": {
    "name_suffix": {
      "description": "The snapshot name. Qumulo Core prepends the snapshot ID to the name. If not provided, Qumulo Core uses the value OnDemand.",
      "type": "string"
    },
    "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"
    },
    "source_file_id": {
      "description": "The ID of the directory to snapshot.",
      "type": "string"
    }
  }
}

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