The base URL is used to make requests to the REST API.

https://api.cassandra.io

After signing up, you will receive a token and account ID to access our API. These are your username and password for authenticated requests.

For example:

curl https://{your token}:{your account ID}@api.cassandra.io/1/accountstats
					

Keyspace API

In Cassandra, the keyspace is the container for your application data, similar to a schema in a relational database. Keyspaces are used to group column families together.

More on Keyspaces »

GET /1/keyspaces

This GET request returns a list of the account's keyspaces.

Example Response:

{ "keyspaces":["MyKeyspace1","MyKeyspace2"] }
					

POST /1/keyspace/{kName}

This POST request creates a new keyspace with the the name provided: {kName}

Example Response:

{
   "message":"Success",
   "status":"200",
   "detail":"Keyspace added successfully."
}
			   

DELETE /1/keyspace/{kName}

This DELETE request deletes an existing keyspace with the the name provided: {kName}

Example Response:

{
   "message":"Success",
   "status":"200",
   "detail":"Keyspace deleted successfully."
}
			   

ColumnFamily API

In Cassandra, Column Families are like tables in a relational database. Column Families can (and should) define metadata about the columns.

More on Column Families »

GET /1/columnfamily/{kName}

This GET request returns all the Column Families for the keyspace provided: {kName}

Example Response:

{
   "columnfamilies":[
      {
         "columnfamily":{
            "sortedby":"UTF8Type",
            "name":"CF_METADATA"
         },
         "columns":[

         ]
      },
      {
         "columnfamily":{
            "sortedby":"UTF8Type",
            "name":"TestCF"
         },
         "columns":         [
            {
               "index":"true",
               "validator":"UTF8Type",
               "name":"name"
            }
         ]
      }
   ]
}
					

GET /1/columnfamily/{kName}/{cfName}

This GET request returns the information on the Column Family provided: {cfName} for the keyspace: {kName}

Example Response:

{
   "columnfamily":{
      "sortedby":"UTF8Type",
      "name":"TestCF"
   },
   "columns":[
      {
         "index":"true",
         "validator":"UTF8Type",
         "name":"name"
      }
   ]
}
					

POST /1/columnfamily/{kName}/{cfName}/{cType}

This POST request creates a new Column Family of type {cType} named {cfName} in the keyspace: {kName}

Example Response:

{
   "message":"Success",
   "status":"200",
   "detail":"TestCF ColumnFamily created successfully"
}
					

DELETE /1/columnfamily/{kName}/{cfName}/?

This DELETE request deletes an existing Column Family named {cfName} in the keyspace: {kName}

Example Response:

{
   "message":"Success",
   "status":"200",
   "detail":"TestCF dropped."
}
					

Column API

A column is the smallest increment of data in Cassandra. It is a tuple containing a name, a value and a timestamp.

More on Columns »

POST /1/column/{kName}/{cfName}/{cName}/{cType}

This POST request creates a new column {cName} in the column family {cfName} in the keyspace {kName}. This call is required to create an indexed column. If you do not specify the type of your column before inserting data, the type defaults to UTF8.

This request takes GET parameters

Example Response:

{
   "message":"Success",
   "status":"200",
   "detail":"name Column created successfully"
}
					

Data API

The Data API provides basic CRUD methods for manipulating your data in Cassandra.io.

POST /1/data/{kName}/{cfName}/{rowKey}

This POST request adds data to the specified column family {cfName} using the rowkey {rowKey}. You can optionally specify a TTL for this record. Time to live will expire the record automatically and purge it from Cassandra.io after {ttl} number of seconds.

This request takes GET parameters

This request takes POST parameters of your key value pairs to be stored in Cassandra.io

For example: key=value&key2=value2&key3=value3

Example Response:

{
   "message":"Success",
   "status":"200",
   "detail":"testkey upsert successfull."
}
					

GET /1/data/{kName}/{cfName}/{rowKey}

This GET request returns the data for the rowKey {rowKey} in the column family {cfName} for the keyspace: {kName}. The data is pagable using the optional GET parameters.

This request takes GET parameters

Example Response:

{
   "columnfamily":{
      "sortedby":"UTF8Type",
      "name":"TestCF"
   },
   "columns":[
      {
         "index":"true",
         "validator":"UTF8Type",
         "name":"name"
      }
   ]
}
					

DELETE /1/data/{kName}/{cfName}/{rowKey}/{cName}

This DELETE request deletes a specific column {cName} in a Column Family {cfName} with the given rowKey {rowKey}. Data will also be removed.

Example Response:

{
   "message":"Success",
   "status":"200",
   "detail":"Deleted entry successfully."
}
					

DELETE /1/data/{kName}/{cfName}/{rowKey}

This DELETE request empties an existing row with the rowkey {rowKey} in the Column Family named {cfName} in the keyspace: {kName}. This row will remain empty until the next Cassandra.io compaction job deletes it permanently.

Example Response:

{
   "message":"Success",
   "status":"200",
   "detail":"Deleted entry successfully."
}
					

CQL API

In Cassandra, you can access your data using simple CQL commands. Cassandra.io transforms your CQL commands over a simple REST API.

More on CQL »

POST /1/cql/{kName}/{cfName}

This POST request inserts or updates data in the column family {cfName} of keyspace {kName}. Insert and Update do basically the same thing in Cassandra. For more information on these verbs see DataStax Insert/Update »

This request takes POST parameters

update=update set 'mysqlkey' = 'mycqlval', 'mykey2' = myval2' WHERE KEY IN ('"+ ROWKEY +"', '"+ COLNAME +"'")  
							

insert=insert set 'mysqlkey' = 'mycqlval', 'mykey2' = myval2' WHERE KEY IN ('"+ ROWKEY +"', '"+ COLNAME +"'")  
							

Example Response:

{
   "message":"Success",
   "status":"200",
   "detail":"testkey upsert successfull."
}