{
  "opencollection": "1.0.0",
  "info": {
    "name": "Qdrant Aliases Distributed API",
    "version": "master"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "api-key",
      "value": "{{api-key}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Distributed",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List shard keys",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}:{port}/collections/:collection_name/shards",
            "params": [
              {
                "name": "collection_name",
                "value": "",
                "type": "path",
                "description": "Name of the collection to list shard keys for"
              }
            ]
          },
          "docs": "List shard keys"
        },
        {
          "info": {
            "name": "Create shard key",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{protocol}://{hostname}:{port}/collections/:collection_name/shards",
            "params": [
              {
                "name": "collection_name",
                "value": "",
                "type": "path",
                "description": "Name of the collection to create shards for"
              },
              {
                "name": "timeout",
                "value": "",
                "type": "query",
                "description": "Wait for operation commit timeout in seconds.\nIf timeout is reached - request will return with service error.\n"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create shard key"
        },
        {
          "info": {
            "name": "Delete shard key",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{hostname}:{port}/collections/:collection_name/shards/delete",
            "params": [
              {
                "name": "collection_name",
                "value": "",
                "type": "path",
                "description": "Name of the collection to create shards for"
              },
              {
                "name": "timeout",
                "value": "",
                "type": "query",
                "description": "Wait for operation commit timeout in seconds.\nIf timeout is reached - request will return with service error.\n"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Delete shard key"
        },
        {
          "info": {
            "name": "Get cluster status info",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}:{port}/cluster"
          },
          "docs": "Get information about the current state and composition of the cluster"
        },
        {
          "info": {
            "name": "Collect cluster telemetry data",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}:{port}/cluster/telemetry",
            "params": [
              {
                "name": "details_level",
                "value": "",
                "type": "query",
                "description": "The level of detail to include in the response"
              },
              {
                "name": "timeout",
                "value": "",
                "type": "query",
                "description": "Timeout for this request"
              }
            ]
          },
          "docs": "Get telemetry data, from the point of view of the cluster. This includes peers info, collections info, shard transfers, and resharding status"
        },
        {
          "info": {
            "name": "Tries to recover current peer Raft state.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{hostname}:{port}/cluster/recover"
          },
          "docs": "Tries to recover current peer Raft state."
        },
        {
          "info": {
            "name": "Remove peer from the cluster",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{protocol}://{hostname}:{port}/cluster/peer/:peer_id",
            "params": [
              {
                "name": "peer_id",
                "value": "",
                "type": "path",
                "description": "Id of the peer"
              },
              {
                "name": "timeout",
                "value": "",
                "type": "query",
                "description": "Wait for operation commit timeout in seconds.\nIf timeout is reached - request will return with service error.\n"
              },
              {
                "name": "force",
                "value": "",
                "type": "query",
                "description": "If true - removes peer even if it has shards/replicas on it."
              }
            ]
          },
          "docs": "Tries to remove peer from the cluster. Will return an error if peer has shards on it."
        },
        {
          "info": {
            "name": "Collection cluster info",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}:{port}/collections/:collection_name/cluster",
            "params": [
              {
                "name": "collection_name",
                "value": "",
                "type": "path",
                "description": "Name of the collection to retrieve the cluster info for"
              }
            ]
          },
          "docs": "Get cluster information for a collection"
        },
        {
          "info": {
            "name": "Update collection cluster setup",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{hostname}:{port}/collections/:collection_name/cluster",
            "params": [
              {
                "name": "collection_name",
                "value": "",
                "type": "path",
                "description": "Name of the collection on which to to apply the cluster update operation"
              },
              {
                "name": "timeout",
                "value": "",
                "type": "query",
                "description": "Wait for operation commit timeout in seconds.\nIf timeout is reached - request will return with service error.\n"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update collection cluster setup"
        }
      ]
    }
  ],
  "bundled": true
}