rest-api-spec.api.snapshot.create.json Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of rest-api-spec Show documentation

OpenSearch subproject :rest-api-spec

The newest version!

{
  "snapshot.create":{
    "documentation":{
      "url":"https://opensearch.org/docs/latest/api-reference/snapshots/create-snapshot/",
      "description":"Creates a snapshot in a repository."
    },
    "stability":"stable",
    "url":{
      "paths":[
        {
          "path":"/_snapshot/{repository}/{snapshot}",
          "methods":[
            "PUT",
            "POST"
          ],
          "parts":{
            "repository":{
              "type":"string",
              "description":"A repository name"
            },
            "snapshot":{
              "type":"string",
              "description":"A snapshot name"
            }
          }
        }
      ]
    },
    "params":{
      "master_timeout":{
        "type":"time",
        "description":"Explicit operation timeout for connection to master node",
        "deprecated":{
          "version":"2.0.0",
          "description":"To support inclusive language, use 'cluster_manager_timeout' instead."
        }
      },
      "cluster_manager_timeout":{
        "type":"time",
        "description":"Explicit operation timeout for connection to cluster-manager node"
      },
      "wait_for_completion":{
        "type":"boolean",
        "description":"Should this request wait until the operation has completed before returning",
        "default":false
      }
    },
    "body":{
      "description":"The snapshot definition",
      "required":false
    }
  }
}