↓ API Libraries > REST API

REST API

Rockset’s REST API allows for creating and managing all resources in Rockset. Each supported endpoint is documented below.

All endpoints are only accessible via https.

All requests must be authorized with a Rockset API key, which can be created in the Rockset console. The API key must be provided as ApiKey {api_key} in the Authorization request header. For example:

Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT

ApiKeys

List API Keys

List all API keys for the authenticated user.

GET /v1/orgs/self/users/self/apikeys

Response (200)

{
  "data": [
    {
      "type": "api_key",
      "created_at": "2001-08-28T00:23:41Z",
      "name": "my-event-logger-key",
      "key": "aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT"
    }
  ]
}

Create API Key

Create a new API key for the authenticated user.

POST /v1/orgs/self/users/self/apikeys

Request Body

Response (200)

{
  "name": "event-logger"
}

Delete API Key

Delete an API key for the authenticated user.

DELETE /v1/orgs/self/users/self/apikeys/{name}

Response (200)

{
  "data": {
    "type": "api_key",
    "created_at": "2001-08-28T00:23:41Z",
    "name": "my-event-logger-key",
    "key": "aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT"
  }
}

Parameter	Location	Required	Type	Description
name	path	yes	string	name of the API key

List API Keys for any user (admin only)

List all API keys for any user (admin only).

GET /v1/orgs/self/users/{user}/apikeys

Response (200)

{
  "data": [
    {
      "type": "api_key",
      "created_at": "2001-08-28T00:23:41Z",
      "name": "my-event-logger-key",
      "key": "aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT"
    }
  ]
}

Parameter	Location	Required	Type	Description
user	path	yes	string

Create API Key for any user (admin only)

Create a new API key for any user (admin only).

POST /v1/orgs/self/users/{user}/apikeys

Request Body

Response (200)

{
  "name": "event-logger"
}

Parameter	Location	Required	Type	Description
user	path	yes	string

Delete API Key for any user (admin only)

Delete an API key for any user (admin only).

DELETE /v1/orgs/self/users/{user}/apikeys/{name}

Response (200)

{
  "data": {
    "type": "api_key",
    "created_at": "2001-08-28T00:23:41Z",
    "name": "my-event-logger-key",
    "key": "aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT"
  }
}

Parameter	Location	Required	Type	Description
name	path	yes	string	name of the API key
user	path	yes	string

Collections

List Collections

Retrieve all collections in a workspace.

GET /v1/orgs/self/ws/{workspace}/collections

Response (200)

{
  "data": [
    {
      "created_at": "2001-08-28T00:23:41Z",
      "created_by": "hello@rockset.com",
      "name": "global-transactions",
      "description": "transactions from stores worldwide",
      "workspace": "commons",
      "status": "READY",
      "sources": [
        {
          "type": "user",
          "s3": {
            "prefix": "prefix/to/keys",
            "pattern": "prefix/to/**/keys/*.format",
            "bucket": "s3://customer-account-info"
          },
          "kinesis": {
            "stream_name": "click_stream"
          },
          "dynamodb": {
            "table_name": "dynamodb_table_name"
          },
          "gcs": {
            "bucket": "server-logs",
            "prefix": "prefix/to/keys"
          },
          "file_upload": {
            "file_name": "file1.json",
            "file_size": 12345,
            "file_upload_time": "2019-01-15T21:48:23Z"
          },
          "format_params": {
            "json": true,
            "csv": {
              "firstLineAsColumnNames": true,
              "separator": ",",
              "encoding": "UTF-8",
              "columnNames": "[c1, c2, c3]",
              "columnTypes": "['BOOLEAN', 'INTEGER', 'FLOAT', 'STRING']",
              "quoteChar": "\""
            },
            "xml": {
              "root_tag": "root",
              "encoding": "UTF-8",
              "doc_tag": "row",
              "value_tag": "value",
              "attribute_prefix": "_attr"
            }
          }
        }
      ],
      "stats": {
        "doc_count": 2145,
        "total_size": 123456,
        "fill_progress": 0.6,
        "last_updated_ms": 1535101094433,
        "last_queried_ms": 1535101119334
      },
      "retention_secs": 2592000,
      "field_mappings": [
        {
          "name": "myTestMapping",
          "input_fields": [
            {
              "field_name": "address.city.zipcode",
              "if_missing": "['SKIP', 'PASS']",
              "is_drop": true,
              "param": "zip"
            }
          ],
          "output_field": {
            "field_name": "zip_hash",
            "value": "SHA256(:zip)",
            "on_error": "['SKIP', 'FAIL']"
          }
        }
      ]
    }
  ]
}

