Create a keyspace (HTTP)

Creates a new keyspace in a database.

Keyspaces are used to store collections and tables in Hyper-Converged Database (HCD).

Result

Creates the specified keyspace.

If the command succeeds, the response indicates the success.

Example successful response:

{
  "status": {
    "ok": 1
  }
}

Signature

Use the createKeyspace command.

curl -sS -L -X POST "API_ENDPOINT/v1" \
--header "Token: APPLICATION_TOKEN" \
--header "Content-Type: application/json" \
--data '{
  "createKeyspace": {
    "name": "KEYSPACE_NAME",
    "options": {
      "replication": REPLICATION_STRATEGY,
    }
  }
}'

Parameters

Name Type Summary

name

string

The name of the keyspace to create.

If a keyspace with the name already exists, a new keyspace isn’t created, and the command succeeds.

options.replication

object

Optional. Specifies the options for data replication across database nodes.

For an example, see Create a keyspace and specify replication options.

Examples

The following examples demonstrate how to create a keyspace.

Create a keyspace

curl -sS -L -X POST "API_ENDPOINT/v1" \
  --header "Token: APPLICATION_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
  "createKeyspace": {
    "name": "KEYSPACE_NAME"
  }
}'

Create a keyspace and specify replication options

For more information about data replication, see Data replication.

Example using SimpleStrategy:

curl -sS -L -X POST "API_ENDPOINT/v1" \
  --header "Token: APPLICATION_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
  "createKeyspace": {
    "name": "KEYSPACE_NAME",
    "options": {
      "replication": {
        "class": "SimpleStrategy", "replication_factor": 3
      }
    }
  }
}'

Example using NetworkTopologyStrategy:

curl -sS -L -X POST "API_ENDPOINT/v1" \
  --header "Token: APPLICATION_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
  "createKeyspace": {
    "name": "KEYSPACE_NAME",
    "options": {
      "replication": {
        "class": "NetworkTopologyStrategy", "datacenter1": 3, "datacenter2": 2
      }
    }
  }
}'

Was this helpful?

Give Feedback

How can we improve the documentation?

© Copyright IBM Corporation 2026 | Privacy policy | Terms of use |  Manage Privacy Choices

Apache, Apache Cassandra, Cassandra, Apache Tomcat, Tomcat, Apache Lucene, Apache Solr, Apache Hadoop, Hadoop, Apache Pulsar, Pulsar, Apache Spark, Spark, Apache TinkerPop, TinkerPop, Apache Kafka and Kafka are either registered trademarks or trademarks of the Apache Software Foundation or its subsidiaries in Canada, the United States and/or other countries. Kubernetes is the registered trademark of the Linux Foundation.

General Inquiries: Contact IBM