Endpoint

/v2/snapshots/status/{id}

GET

Returns the status on a snapshot.

Parameters

Name Description Required
id Snapshot identifier Yes

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "api_snapshot_status_v2",
  "type": "object",
  "properties": {
    "id": {
      "description": "Unique identifier of the snapshot",
      "type": "number"
    },
    "name": {
      "description": "Name of the snapshot",
      "type": "string"
    },
    "timestamp": {
      "description": "Creation timestamp of the snapshot, encoded as RFC 3339, which is a normalized subset of ISO 8601. See http://tools.ietf.org/rfc/rfc3339.txt, section 5.6 for ABNF.",
      "type": "string"
    },
    "directory_name": {
      "description": "Snapshot directory name, as would be seen in the .snapshot directory over SMB or NFS.",
      "type": "string"
    },
    "source_file_id": {
      "description": "File ID of the snapshot source directory",
      "type": "string"
    },
    "source_file_path": {
      "description": "File path of the snapshot source directory",
      "type": "string"
    },
    "created_by_policy": {
      "description": "This snapshot was created by a policy. The name of that policy will be stored in the name field in place of a user-defined name.",
      "type": "boolean"
    },
    "expiration": {
      "description": "Time at which snapshot will be expired. Empty string if no expiration time set. Encoded as RFC 3339, which is a normalized subset of ISO 8601. See http://tools.ietf.org/rfc/rfc3339.txt, section 5.6 for ABNF.",
      "type": "string"
    },
    "owners": {
      "type": "array",
      "items": {
        "description": "Owners of this snapshot. The snapshot cannot be deleted or modified while the list is non-empty.",
        "type": "object",
        "properties": {
          "id": {
            "description": "id",
            "type": "string"
          }
        }
      }
    }
  }
}