Parameter	Location	Required	Type	Description
workspace	path	yes	string	name of the workspace

Create Collection

Create new collection in a workspace.

POST /v1/orgs/self/ws/{workspace}/collections

Request Body

Response (200)

{
  "name": "global-transactions",
  "description": "transactions from stores worldwide",
  "sources": [
    {
      "type": "user",
      "s3": {
        "prefix": "prefix/to/keys",
        "pattern": "prefix/to/**/keys/*.format",
        "bucket": "s3://customer-account-info"
      },
      "kinesis": {
        "stream_name": "click_stream"
      },
      "dynamodb": {
        "table_name": "dynamodb_table_name"
      },
      "gcs": {
        "bucket": "server-logs",
        "prefix": "prefix/to/keys"
      },
      "file_upload": {
        "file_name": "file1.json",
        "file_size": 12345,
        "file_upload_time": "2019-01-15T21:48:23Z"
      },
      "format_params": {
        "json": true,
        "csv": {
          "firstLineAsColumnNames": true,
          "separator": ",",
          "encoding": "UTF-8",
          "columnNames": "[c1, c2, c3]",
          "columnTypes": "['BOOLEAN', 'INTEGER', 'FLOAT', 'STRING']",
          "quoteChar": "\""
        },
        "xml": {
          "root_tag": "root",
          "encoding": "UTF-8",
          "doc_tag": "row",
          "value_tag": "value",
          "attribute_prefix": "_attr"
        }
      }
    }
  ],
  "retention_secs": 1000000,
  "event_time_info": {
    "field": "timestamp",
    "format": "seconds_since_epoch",
    "time_zone": "UTC"
  },
  "field_mappings": [
    {
      "name": "myTestMapping",
      "input_fields": [
        {
          "field_name": "address.city.zipcode",
          "if_missing": "['SKIP', 'PASS']",
          "is_drop": true,
          "param": "zip"
        }
      ],
      "output_field": {
        "field_name": "zip_hash",
        "value": "SHA256(:zip)",
        "on_error": "['SKIP', 'FAIL']"
      }
    }
  ]
}

Parameter	Location	Required	Type	Description
workspace	path	yes	string	name of the workspace

Delete Collection

Delete a collection and all its documents from Rockset.

DELETE /v1/orgs/self/ws/{workspace}/collections/{collection}

Response (200)

