rest-api-spec.api.cat.repositories.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!

{
  "cat.repositories":{
    "documentation":{
      "url":"https://opensearch.org/docs/latest/api-reference/cat/cat-repositories/",
      "description":"Returns information about snapshot repositories registered in the cluster."
    },
    "stability":"stable",
    "url":{
      "paths":[
        {
          "path":"/_cat/repositories",
          "methods":[
            "GET"
          ]
        }
      ]
    },
    "params":{
      "format":{
        "type":"string",
        "description":"a short version of the Accept header, e.g. json, yaml"
      },
      "local":{
        "type":"boolean",
        "description":"Return local information, do not retrieve the state from master node",
        "default":false
      },
      "master_timeout":{
        "type":"time",
        "description":"Explicit operation timeout for connection to master node",
        "deprecated":{
          "version":"2.0.0",
          "description":"To promote inclusive language, use 'cluster_manager_timeout' instead."
        }
      },
      "cluster_manager_timeout":{
        "type":"time",
        "description":"Explicit operation timeout for connection to cluster-manager node"
      },
      "h":{
        "type":"list",
        "description":"Comma-separated list of column names to display"
      },
      "help":{
        "type":"boolean",
        "description":"Return help information",
        "default":false
      },
      "s":{
        "type":"list",
        "description":"Comma-separated list of column names or column aliases to sort by"
      },
      "v":{
        "type":"boolean",
        "description":"Verbose mode. Display column headers",
        "default":false
      }
    }
  }
}