Resource URL: /platform/<<version=1>>/snapshot/settings

    Overview: This resource applies the standard settings pattern to OneFS
              snapshots settings.

     Methods: GET, PUT

********************************************************************************

Method GET: List all settings

       URL: GET /platform/<<version=1>>/snapshot/settings

There are no query arguments for this method.

GET response body schema:
{
  "type": [
    {
      "additionalProperties": false, 
      "type": "object", 
      "description": "A list of errors that may be returned.", 
      "properties": {
        "errors": {
          "items": {
            "additionalProperties": false, 
            "type": "object", 
            "description": "An object describing a single error.", 
            "properties": {
              "field": {
                "type": "string", 
                "description": "The field with the error if applicable."
              }, 
              "message": {
                "type": "string", 
                "description": "The error message."
              }, 
              "code": {
                "type": "string", 
                "description": "The error code."
              }
            }
          }, 
          "type": "array"
        }
      }
    }, 
    {
      "type": "object", 
      "properties": {
        "settings": {
          "type": "object", 
          "properties": {
            "nfs_root_visible": {
              "required": true, 
              "type": "boolean", 
              "description": "True if root .snapshot directory is visible over NFS."
            }, 
            "smb_root_visible": {
              "required": true, 
              "type": "boolean", 
              "description": "True if root .snapshot directory is visible over SMB."
            }, 
            "local_root_visible": {
              "required": true, 
              "type": "boolean", 
              "description": "True if root .snapshot directory is visible locally."
            }, 
            "autodelete": {
              "required": true, 
              "type": "boolean", 
              "description": "True if the scheduled snapshot deletion services is on."
            }, 
            "reserve": {
              "required": true, 
              "type": "number", 
              "description": "Percentage of space to reserve for snapshots."
            }, 
            "smb_subdir_accessible": {
              "required": true, 
              "type": "boolean", 
              "description": "True if sub-directory .snapshot directory is accessible over SMB."
            }, 
            "local_root_accessible": {
              "required": true, 
              "type": "boolean", 
              "description": "True if root .snapshot directory is accessible locally."
            }, 
            "autocreate": {
              "required": true, 
              "type": "boolean", 
              "description": "True if the scheduled snapshot creation services is on."
            }, 
            "service": {
              "required": true, 
              "type": "boolean", 
              "description": "True if the system allows snapshot creation."
            }, 
            "nfs_root_accessible": {
              "required": true, 
              "type": "boolean", 
              "description": "True if root .snapshot directory is accessible over NFS."
            }, 
            "nfs_subdir_accessible": {
              "required": true, 
              "type": "boolean", 
              "description": "True if sub-directory .snapshot directory is accessible over NFS."
            }, 
            "smb_root_accessible": {
              "required": true, 
              "type": "boolean", 
              "description": "True if root .snapshot directory is accessible over SMB."
            }, 
            "global_visible_accessible": {
              "required": true, 
              "type": "boolean", 
              "description": "Global switch for other accessible and visible settings."
            }, 
            "local_subdir_accessible": {
              "required": true, 
              "type": "boolean", 
              "description": "True if sub-directory .snapshot directory is accessible locally."
            }
          }
        }
      }
    }
  ]
}

********************************************************************************

Method PUT: Modify one or more settings.

       URL: PUT /platform/<<version=1>>/snapshot/settings

There are no query arguments for this method.

PUT request body schema:
{
  "type": "object", 
  "properties": {
    "nfs_root_visible": {
      "required": false, 
      "type": "boolean", 
      "description": "True if root .snapshot directory is visible over NFS."
    }, 
    "smb_root_visible": {
      "required": false, 
      "type": "boolean", 
      "description": "True if root .snapshot directory is visible over SMB."
    }, 
    "local_root_visible": {
      "required": false, 
      "type": "boolean", 
      "description": "True if root .snapshot directory is visible locally."
    }, 
    "autodelete": {
      "required": false, 
      "type": "boolean", 
      "description": "True if the scheduled snapshot deletion services is on."
    }, 
    "reserve": {
      "required": false, 
      "type": "number", 
      "description": "Percentage of space to reserve for snapshots."
    }, 
    "smb_subdir_accessible": {
      "required": false, 
      "type": "boolean", 
      "description": "True if sub-directory .snapshot directory is accessible over SMB."
    }, 
    "local_root_accessible": {
      "required": false, 
      "type": "boolean", 
      "description": "True if root .snapshot directory is accessible locally."
    }, 
    "autocreate": {
      "required": false, 
      "type": "boolean", 
      "description": "True if the scheduled snapshot creation services is on."
    }, 
    "service": {
      "required": false, 
      "type": "boolean", 
      "description": "True if the system allows snapshot creation."
    }, 
    "nfs_root_accessible": {
      "required": false, 
      "type": "boolean", 
      "description": "True if root .snapshot directory is accessible over NFS."
    }, 
    "nfs_subdir_accessible": {
      "required": false, 
      "type": "boolean", 
      "description": "True if sub-directory .snapshot directory is accessible over NFS."
    }, 
    "smb_root_accessible": {
      "required": false, 
      "type": "boolean", 
      "description": "True if root .snapshot directory is accessible over SMB."
    }, 
    "global_visible_accessible": {
      "required": false, 
      "type": "boolean", 
      "description": "Global switch for other accessible and visible settings."
    }, 
    "local_subdir_accessible": {
      "required": false, 
      "type": "boolean", 
      "description": "True if sub-directory .snapshot directory is accessible locally."
    }
  }
}

There is no JSON response body for this method.