{
  "data": {
    "created_at": "2001-08-28T00:23:41Z",
    "created_by": "hello@rockset.com",
    "name": "global-transactions",
    "description": "transactions from stores worldwide",
    "workspace": "commons",
    "status": "READY",
    "sources": [
      {
        "type": "user",
        "s3": {
          "prefix": "prefix/to/keys",
          "pattern": "prefix/to/**/keys/*.format",
          "bucket": "s3://customer-account-info"
        },
        "kinesis": {
          "stream_name": "click_stream"
        },
        "dynamodb": {
          "table_name": "dynamodb_table_name"
        },
        "gcs": {
          "bucket": "server-logs",
          "prefix": "prefix/to/keys"
        },
        "file_upload": {
          "file_name": "file1.json",
          "file_size": 12345,
          "file_upload_time": "2019-01-15T21:48:23Z"
        },
        "format_params": {
          "json": true,
          "csv": {
            "firstLineAsColumnNames": true,
            "separator": ",",
            "encoding": "UTF-8",
            "columnNames": "[c1, c2, c3]",
            "columnTypes": "['BOOLEAN', 'INTEGER', 'FLOAT', 'STRING']",
            "quoteChar": "\""
          },
          "xml": {
            "root_tag": "root",
            "encoding": "UTF-8",
            "doc_tag": "row",
            "value_tag": "value",
            "attribute_prefix": "_attr"
          }
        }
      }
    ],
    "stats": {
      "doc_count": 2145,
      "total_size": 123456,
      "fill_progress": 0.6,
      "last_updated_ms": 1535101094433,
      "last_queried_ms": 1535101119334
    },
    "retention_secs": 2592000,
    "field_mappings": [
      {
        "name": "myTestMapping",
        "input_fields": [
          {
            "field_name": "address.city.zipcode",
            "if_missing": "['SKIP', 'PASS']",
            "is_drop": true,
            "param": "zip"
          }
        ],
        "output_field": {
          "field_name": "zip_hash",
          "value": "SHA256(:zip)",
          "on_error": "['SKIP', 'FAIL']"
        }
      }
    ]
  }
}

Parameter	Location	Required	Type	Description
workspace	path	yes	string	name of the workspace
collection	path	yes	string	name of the collection

Get Collection

Get details about a collection.

GET /v1/orgs/self/ws/{workspace}/collections/{collection}

Response (200)

{
  "data": {
    "created_at": "2001-08-28T00:23:41Z",
    "created_by": "hello@rockset.com",
    "name": "global-transactions",
    "description": "transactions from stores worldwide",
    "workspace": "commons",
    "status": "READY",
    "sources": [
      {
        "type": "user",
        "s3": {
          "prefix": "prefix/to/keys",
          "pattern": "prefix/to/**/keys/*.format",
          "bucket": "s3://customer-account-info"
        },
        "kinesis": {
          "stream_name": "click_stream"
        },
        "dynamodb": {
          "table_name": "dynamodb_table_name"
        },
        "gcs": {
          "bucket": "server-logs",
          "prefix": "prefix/to/keys"
        },
        "file_upload": {
          "file_name": "file1.json",
          "file_size": 12345,
          "file_upload_time": "2019-01-15T21:48:23Z"
        },
        "format_params": {
          "json": true,
          "csv": {
            "firstLineAsColumnNames": true,
            "separator": ",",
            "encoding": "UTF-8",
            "columnNames": "[c1, c2, c3]",
            "columnTypes": "['BOOLEAN', 'INTEGER', 'FLOAT', 'STRING']",
            "quoteChar": "\""
          },
          "xml": {
            "root_tag": "root",
            "encoding": "UTF-8",
            "doc_tag": "row",
            "value_tag": "value",
            "attribute_prefix": "_attr"
          }
        }
      }
    ],
    "stats": {
      "doc_count": 2145,
      "total_size": 123456,
      "fill_progress": 0.6,
      "last_updated_ms": 1535101094433,
      "last_queried_ms": 1535101119334
    },
    "retention_secs": 2592000,
    "field_mappings": [
      {
        "name": "myTestMapping",
        "input_fields": [
          {
            "field_name": "address.city.zipcode",
            "if_missing": "['SKIP', 'PASS']",
            "is_drop": true,
            "param": "zip"
          }
        ],
        "output_field": {
          "field_name": "zip_hash",
          "value": "SHA256(:zip)",
          "on_error": "['SKIP', 'FAIL']"
        }
      }
    ]
  }
}

Parameter	Location	Required	Type	Description
workspace	path	yes	string	name of the workspace
collection	path	yes	string	name of the collection

Documents

Delete Documents

Delete documents from a collection in Rockset.

DELETE /v1/orgs/self/ws/{workspace}/collections/{collection}/docs

Request Body

Response (200)

{
  "data": [
    {
      "_id": "2cd61e3b"
    }
  ]
}

Parameter	Location	Required	Type	Description
workspace	path	yes	string	name of the workspace
collection	path	yes	string	name of the collection

