The post command executes a REST API request against the cluster.

JSON Input Data Format
{
    "id": string,
    "method": string,
    "path": string,
    "data": string
}
id * Specifies the ID of the cluster.
method * Specifies the HTTP method for the POST request, which includes GET, POST, PATCH, PUT, and DELETE.
path * Specifies the REST API path, for example: "/collections"
data Specifies the JSON input data to be posted.
* Indicates a mandatory field.

Code Snippets
Here are several code snippets provided for your direct use. Simply select your preferred tool/language by clicking on it.


Successful Response
{
    "result": "OK",
    "payload": [
        {
            "created_at": 1723827138,
            "default_sorting_field": "num_employees",
            "enable_nested_fields": false,
            "fields": [
                {
                    "facet": false,
                    "index": true,
                    "infix": false,
                    "locale": "",
                    "name": "company_name",
                    "optional": false,
                    "sort": false,
                    "stem": false,
                    "type": "string"
                },
                {
                    "facet": false,
                    "index": true,
                    "infix": false,
                    "locale": "",
                    "name": "num_employees",
                    "optional": false,
                    "sort": true,
                    "stem": false,
                    "type": "int32"
                },
                {
                    "facet": true,
                    "index": true,
                    "infix": false,
                    "locale": "",
                    "name": "country",
                    "optional": false,
                    "sort": false,
                    "stem": false,
                    "type": "string"
                }
            ],
            "name": "companies",
            "num_documents": 0,
            "symbols_to_index": [],
            "token_separators": []
        },
        ...
    ]
}

Failed Response
{
    "result": "ERR",
    "message": "Error message ..."
}