rest-api-spec.api.snapshot.create_repository.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

There is a newer version: 2.18.0

{
  "snapshot.create_repository":{
    "documentation":{
      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html",
      "description":"Creates a repository."
    },
    "stability":"stable",
    "url":{
      "paths":[
        {
          "path":"/_snapshot/{repository}",
          "methods":[
            "PUT",
            "POST"
          ],
          "parts":{
            "repository":{
              "type":"string",
              "description":"A repository 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"
      },
      "timeout":{
        "type":"time",
        "description":"Explicit operation timeout"
      },
      "verify":{
        "type":"boolean",
        "description":"Whether to verify the repository after creation"
      }
    },
    "body":{
      "description":"The repository definition",
      "required":true
    }
  }
}