Add Documents

Add documents to a collection in Rockset.

POST /v1/orgs/self/ws/{workspace}/collections/{collection}/docs

Request Body

Response (200)

{
  "data": [
    {}
  ]
}

Parameter	Location	Required	Type	Description
workspace	path	yes	string	name of the workspace
collection	path	yes	string	name of the collection

Integrations

List Integrations

List all integrations for organization.

GET /v1/orgs/self/integrations

Response (200)

{
  "data": [
    {
      "created_at": "2001-08-28T00:23:41Z",
      "created_by": "hello@rockset.com",
      "name": "event-logs",
      "description": "AWS account with event data for the data science team.",
      "aws": {
        "aws_access_key_id": "AKIAIOSFODNN7EXAMPLE",
        "aws_secret_access_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
      },
      "aws_external_id": {
        "aws_role_arn": "arn:aws:iam::2378964092:role/rockset-role",
        "aws_external_id": "adf98a7sdffkjh233rjh9a8sdf",
        "rockset_iam_user": "arn:aws:iam::983247598:root"
      },
      "gcp_service_account": {}
    }
  ]
}

Create Integration

Create a new integration with Rockset.

POST /v1/orgs/self/integrations

Request Body

Response (200)

{
  "name": "event-logs",
  "description": "AWS account with event data for the data science team.",
  "aws": {
    "aws_access_key_id": "AKIAIOSFODNN7EXAMPLE",
    "aws_secret_access_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
  },
  "aws_external_id": {
    "aws_role_arn": "arn:aws:iam::2378964092:role/rockset-role",
    "aws_external_id": "adf98a7sdffkjh233rjh9a8sdf",
    "rockset_iam_user": "arn:aws:iam::983247598:root"
  },
  "gcp_service_account": {}
}

Delete Integration

Remove an integration.

DELETE /v1/orgs/self/integrations/{integration}

Response (200)

{
  "data": {
    "created_at": "2001-08-28T00:23:41Z",
    "created_by": "hello@rockset.com",
    "name": "event-logs",
    "description": "AWS account with event data for the data science team.",
    "aws": {
      "aws_access_key_id": "AKIAIOSFODNN7EXAMPLE",
      "aws_secret_access_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
    },
    "aws_external_id": {
      "aws_role_arn": "arn:aws:iam::2378964092:role/rockset-role",
      "aws_external_id": "adf98a7sdffkjh233rjh9a8sdf",
      "rockset_iam_user": "arn:aws:iam::983247598:root"
    },
    "gcp_service_account": {}
  }
}

Parameter	Location	Required	Type	Description
integration	path	yes	string	name of the integration

Get Integration

Get information about a single integration.

GET /v1/orgs/self/integrations/{integration}

Response (200)

