shutdown

The CMAPI shutdown endpoint shuts down MariaDB ColumnStore on every cluster node via HTTPS PUT with x-api-key authentication.

Shuts down ColumnStore on all nodes

See CMAPI for detail on REST API endpoint, required headers, and other available actions.

Description

Upon successful shutdown call CMAPI connects to each MariaDB ColumnStore node and performs shut down.

Call made via HTTPS PUT, with authentication via shared secret using the x-api-key header.

JSON data required for this call:

Key	Value
timeout	Maximum time in seconds to wait for completion of add-node operation

Bash alias mcsShutdown is available starting with ColumnStore 5.5.2.

Examples

Executing cURL Manually

CMAPI calls can be made from the command-line using cURL.

Replace the CMAPI_API_KEY and sample data in the following example:

curl -k -s -X PUT https://mcs1:8640/cmapi/0.4.0/cluster/shutdown \
   --header 'Content-Type:application/json' \
   --header 'x-api-key:<CMAPI_API_KEY>' \
   --data '{"timeout":20}' \
   | jq .

In this example, jq produces human-readable output from the returned JSON response.

Executing the Bash Alias

Starting with Enterprise ColumnStore 5.5.2, if your bash shell is configured to source the columnstoreAlias shell script, this command can be executed using the mcsShutdown alias. The alias executes curl and jq, so both programs must be installed on the system.

The alias automatically retrieves the IP address for the primary node using the mcsGetConfig command. The alias automatically retrieves the API key by reading /etc/columnstore/cmapi_server.conf.

mcsShutdown

These aliases use jq produces human-readable output from the returned JSON response.

_{This page is: Copyright © 2025 MariaDB. All rights reserved.}