Endpoint

/v2/replication/source-relationships/{id}/queued-snapshots/

GET

List information for all snapshots awaiting replication by the specified relationship.

Parameters

Name Description Required
id Relationship identifier Yes

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "api_queued_replication_snapshots",
  "type": "object",
  "properties": {
    "entries": {
      "type": "array",
      "items": {
        "description": "List of information of snapshots awaiting replication",
        "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": "Source directory of the snapshot",
            "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"
          },
          "in_delete": {
            "description": "Whether or not the snapshot is in the process of being deleted",
            "type": "boolean"
          },
          "expiration": {
            "description": "Time at which snapshot will be expired on the source cluster. 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"
          },
          "target_expiration": {
            "description": "Time at which snapshot will be expired on the target cluster. 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"
          },
          "policy_id": {
            "description": "Unique identifier of the policy that created this snapshot",
            "type": "number"
          }
        }
      }
    }
  }
}