{
  "data": {
    "created_at": "2001-08-28T00:23:41Z",
    "created_by": "hello@rockset.com",
    "name": "event-logs",
    "description": "AWS account with event data for the data science team.",
    "aws": {
      "aws_access_key_id": "AKIAIOSFODNN7EXAMPLE",
      "aws_secret_access_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
    },
    "aws_external_id": {
      "aws_role_arn": "arn:aws:iam::2378964092:role/rockset-role",
      "aws_external_id": "adf98a7sdffkjh233rjh9a8sdf",
      "rockset_iam_user": "arn:aws:iam::983247598:root"
    },
    "gcp_service_account": {}
  },
  "collections": [
    {
      "created_at": "2001-08-28T00:23:41Z",
      "created_by": "hello@rockset.com",
      "name": "global-transactions",
      "description": "transactions from stores worldwide",
      "workspace": "commons",
      "status": "READY",
      "sources": [
        {
          "type": "user",
          "s3": {
            "prefix": "prefix/to/keys",
            "pattern": "prefix/to/**/keys/*.format",
            "bucket": "s3://customer-account-info"
          },
          "kinesis": {
            "stream_name": "click_stream"
          },
          "dynamodb": {
            "table_name": "dynamodb_table_name"
          },
          "gcs": {
            "bucket": "server-logs",
            "prefix": "prefix/to/keys"
          },
          "file_upload": {
            "file_name": "file1.json",
            "file_size": 12345,
            "file_upload_time": "2019-01-15T21:48:23Z"
          },
          "format_params": {
            "json": true,
            "csv": {
              "firstLineAsColumnNames": true,
              "separator": ",",
              "encoding": "UTF-8",
              "columnNames": "[c1, c2, c3]",
              "columnTypes": "['BOOLEAN', 'INTEGER', 'FLOAT', 'STRING']",
              "quoteChar": "\""
            },
            "xml": {
              "root_tag": "root",
              "encoding": "UTF-8",
              "doc_tag": "row",
              "value_tag": "value",
              "attribute_prefix": "_attr"
            }
          }
        }
      ],
      "stats": {
        "doc_count": 2145,
        "total_size": 123456,
        "fill_progress": 0.6,
        "last_updated_ms": 1535101094433,
        "last_queried_ms": 1535101119334
      },
      "retention_secs": 2592000,
      "field_mappings": [
        {
          "name": "myTestMapping",
          "input_fields": [
            {
              "field_name": "address.city.zipcode",
              "if_missing": "['SKIP', 'PASS']",
              "is_drop": true,
              "param": "zip"
            }
          ],
          "output_field": {
            "field_name": "zip_hash",
            "value": "SHA256(:zip)",
            "on_error": "['SKIP', 'FAIL']"
          }
        }
      ]
    }
  ]
}

Parameter	Location	Required	Type	Description
integration	path	yes	string	name of the integration

Organizations

Get Organization

Retrieve information about current organization.

GET /v1/orgs/self

Response (200)

{
  "data": {
    "id": "rockset",
    "display_name": "Rockset, Inc",
    "tier": "STARTER",
    "state": "ACTIVE"
  }
}

List All Collections

Retrieve all collections in an organization.

GET /v1/orgs/self/collections

Response (200)

{
  "data": [
    {
      "created_at": "2001-08-28T00:23:41Z",
      "created_by": "hello@rockset.com",
      "name": "global-transactions",
      "description": "transactions from stores worldwide",
      "workspace": "commons",
      "status": "READY",
      "sources": [
        {
          "type": "user",
          "s3": {
            "prefix": "prefix/to/keys",
            "pattern": "prefix/to/**/keys/*.format",
            "bucket": "s3://customer-account-info"
          },
          "kinesis": {
            "stream_name": "click_stream"
          },
          "dynamodb": {
            "table_name": "dynamodb_table_name"
          },
          "gcs": {
            "bucket": "server-logs",
            "prefix": "prefix/to/keys"
          },
          "file_upload": {
            "file_name": "file1.json",
            "file_size": 12345,
            "file_upload_time": "2019-01-15T21:48:23Z"
          },
          "format_params": {
            "json": true,
            "csv": {
              "firstLineAsColumnNames": true,
              "separator": ",",
              "encoding": "UTF-8",
              "columnNames": "[c1, c2, c3]",
              "columnTypes": "['BOOLEAN', 'INTEGER', 'FLOAT', 'STRING']",
              "quoteChar": "\""
            },
            "xml": {
              "root_tag": "root",
              "encoding": "UTF-8",
              "doc_tag": "row",
              "value_tag": "value",
              "attribute_prefix": "_attr"
            }
          }
        }
      ],
      "stats": {
        "doc_count": 2145,
        "total_size": 123456,
        "fill_progress": 0.6,
        "last_updated_ms": 1535101094433,
        "last_queried_ms": 1535101119334
      },
      "retention_secs": 2592000,
      "field_mappings": [
        {
          "name": "myTestMapping",
          "input_fields": [
            {
              "field_name": "address.city.zipcode",
              "if_missing": "['SKIP', 'PASS']",
              "is_drop": true,
              "param": "zip"
            }
          ],
          "output_field": {
            "field_name": "zip_hash",
            "value": "SHA256(:zip)",
            "on_error": "['SKIP', 'FAIL']"
          }
        }
      ]
    }
  ]
}

