Endpoint

/v3/snapshots/status/{id}

GET

Returns the status for a specific snapshot.

Parameters

Name Description Required
id Snapshot identifier Yes

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "api_snapshot_status",
  "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"
    },
    "source_file_path": {
      "description": "The snapshot source directory (if available).",
      "type": "string"
    },
    "policy_id": {
      "description": "The policy ID from which this snapshot was created, or null if this snapshot was created manually.",
      "type": "number"
    },
    "policy_name": {
      "description": "The policy name from which this snapshot was created, or null if this snapshot was created manually or its policy was deleted.",
      "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"
    },
    "owners": {
      "type": "array",
      "items": {
        "description": "This snapshot's owners. While there are entries on this list, the snapshot can't be deleted or modified.",
        "type": "object",
        "properties": {
          "id": {
            "description": "id",
            "type": "string"
          }
        }
      }
    },
    "in_delete": {
      "description": "Specifies whether the snapshot is in the process of being deleted.",
      "type": "boolean"
    },
    "lock_key": {
      "description": "The key that the snapshot is locked with. If set to null, the system does not create locked snapshots under this policy.",
      "type": "string"
    }
  }
}