Queries

Query

Make a SQL query to Rockset.

POST /v1/orgs/self/queries

Request Body

Response (200)

{
  "sql": {
    "query": "SELECT count(*) FROM foo",
    "parameters": [
      {
        "name": "_id",
        "type": "string",
        "value": "85beb391"
      }
    ]
  }
}

Users

List Users

Retrieve all users for an organization.

GET /v1/orgs/self/users

Response (200)

{
  "data": [
    {
      "type": "user",
      "created_at": "2001-08-28T00:23:41Z",
      "email": "hello@rockset.com",
      "first_name": "John",
      "last_name": "Doe",
      "roles": "[\"admin\", \"member\", \"read-only\"]",
      "state": "ACTIVE"
    }
  ]
}

Create User

Create a new user for an organization.

POST /v1/orgs/self/users

Request Body

Response (200)

{
  "email": "hello@rockset.com",
  "roles": "[\"admin\", \"member\", \"read-only\"]"
}

Get Current User

Retrieve currently active user.

GET /v1/orgs/self/users/self

Response (200)

{
  "type": "user",
  "created_at": "2001-08-28T00:23:41Z",
  "email": "hello@rockset.com",
  "first_name": "John",
  "last_name": "Doe",
  "roles": "[\"admin\", \"member\", \"read-only\"]",
  "state": "ACTIVE"
}

Update Current User

Update currently active user.

POST /v1/orgs/self/users/self

Request Body

Response (200)

{
  "first_name": "John",
  "last_name": "Doe"
}

Delete User

Delete a user from an organization.

DELETE /v1/orgs/self/users/{user}

Response (200)

{
  "data": {
    "type": "user",
    "created_at": "2001-08-28T00:23:41Z",
    "email": "hello@rockset.com",
    "first_name": "John",
    "last_name": "Doe",
    "roles": "[\"admin\", \"member\", \"read-only\"]",
    "state": "ACTIVE"
  }
}

Parameter	Location	Required	Type	Description
user	path	yes	string	user email

Overview

Data Sources

Data Integrations

Data Format

SQL Reference

SQL Clients

API Libraries

Administration

REST API

ApiKeys

List API Keys

Create API Key

Delete API Key

List API Keys for any user (admin only)

Create API Key for any user (admin only)

Delete API Key for any user (admin only)

Collections

List Collections

Create Collection

Delete Collection

Get Collection

Documents

Delete Documents

Add Documents

Integrations

List Integrations

Create Integration

Delete Integration

Get Integration

Organizations

Get Organization

List All Collections

Queries

Query

Users

List Users

Create User

Get Current User

Update Current User

Delete User

Overview

Data Sources

Data Integrations

Data Format

SQL Reference

SQL Clients

API Libraries

Administration

REST API

#ApiKeys

#List API Keys

#Create API Key

#Delete API Key

#List API Keys for any user (admin only)

#Create API Key for any user (admin only)

#Delete API Key for any user (admin only)

#Collections

#List Collections

#Create Collection

#Delete Collection

#Get Collection

#Documents

#Delete Documents

#Add Documents

#Integrations

#List Integrations

#Create Integration

#Delete Integration

#Get Integration

#Organizations

#Get Organization

#List All Collections

#Queries

#Query

#Users

#List Users

#Create User

#Get Current User

#Update Current User

#Delete User

ApiKeys

List API Keys

Create API Key

Delete API Key

List API Keys for any user (admin only)

Create API Key for any user (admin only)

Delete API Key for any user (admin only)

Collections

List Collections

Create Collection

Delete Collection

Get Collection

Documents

Delete Documents

Add Documents

Integrations

List Integrations

Create Integration

Delete Integration

Get Integration

Organizations

Get Organization

List All Collections

Queries

Query

Users

List Users

Create User

Get Current User

Update Current User

Delete User