Rockset API Reference

The Rockset API allows you to programmatically access and manage your Rockset resources and features. It follows REST architectural principles, and speaks exclusively in JSON.

The base URL of the Rockset API server is:

https://api.rs2.usw2.rockset.com

All endpoints are accessible via HTTPS only, ensuring that all data in flight is fully encrypted using TLS.

All requests made to the Rockset API should be formatted using JSON and have the Content-Type header set to application/json in order to ensure that they are read and processed properly.

Authentication

The Rockset API uses API keys to authenticate requests. They can be created and managed in the Rockset Console. The API key must be provided as ApiKey { api_key } in the Authorization request header.

For example, the following request header is properly formatted:

Authorization: ApiKey aB35kDjg931J5nsf4GjwMeErAVd832F7ahsW1S02kfZiab42s11TsfW5Sxt25asT

You can read more about Rockset's authentication & authorization features here.

Queries

QueryResponse Type

Attributes

query_idoptionalstring

unique id for this query

collectionsoptionalarray

list of collections queried by the query

resultsoptionalarray

list of objects returned by the query

statsoptional

meta information about the query

warningsoptionalarray

warnings received from the query

query_errorsoptionalarray

errors encountered while streaming the query

column_fieldsoptionalarray

meta information about each column in the result set

Example object

{
  "collections": [
    null
  ],
  "results": [
    {}
  ],
  "stats": {
    "elapsed_time_ms": 126,
    "throttled_time_micros": 126
  },
  "warnings": [
    null
  ],
  "query_errors": [
    {
      "type": "ResourceExceeded",
      "message": "Too many rows",
      "status_code": 429
    }
  ],
  "column_fields": [
    {
      "name": "_id",
      "type": "string"
    }
  ]
}

Query

Make a SQL query to Rockset.

POST /v1/orgs/self/queries

Arguments

sqloptionalobject
details about the query
Show child attributes

Example Request

Example Response

curl --request POST \
    --url https://api.rs2.usw2.rockset.com/v1/orgs/self/queries \
    -H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT' \
  -H 'Content-Type: application/json' \
    -d '{
    "sql": {
      "parameters": [
        {
          "name": "_id",
          "type": "string",
          "value": "85beb391"
        }
      ],
      "query": "SELECT * FROM foo where _id = :_id"
    }
  }'

Validate Query

Validate a SQL query with Rockset's parser and planner.

POST /v1/orgs/self/queries/validations

Arguments

sqloptionalobject
details about the query
Show child attributes
parametersoptionalboolean

Example Request

Example Response

curl --request POST \
    --url https://api.rs2.usw2.rockset.com/v1/orgs/self/queries/validations \
    -H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT' \
  -H 'Content-Type: application/json' \
    -d '{
    "sql": {
      "parameters": [
        {
          "name": "_id",
          "type": "string",
          "value": "85beb391"
        }
      ],
      "query": "SELECT * FROM foo where _id = :_id"
    }
  }'

Documents

Add Documents

Add documents to a collection.

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

Arguments

workspacerequiredstring(in path)
name of the workspace
collectionrequiredstring(in path)
name of the collection
datarequiredarray
Array of JSON documents

Example Request

Example Response

curl --request POST \
    --url https://api.rs2.usw2.rockset.com/v1/orgs/self/ws/commons/collections/thebestcollection/docs \
    -H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT' \
  -H 'Content-Type: application/json' \
    -d '{
    "data": [
      {}
    ]
  }'

Delete Documents

Delete documents from a collection.

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

Arguments

workspacerequiredstring(in path)
name of the workspace
collectionrequiredstring(in path)
name of the collection
datarequiredarray
array of document IDs
Show child attributes

Example Request

Example Response

curl --request DELETE \
    --url https://api.rs2.usw2.rockset.com/v1/orgs/self/ws/commons/collections/thebestcollection/docs \
    -H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT' \
  -H 'Content-Type: application/json' \
    -d '{
    "data": [
      {
        "_id": "2cd61e3b"
      }
    ]
  }'

Patch Documents

Update existing documents in a collection.

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

Arguments

workspacerequiredstring(in path)
name of the workspace
collectionrequiredstring(in path)
name of the collection
datarequiredarray
List of JSON Patch Documents
Show child attributes

Example Request

Example Response

curl --request PATCH \
    --url https://api.rs2.usw2.rockset.com/v1/orgs/self/ws/commons/collections/thebestcollection/docs \
    -H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT' \
  -H 'Content-Type: application/json' \
    -d '{
    "data": [
      {
        "_id": "ca2d6832-1bfd-f88f-0620-d2aa27a5d86c",
        "patch": [
          {
            "op": "add",
            "path": "/foo/bar",
            "value": "baz"
          }
        ]
      }
    ]
  }'

API Keys

Create API Key

Create a new API key for the authenticated user.

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

Arguments

namerequiredstring
descriptive label

Example Request

Example Response

curl --request POST \
    --url https://api.rs2.usw2.rockset.com/v1/orgs/self/users/self/apikeys \
    -H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT' \
  -H 'Content-Type: application/json' \
    -d '{
    "name": "event-logger"
  }'

Create API Key (any user)

Create a new API key for any user in your organization. Accessible to Admin users only.

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

Arguments

namerequiredstring
descriptive label
userrequiredstring(in path)
user email

Example Request

Example Response

curl --request POST \
    --url https://api.rs2.usw2.rockset.com/v1/orgs/self/users/thebestuser/apikeys \
    -H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT' \
  -H 'Content-Type: application/json' \
    -d '{
    "name": "event-logger"
  }'

Delete API Key

Delete an API key for the authenticated user.

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

Arguments

namerequiredstring(in path)
name of the API key

Example Request

Example Response

curl --request DELETE \
    --url https://api.rs2.usw2.rockset.com/v1/orgs/self/users/self/apikeys/name \
    -H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'

Delete API Key (any user)

Delete an API key for any user in your organization. Accessible to Admin users only.

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

Arguments

namerequiredstring(in path)
name of the API key
userrequiredstring(in path)
user email

Example Request

Example Response

curl --request DELETE \
    --url https://api.rs2.usw2.rockset.com/v1/orgs/self/users/thebestuser/apikeys/name \
    -H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'

List API Keys

List all API keys for the authenticated user.

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

Arguments

No arguments.

Example Request

Example Response

curl --request GET \
    --url https://api.rs2.usw2.rockset.com/v1/orgs/self/users/self/apikeys \
    -H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'

List API Keys (any user)

List all API keys for any user in your organization. Accessible to Admin users only.

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

Arguments

userrequiredstring(in path)
user email

Example Request

Example Response

curl --request GET \
    --url https://api.rs2.usw2.rockset.com/v1/orgs/self/users/thebestuser/apikeys \
    -H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'

Aliases

Create Alias

Create new alias in a workspace.

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

Arguments

workspacerequiredstring(in path)
name of the workspace
namerequiredstring
Alias name
descriptionoptionalstring
optional description
collectionsrequiredarray
list of fully qualified collection names referenced by alias

Example Request

Example Response

curl --request POST \
    --url https://api.rs2.usw2.rockset.com/v1/orgs/self/ws/commons/aliases \
    -H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT' \
  -H 'Content-Type: application/json' \
    -d '{
    "name": "aliasName",
    "description": "version alias",
    "collections": "[common.foo, prod.demo]"
  }'

Delete Alias

Delete an alias.

DELETE /v1/orgs/self/ws/{workspace}/aliases/{alias}

Arguments

workspacerequiredstring(in path)
name of the workspace
aliasrequiredstring(in path)
name of the alias

Example Request

Example Response

curl --request DELETE \
    --url https://api.rs2.usw2.rockset.com/v1/orgs/self/ws/commons/aliases/alias \
    -H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'

Get Alias

Get details about a alias

GET /v1/orgs/self/ws/{workspace}/aliases/{alias}

Arguments

workspacerequiredstring(in path)
name of the workspace
aliasrequiredstring(in path)
name of the alias

Example Request

Example Response

curl --request GET \
    --url https://api.rs2.usw2.rockset.com/v1/orgs/self/ws/commons/aliases/alias \
    -H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'

Get Query Lambdas with Alias

Get all Query Lambdas that hit a specific Rockset Alias.

GET /v1/orgs/self/ws/{workspace}/aliases/{alias}/lambdas

Arguments

workspacerequiredstring(in path)
aliasrequiredstring(in path)

Example Request

Example Response

curl --request GET \
    --url https://api.rs2.usw2.rockset.com/v1/orgs/self/ws/commons/aliases/alias/lambdas \
    -H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'

List Aliases

Retrieve all aliases in an organization

GET /v1/orgs/self/aliases

Arguments

No arguments.

Example Request

Example Response

curl --request GET \
    --url https://api.rs2.usw2.rockset.com/v1/orgs/self/aliases \
    -H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'

List Aliases for Workspace

Retrieve all aliases in a workspace.

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

Arguments

workspacerequiredstring(in path)
name of the workspace

Example Request

Example Response

curl --request GET \
    --url https://api.rs2.usw2.rockset.com/v1/orgs/self/ws/commons/aliases \
    -H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'

Update Alias

Update alias in a workspace.

POST /v1/orgs/self/ws/{workspace}/aliases/{alias}

Arguments

workspacerequiredstring(in path)
name of the workspace
aliasrequiredstring(in path)
name of the alias
descriptionoptionalstring
optional description
collectionsrequiredarray
list of fully qualified collection names referenced by alias

Example Request

Example Response

curl --request POST \
    --url https://api.rs2.usw2.rockset.com/v1/orgs/self/ws/commons/aliases/alias \
    -H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT' \
  -H 'Content-Type: application/json' \
    -d '{
    "description": "version alias",
    "collections": "[common.foo, prod.demo]"
  }'

Collections

Collection Type

Attributes

created_atoptionalstring

ISO-8601 date

created_byoptionalstring

email of user who created the collection

nameoptionalstring

unique identifer for collection, can contain alphanumeric or dash characters

descriptionoptionalstring

text describing the collection

workspaceoptionalstring

name of the workspace that the collection is in

statusoptionalstring

current status of collection, one of: CREATED, READY, DELETED

sourcesoptionalarray

list of sources from which collection ingests

statsoptional

metrics about the collection

retention_secsoptionalinteger

number of seconds after which data is purged based on event time

field_mappingsoptionalarray

list of mappings applied on all documents in a collection

clustering_keyoptionalarray

list of clustering fields for a collection

aliasesoptionalarray

list of aliases for a collection

field_schemasoptionalarray

list of field schemas

inverted_index_group_encoding_optionsoptional

inverted index group encoding options

fieldPartitionsoptionalarray

Example object

{
  "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": [
    {
      "integration_name": "aws-integration",
      "s3": {
        "access_key": "AKIAIOSFODNN7EXAMPLE",
        "secret_access": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
        "prefix": "prefix/to/keys",
        "pattern": "prefix/to/**/keys/*.format",
        "region": "us-west-2",
        "bucket": "s3://customer-account-info",
        "prefixes": "['/transactions', '/stores']",
        "format": "none",
        "mappings": [
          {
            "input_path": [
              null
            ],
            "mask": {
              "args": {}
            }
          }
        ]
      },
      "kinesis": {
        "aws_region": "us-east-2",
        "stream_name": "click_stream",
        "dms_primary_key": [
          null
        ]
      },
      "gcs": {
        "bucket": "server-logs",
        "prefix": "prefix/to/keys"
      },
      "redshift": {
        "database": "dev",
        "schema": "common",
        "table_name": "redshift_table_name",
        "incremental_field": "updated_at"
      },
      "dynamodb": {
        "aws_region": "us-east-2",
        "table_name": "dynamodb_table_name",
        "status": {
          "scan_start_time": "2001-08-28T00:23:41Z",
          "scan_end_time": "2001-08-28T00:23:41Z",
          "scan_records_processed": 1000,
          "scan_total_records": 2000,
          "state": "SCANNING_TABLE",
          "stream_last_processed_at": "2019-01-15T21:48:23Z"
        },
        "rcu": 1000
      },
      "file_upload": {
        "file_name": "file1.json",
        "file_size": 12345,
        "file_upload_time": "2019-01-15T21:48:23Z"
      },
      "kafka": {
        "kafka_topic_name": "example-topic",
        "status": {
          "state": "ACTIVE",
          "last_consumed_time": "2001-08-28T00:23:41Z",
          "num_documents_processed": 1337
        }
      },
      "mongodb": {
        "database_name": "my_database",
        "collection_name": "my_collection",
        "status": {
          "scan_start_time": "2001-08-28T00:23:41Z",
          "scan_end_time": "2001-08-28T00:23:41Z",
          "scan_records_processed": 1000,
          "scan_total_records": 2000,
          "state": "SCANNING_TABLE",
          "stream_last_insert_processed_at": "2019-01-15T21:48:23Z",
          "stream_last_update_processed_at": "2019-01-15T21:48:23Z",
          "stream_last_delete_processed_at": "2019-01-15T21:48:23Z",
          "stream_records_inserted": 10000,
          "stream_records_updated": 1000,
          "stream_records_deleted": 100
        }
      },
      "status": {
        "state": "INITIALIZING",
        "since": "2019-01-15T21:48:23Z",
        "message": "error 403 forbidden",
        "last_processed_at": "2019-01-15T21:48:23Z",
        "last_processed_item": "/path/to/some/object",
        "total_processed_items": 32849023,
        "last_error_at": "2019-01-15T21:48:23Z",
        "last_error_item": "/path/to/some/object",
        "last_error_reason": "invalid format .docx",
        "total_error_items": 32849023
      },
      "format_params": {
        "json": true,
        "csv": {
          "firstLineAsColumnNames": true,
          "separator": ",",
          "encoding": "UTF-8",
          "columnNames": "[c1, c2, c3]",
          "columnTypes": "['BOOLEAN', 'INTEGER', 'FLOAT', 'STRING']",
          "quoteChar": "\"",
          "escapeChar": "\\"
        },
        "xml": {
          "root_tag": "root",
          "encoding": "UTF-8",
          "doc_tag": "row",
          "value_tag": "value",
          "attribute_prefix": "_attr"
        }
      }
    }
  ],
  "stats": {
    "doc_count": 2145,
    "purged_doc_count": 2145,
    "fill_progress": 0.6,
    "last_queried_ms": 1535101119334,
    "last_updated_ms": 1535101094433,
    "total_size": 123456,
    "total_index_size": 123456,
    "row_index_size": 123456,
    "column_index_size": 123456,
    "inverted_index_size": 123456,
    "range_index_size": 123456,
    "purged_doc_size": 123456,
    "bytes_inserted": 123456,
    "bytes_overwritten": 123456
  },
  "retention_secs": 2592000,
  "field_mappings": [
    {
      "name": "myTestMapping",
      "is_drop_all_fields": true,
      "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']"
      }
    }
  ],
  "clustering_key": [
    {
      "field_name": "address.city.zipcode",
      "type": "AUTO",
      "keys": "Values of a record to partition on. This is not needed if the partition type is AUTO"
    }
  ],
  "aliases": [
    {
      "name": "demo",
      "description": "alias referencing collection in workspace",
      "workspace": "commons",
      "creator_email": "xyz@rockset.com",
      "collections": "[common.foo, prod.demo]",
      "state": "CREATED",
      "created_at": "2001-08-28T00:23:41Z",
      "modified_at": "2001-08-28T00:23:42Z"
    }
  ],
  "field_schemas": [
    {
      "field_name": "address.city.zipcode",
      "field_options": "Options to specify whether to build an inverted index  a type index, a range index and a column index on this field"
    }
  ],
  "inverted_index_group_encoding_options": {},
  "fieldPartitions": [
    {
      "field_name": "address.city.zipcode",
      "type": "AUTO",
      "keys": "Values of a record to partition on. This is not needed if the partition type is AUTO"
    }
  ]
}

Create Collection

Create new collection in a workspace.

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

Arguments

workspacerequiredstring(in path)
name of the workspace
namerequiredstring
unique identifier for collection, can contain alphanumeric or dash characters
descriptionoptionalstring
text describing the collection
sourcesoptionalarray
list of sources from which to ingest data
Show child attributes
retention_secsoptionalinteger
number of seconds after which data is purged, based on event time
event_time_infooptionalobject
configuration for event data
Show child attributes
field_mappingsoptionalarray
list of mappings
Show child attributes
clustering_keyoptionalarray
list of clustering fields
Show child attributes
field_schemasoptionalarray
list of field schemas
Show child attributes
inverted_index_group_encoding_optionsoptionalobject
inverted index group encoding options
Show child attributes

Example Request

Example Response

curl --request POST \
    --url https://api.rs2.usw2.rockset.com/v1/orgs/self/ws/commons/collections \
    -H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT' \
  -H 'Content-Type: application/json' \
    -d '{
    "name": "global-transactions",
    "description": "transactions from stores worldwide",
    "sources": [
      {
        "integration_name": "aws-integration",
        "s3": {
          "access_key": "AKIAIOSFODNN7EXAMPLE",
          "secret_access": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
          "prefix": "prefix/to/keys",
          "pattern": "prefix/to/**/keys/*.format",
          "region": "us-west-2",
          "bucket": "s3://customer-account-info",
          "prefixes": "['\''/transactions'\'', '\''/stores'\'']",
          "format": "none",
          "mappings": [
            {
              "input_path": [
                null
              ],
              "mask": {
                "args": {}
              }
            }
          ]
        },
        "kinesis": {
          "aws_region": "us-east-2",
          "stream_name": "click_stream",
          "dms_primary_key": [
            null
          ]
        },
        "gcs": {
          "bucket": "server-logs",
          "prefix": "prefix/to/keys"
        },
        "redshift": {
          "database": "dev",
          "schema": "common",
          "table_name": "redshift_table_name",
          "incremental_field": "updated_at"
        },
        "dynamodb": {
          "aws_region": "us-east-2",
          "table_name": "dynamodb_table_name",
          "status": {
            "scan_start_time": "2001-08-28T00:23:41Z",
            "scan_end_time": "2001-08-28T00:23:41Z",
            "scan_records_processed": 1000,
            "scan_total_records": 2000,
            "state": "SCANNING_TABLE",
            "stream_last_processed_at": "2019-01-15T21:48:23Z"
          },
          "rcu": 1000
        },
        "file_upload": {
          "file_name": "file1.json",
          "file_size": 12345,
          "file_upload_time": "2019-01-15T21:48:23Z"
        },
        "kafka": {
          "kafka_topic_name": "example-topic",
          "status": {
            "state": "ACTIVE",
            "last_consumed_time": "2001-08-28T00:23:41Z",
            "num_documents_processed": 1337
          }
        },
        "mongodb": {
          "database_name": "my_database",
          "collection_name": "my_collection",
          "status": {
            "scan_start_time": "2001-08-28T00:23:41Z",
            "scan_end_time": "2001-08-28T00:23:41Z",
            "scan_records_processed": 1000,
            "scan_total_records": 2000,
            "state": "SCANNING_TABLE",
            "stream_last_insert_processed_at": "2019-01-15T21:48:23Z",
            "stream_last_update_processed_at": "2019-01-15T21:48:23Z",
            "stream_last_delete_processed_at": "2019-01-15T21:48:23Z",
            "stream_records_inserted": 10000,
            "stream_records_updated": 1000,
            "stream_records_deleted": 100
          }
        },
        "status": {
          "state": "INITIALIZING",
          "since": "2019-01-15T21:48:23Z",
          "message": "error 403 forbidden",
          "last_processed_at": "2019-01-15T21:48:23Z",
          "last_processed_item": "/path/to/some/object",
          "total_processed_items": 32849023,
          "last_error_at": "2019-01-15T21:48:23Z",
          "last_error_item": "/path/to/some/object",
          "last_error_reason": "invalid format .docx",
          "total_error_items": 32849023
        },
        "format_params": {
          "json": true,
          "csv": {
            "firstLineAsColumnNames": true,
            "separator": ",",
            "encoding": "UTF-8",
            "columnNames": "[c1, c2, c3]",
            "columnTypes": "['\''BOOLEAN'\'', '\''INTEGER'\'', '\''FLOAT'\'', '\''STRING'\'']",
            "quoteChar": "\"",
            "escapeChar": "\\"
          },
          "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",
        "is_drop_all_fields": true,
        "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'\'']"
        }
      }
    ],
    "clustering_key": [
      {
        "field_name": "address.city.zipcode",
        "type": "AUTO",
        "keys": "Values of a record to partition on. This is not needed if the partition type is AUTO"
      }
    ],
    "field_schemas": [
      {
        "field_name": "address.city.zipcode",
        "field_options": "Options to specify whether to build an inverted index  a type index, a range index and a column index on this field"
      }
    ],
    "inverted_index_group_encoding_options": {}
  }'

Delete Collection

Delete a collection and all its documents from Rockset.

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

Arguments

workspacerequiredstring(in path)
name of the workspace
collectionrequiredstring(in path)
name of the collection

Example Request

Example Response

curl --request DELETE \
    --url https://api.rs2.usw2.rockset.com/v1/orgs/self/ws/commons/collections/thebestcollection \
    -H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'

Get Aliases for Collection

Get all Aliases for a specific Rockset Collection.

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

Arguments

workspacerequiredstring(in path)
collectionrequiredstring(in path)

Example Request

Example Response

curl --request GET \
    --url https://api.rs2.usw2.rockset.com/v1/orgs/self/ws/commons/collections/thebestcollection/aliases \
    -H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'

Get Collection

Get details about a collection.

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

Arguments

workspacerequiredstring(in path)
name of the workspace
collectionrequiredstring(in path)
name of the collection

Example Request

Example Response

curl --request GET \
    --url https://api.rs2.usw2.rockset.com/v1/orgs/self/ws/commons/collections/thebestcollection \
    -H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'

Get Query Lambdas for Collection

Get all Query Lambdas that hit a specific Rockset Collection.

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

Arguments

workspacerequiredstring(in path)
name of the workspace
collectionrequiredstring(in path)
name of the collection

Example Request

Example Response

curl --request GET \
    --url https://api.rs2.usw2.rockset.com/v1/orgs/self/ws/commons/collections/thebestcollection/lambdas \
    -H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'

List Collections

Retrieve all collections in an organization.

GET /v1/orgs/self/collections

Arguments

No arguments.

Example Request

Example Response

curl --request GET \
    --url https://api.rs2.usw2.rockset.com/v1/orgs/self/collections \
    -H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'

List Collections for Workspace

Retrieve all collections in a workspace.

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

Arguments

workspacerequiredstring(in path)
name of the workspace

Example Request

Example Response

curl --request GET \
    --url https://api.rs2.usw2.rockset.com/v1/orgs/self/ws/commons/collections \
    -H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'

IP Allowlist

Create IP Allowlist Network Policy

Create a new entry to allow an IP address

POST /v1/orgs/self/ip/allowlist

Arguments

namerequiredstring
IP Allowlist policy name
descriptionoptionalstring
optional description
ip_addressrequiredstring
individual IP address or range of IP addresses in CIDR notation

Example Request

Example Response

curl --request POST \
    --url https://api.rs2.usw2.rockset.com/v1/orgs/self/ip/allowlist \
    -H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT' \
  -H 'Content-Type: application/json' \
    -d '{
    "name": "Office",
    "description": "Office IP address",
    "ip_address": "82.217.192.0/18"
  }'

Delete IP Allowlist Network Policy

Delete an entry for IP allowlist network policy.

DELETE /v1/orgs/self/ip/allowlist/{name}

Arguments

namerequiredstring(in path)
name of the IP allowlist network policy

Example Request

Example Response

curl --request DELETE \
    --url https://api.rs2.usw2.rockset.com/v1/orgs/self/ip/allowlist/name \
    -H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'

Get IP Allowlist Network Policy

Get details about a IP Allowlist network policy

GET /v1/orgs/self/ip/allowlist/{name}

Arguments

namerequiredstring(in path)
name of the IP Allowlist network policy

Example Request

Example Response

curl --request GET \
    --url https://api.rs2.usw2.rockset.com/v1/orgs/self/ip/allowlist/name \
    -H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'

List IP Allowlist Entries

GET /v1/orgs/self/ip/allowlist

Arguments

No arguments.

Example Request

Example Response

curl --request GET \
    --url https://api.rs2.usw2.rockset.com/v1/orgs/self/ip/allowlist \
    -H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'

Integrations

Integration Type

Integrations that can be associated with data sources to create collections. Only one type of integration may be specified.

Attributes

nameoptionalstring

descriptive label and unique identifier

descriptionoptionalstring

longer explanation for the integration

collectionsoptionalarray

list of collections that use the integration

created_byoptionalstring

email of user who created the integration

created_atoptionalstring

ISO-8601 date

s3optional

Amazon S3 details, must have one of aws_access_key or aws_role

kinesisoptional

Amazon Kinesis details, must have one of aws_access_key or aws_role

dynamodboptional

Amazon DynamoDB details, must have one of aws_access_key or aws_role

redshiftoptional

Amazon Redshift details

gcsoptional

GCS details

segmentoptional

Segment details

kafkaoptional

Kafka details

mongodboptional

MongoDb details

Example object

{
  "name": "event-logs",
  "description": "AWS account with event data for the data science team.",
  "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": [
        {
          "integration_name": "aws-integration",
          "s3": {
            "access_key": "AKIAIOSFODNN7EXAMPLE",
            "secret_access": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
            "prefix": "prefix/to/keys",
            "pattern": "prefix/to/**/keys/*.format",
            "region": "us-west-2",
            "bucket": "s3://customer-account-info",
            "prefixes": "['/transactions', '/stores']",
            "format": "none",
            "mappings": [
              {
                "input_path": [
                  null
                ],
                "mask": {
                  "args": {}
                }
              }
            ]
          },
          "kinesis": {
            "aws_region": "us-east-2",
            "stream_name": "click_stream",
            "dms_primary_key": [
              null
            ]
          },
          "gcs": {
            "bucket": "server-logs",
            "prefix": "prefix/to/keys"
          },
          "redshift": {
            "database": "dev",
            "schema": "common",
            "table_name": "redshift_table_name",
            "incremental_field": "updated_at"
          },
          "dynamodb": {
            "aws_region": "us-east-2",
            "table_name": "dynamodb_table_name",
            "status": {
              "scan_start_time": "2001-08-28T00:23:41Z",
              "scan_end_time": "2001-08-28T00:23:41Z",
              "scan_records_processed": 1000,
              "scan_total_records": 2000,
              "state": "SCANNING_TABLE",
              "stream_last_processed_at": "2019-01-15T21:48:23Z"
            },
            "rcu": 1000
          },
          "file_upload": {
            "file_name": "file1.json",
            "file_size": 12345,
            "file_upload_time": "2019-01-15T21:48:23Z"
          },
          "kafka": {
            "kafka_topic_name": "example-topic",
            "status": {
              "state": "ACTIVE",
              "last_consumed_time": "2001-08-28T00:23:41Z",
              "num_documents_processed": 1337
            }
          },
          "mongodb": {
            "database_name": "my_database",
            "collection_name": "my_collection",
            "status": {
              "scan_start_time": "2001-08-28T00:23:41Z",
              "scan_end_time": "2001-08-28T00:23:41Z",
              "scan_records_processed": 1000,
              "scan_total_records": 2000,
              "state": "SCANNING_TABLE",
              "stream_last_insert_processed_at": "2019-01-15T21:48:23Z",
              "stream_last_update_processed_at": "2019-01-15T21:48:23Z",
              "stream_last_delete_processed_at": "2019-01-15T21:48:23Z",
              "stream_records_inserted": 10000,
              "stream_records_updated": 1000,
              "stream_records_deleted": 100
            }
          },
          "status": {
            "state": "INITIALIZING",
            "since": "2019-01-15T21:48:23Z",
            "message": "error 403 forbidden",
            "last_processed_at": "2019-01-15T21:48:23Z",
            "last_processed_item": "/path/to/some/object",
            "total_processed_items": 32849023,
            "last_error_at": "2019-01-15T21:48:23Z",
            "last_error_item": "/path/to/some/object",
            "last_error_reason": "invalid format .docx",
            "total_error_items": 32849023
          },
          "format_params": {
            "json": true,
            "csv": {
              "firstLineAsColumnNames": true,
              "separator": ",",
              "encoding": "UTF-8",
              "columnNames": "[c1, c2, c3]",
              "columnTypes": "['BOOLEAN', 'INTEGER', 'FLOAT', 'STRING']",
              "quoteChar": "\"",
              "escapeChar": "\\"
            },
            "xml": {
              "root_tag": "root",
              "encoding": "UTF-8",
              "doc_tag": "row",
              "value_tag": "value",
              "attribute_prefix": "_attr"
            }
          }
        }
      ],
      "stats": {
        "doc_count": 2145,
        "purged_doc_count": 2145,
        "fill_progress": 0.6,
        "last_queried_ms": 1535101119334,
        "last_updated_ms": 1535101094433,
        "total_size": 123456,
        "total_index_size": 123456,
        "row_index_size": 123456,
        "column_index_size": 123456,
        "inverted_index_size": 123456,
        "range_index_size": 123456,
        "purged_doc_size": 123456,
        "bytes_inserted": 123456,
        "bytes_overwritten": 123456
      },
      "retention_secs": 2592000,
      "field_mappings": [
        {
          "name": "myTestMapping",
          "is_drop_all_fields": true,
          "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']"
          }
        }
      ],
      "clustering_key": [
        {
          "field_name": "address.city.zipcode",
          "type": "AUTO",
          "keys": "Values of a record to partition on. This is not needed if the partition type is AUTO"
        }
      ],
      "aliases": [
        {
          "name": "demo",
          "description": "alias referencing collection in workspace",
          "workspace": "commons",
          "creator_email": "xyz@rockset.com",
          "collections": "[common.foo, prod.demo]",
          "state": "CREATED",
          "created_at": "2001-08-28T00:23:41Z",
          "modified_at": "2001-08-28T00:23:42Z"
        }
      ],
      "field_schemas": [
        {
          "field_name": "address.city.zipcode",
          "field_options": "Options to specify whether to build an inverted index  a type index, a range index and a column index on this field"
        }
      ],
      "inverted_index_group_encoding_options": {},
      "fieldPartitions": [
        {
          "field_name": "address.city.zipcode",
          "type": "AUTO",
          "keys": "Values of a record to partition on. This is not needed if the partition type is AUTO"
        }
      ]
    }
  ],
  "created_by": "hello@rockset.com",
  "created_at": "2001-08-28T00:23:41Z",
  "s3": {
    "aws_access_key": {
      "aws_access_key_id": "AKIAIOSFODNN7EXAMPLE",
      "aws_secret_access_key": "wJal...."
    },
    "aws_role": {
      "aws_role_arn": "arn:aws:iam::2378964092:role/rockset-role"
    }
  },
  "kinesis": {
    "aws_access_key": {
      "aws_access_key_id": "AKIAIOSFODNN7EXAMPLE",
      "aws_secret_access_key": "wJal...."
    },
    "aws_role": {
      "aws_role_arn": "arn:aws:iam::2378964092:role/rockset-role"
    }
  },
  "dynamodb": {
    "aws_access_key": {
      "aws_access_key_id": "AKIAIOSFODNN7EXAMPLE",
      "aws_secret_access_key": "wJal...."
    },
    "aws_role": {
      "aws_role_arn": "arn:aws:iam::2378964092:role/rockset-role"
    }
  },
  "redshift": {
    "aws_access_key": {
      "aws_access_key_id": "AKIAIOSFODNN7EXAMPLE",
      "aws_secret_access_key": "wJal...."
    },
    "username": "awsuser",
    "password": "pswd....",
    "host": "test.yuyugt.us-west-2.redshift.amazonaws.com",
    "port": 5439,
    "s3_bucket_path": "s3://redshift-unload"
  },
  "gcs": {
    "gcp_service_account": {}
  },
  "segment": {},
  "kafka": {
    "kafka_topic_names": [
      null
    ],
    "source_status_by_topic": "topic-a:DORMANT",
    "kafka_data_format": "json"
  },
  "mongodb": {
    "connection_uri": "mongodb+srv://<username>:<password>@server.example.com/"
  }
}

Create Integration

Create a new integration.

POST /v1/orgs/self/integrations

Arguments

namerequiredstring
descriptive label
descriptionoptionalstring
longer explanation for the integration
s3optionalobject
Amazon S3 details, must have one of aws_access_key or aws_role
Show child attributes
kinesisoptionalobject
Amazon Kinesis details, must have one of aws_access_key or aws_role
Show child attributes
dynamodboptionalobject
Amazon DynamoDB details, must have one of aws_access_key or aws_role
Show child attributes
redshiftoptionalobject
Amazon Redshift details
Show child attributes
gcsoptionalobject
GCS details
Show child attributes
segmentoptionalobject
Show child attributes
kafkaoptionalobject
Show child attributes
mongodboptionalobject
MongoDb details
Show child attributes

Example Request

Example Response

curl --request POST \
    --url https://api.rs2.usw2.rockset.com/v1/orgs/self/integrations \
    -H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT' \
  -H 'Content-Type: application/json' \
    -d '{
    "name": "event-logs",
    "description": "AWS account with event data for the data science team.",
    "s3": {
      "aws_access_key": {
        "aws_access_key_id": "AKIAIOSFODNN7EXAMPLE",
        "aws_secret_access_key": "wJal...."
      },
      "aws_role": {
        "aws_role_arn": "arn:aws:iam::2378964092:role/rockset-role"
      }
    },
    "kinesis": {
      "aws_access_key": {
        "aws_access_key_id": "AKIAIOSFODNN7EXAMPLE",
        "aws_secret_access_key": "wJal...."
      },
      "aws_role": {
        "aws_role_arn": "arn:aws:iam::2378964092:role/rockset-role"
      }
    },
    "dynamodb": {
      "aws_access_key": {
        "aws_access_key_id": "AKIAIOSFODNN7EXAMPLE",
        "aws_secret_access_key": "wJal...."
      },
      "aws_role": {
        "aws_role_arn": "arn:aws:iam::2378964092:role/rockset-role"
      }
    },
    "redshift": {
      "aws_access_key": {
        "aws_access_key_id": "AKIAIOSFODNN7EXAMPLE",
        "aws_secret_access_key": "wJal...."
      },
      "username": "awsuser",
      "password": "pswd....",
      "host": "test.yuyugt.us-west-2.redshift.amazonaws.com",
      "port": 5439,
      "s3_bucket_path": "s3://redshift-unload"
    },
    "gcs": {
      "gcp_service_account": {}
    },
    "segment": {},
    "kafka": {
      "kafka_topic_names": [
        null
      ],
      "source_status_by_topic": "topic-a:DORMANT",
      "kafka_data_format": "json"
    },
    "mongodb": {
      "connection_uri": "mongodb+srv://<username>:<password>@server.example.com/"
    }
  }'

Delete Integration

Remove an integration.

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

Arguments

integrationrequiredstring(in path)
name of the integration

Example Request

Example Response

curl --request DELETE \
    --url https://api.rs2.usw2.rockset.com/v1/orgs/self/integrations/thebestintegration \
    -H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'

Get Integration

Get information about a single integration.

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

Arguments

integrationrequiredstring(in path)
name of the integration

Example Request

Example Response

curl --request GET \
    --url https://api.rs2.usw2.rockset.com/v1/orgs/self/integrations/thebestintegration \
    -H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'

List Integrations

List all integrations in an organization.

GET /v1/orgs/self/integrations

Arguments

No arguments.

Example Request

Example Response

curl --request GET \
    --url https://api.rs2.usw2.rockset.com/v1/orgs/self/integrations \
    -H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'

Organizations

Organization Type

An organization in Rockset is a container for users and collections.

Attributes

deletionScheduledAtoptionalstring

idoptionalstring

unique identifier for the organization

created_atoptionalstring

ISO-8601 date

display_nameoptionalstring

name of the organization

company_nameoptionalstring

name of the company

external_idoptionalstring

organization's unique external ID within Rockset

rockset_useroptionalstring

stateoptionalstring

org state

clustersoptionalarray

Example object

{
  "id": "rockset",
  "created_at": "2001-08-28T00:23:41Z",
  "display_name": "Rockset, Inc",
  "company_name": "Rockset, Inc",
  "external_id": "<hash>",
  "state": "TRIAL",
  "clusters": [
    {
      "id": "asdf98-as9df8adf-adsf9asfd",
      "cluster_type": "PRIVATE",
      "aws_region": "us-west-2",
      "domain": "rockset",
      "top_level_domain": ".com",
      "apiserver_url": "api.rockset.us-west-2.rockset.com"
    }
  ]
}

Get Organization

Retrieve information about current organization.

GET /v1/orgs/self

Arguments

No arguments.

Example Request

Example Response

curl --request GET \
    --url https://api.rs2.usw2.rockset.com/v1/orgs/self \
    -H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'

Query Lambdas

QueryLambda Type

Attributes

workspaceoptionalstring

workspace of this Query Lambda

last_updated_byoptionalstring

user that created this Query Lambda

last_updatedoptionalstring

ISO-8601 date of when Query Lambda was last updated

nameoptionalstring

Query Lambda name

version_countoptionalinteger

number of Query Lambda versions

collectionsoptionalarray

collections/aliases queried by underlying SQL query

latest_versionoptional

Query Lambda version details for most recently created version

Example object

{
  "workspace": "commons",
  "last_updated_by": "..@rockset.com",
  "last_updated": "2001-08-28T00:23:41Z",
  "name": "myQuery",
  "version_count": 1,
  "collections": [
    null
  ],
  "latest_version": {
    "workspace": "commons",
    "created_by": "..@rockset.com",
    "created_at": "2001-08-28T00:23:41Z",
    "name": "myQuery",
    "version": "acb99feg92bcaf",
    "description": "production version foo",
    "sql": {
      "query": "SELECT 'Foo'",
      "default_parameters": [
        {
          "name": "_id",
          "type": "string",
          "value": "85beb391"
        }
      ]
    },
    "collections": [
      null
    ],
    "state": "ACTIVE",
    "stats": {
      "last_executed": "2001-08-28T00:23:41Z",
      "last_executed_by": "...@rockset.com",
      "last_execution_error": "2001-08-28T00:23:41Z",
      "last_execution_error_message": "[error message]"
    }
  }
}

Create Query Lambda

Create a Query Lambda in given workspace.

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

Arguments

workspacerequiredstring(in path)
name of the workspace
namerequiredstring
Query Lambda name
descriptionoptionalstring
optional description
sqlrequiredobject
Query Lambda SQL query
Show child attributes

Example Request

Example Response

curl --request POST \
    --url https://api.rs2.usw2.rockset.com/v1/orgs/self/ws/commons/lambdas \
    -H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT' \
  -H 'Content-Type: application/json' \
    -d '{
    "name": "myQueryLambda",
    "description": "production version foo",
    "sql": {
      "query": "SELECT '\''Foo'\''",
      "default_parameters": [
        {
          "name": "_id",
          "type": "string",
          "value": "85beb391"
        }
      ]
    }
  }'

Create Query Lambda Tag

Create a tag for a specific Query Lambda version, or update that tag if it already exists.

POST /v1/orgs/self/ws/{workspace}/lambdas/{queryLambda}/tags

Arguments

workspacerequiredstring(in path)
name of the workspace
queryLambdarequiredstring(in path)
name of the Query Lambda
tag_namerequiredstring
name of Query Lambda tag
versionrequiredstring
hash identifying a Query Lambda tag

Example Request

Example Response

curl --request POST \
    --url https://api.rs2.usw2.rockset.com/v1/orgs/self/ws/commons/lambdas/queryLambda/tags \
    -H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT' \
  -H 'Content-Type: application/json' \
    -d '{
    "tag_name": "production",
    "version": "123ABC"
  }'

Delete Query Lambda

Delete a Query Lambda.

DELETE /v1/orgs/self/ws/{workspace}/lambdas/{queryLambda}

Arguments

workspacerequiredstring(in path)
name of the workspace
queryLambdarequiredstring(in path)
name of the Query Lambda

Example Request

Example Response

curl --request DELETE \
    --url https://api.rs2.usw2.rockset.com/v1/orgs/self/ws/commons/lambdas/queryLambda \
    -H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'

Delete Query Lambda Tag Version

Delete a tag for a specific Query Lambda

DELETE /v1/orgs/self/ws/{workspace}/lambdas/{queryLambda}/tags/{tag}

Arguments

workspacerequiredstring(in path)
name of the workspace
queryLambdarequiredstring(in path)
name of the Query Lambda
tagrequiredstring(in path)
name of the tag

Example Request

Example Response

curl --request DELETE \
    --url https://api.rs2.usw2.rockset.com/v1/orgs/self/ws/commons/lambdas/queryLambda/tags/tag \
    -H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'

Delete Query Lambda Version

Delete a Query Lambda version.

DELETE /v1/orgs/self/ws/{workspace}/lambdas/{queryLambda}/version/{version}

Arguments

workspacerequiredstring(in path)
name of the workspace
queryLambdarequiredstring(in path)
name of the Query Lambda
versionrequiredstring(in path)
version

Example Request

Example Response

curl --request DELETE \
    --url https://api.rs2.usw2.rockset.com/v1/orgs/self/ws/commons/lambdas/queryLambda/version/version \
    -H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'

Execute Query Lambda

Execute a particular version of a Query Lambda.

POST /v1/orgs/self/ws/{workspace}/lambdas/{queryLambda}/versions/{version}

Arguments

workspacerequiredstring(in path)
name of the workspace
queryLambdarequiredstring(in path)
name of the Query Lambda
versionrequiredstring(in path)
version
parametersoptionalarray
list of named parameters
Show child attributes
default_row_limitoptionalinteger
Row limit to use if no limit specified in the SQL query text
generate_warningsoptionalboolean
Whether to generate warnings

Example Request

Example Response

curl --request POST \
    --url https://api.rs2.usw2.rockset.com/v1/orgs/self/ws/commons/lambdas/queryLambda/versions/version \
    -H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT' \
  -H 'Content-Type: application/json' \
    -d '{
    "parameters": [
      {
        "name": "_id",
        "type": "string",
        "value": "85beb391"
      }
    ]
  }'

Execute Query Lambda By Tag

Execute the Query Lambda version associated with a given tag.

POST /v1/orgs/self/ws/{workspace}/lambdas/{queryLambda}/tags/{tag}

Arguments

workspacerequiredstring(in path)
name of the workspace
queryLambdarequiredstring(in path)
name of the Query Lambda
tagrequiredstring(in path)
tag
parametersoptionalarray
list of named parameters
Show child attributes
default_row_limitoptionalinteger
Row limit to use if no limit specified in the SQL query text
generate_warningsoptionalboolean
Whether to generate warnings

Example Request

Example Response

curl --request POST \
    --url https://api.rs2.usw2.rockset.com/v1/orgs/self/ws/commons/lambdas/queryLambda/tags/tag \
    -H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT' \
  -H 'Content-Type: application/json' \
    -d '{
    "parameters": [
      {
        "name": "_id",
        "type": "string",
        "value": "85beb391"
      }
    ]
  }'

Get Query Lambda Tag

Get the Query Lambda version associated with a given tag.

GET /v1/orgs/self/ws/{workspace}/lambdas/{queryLambda}/tags/{tag}

Arguments

workspacerequiredstring(in path)
name of the workspace
queryLambdarequiredstring(in path)
name of the Query Lambda
tagrequiredstring(in path)
name of the tag

Example Request

Example Response

curl --request GET \
    --url https://api.rs2.usw2.rockset.com/v1/orgs/self/ws/commons/lambdas/queryLambda/tags/tag \
    -H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'

Get Query Lambda Version

Get details for a specified version of a Query Lambda.

GET /v1/orgs/self/ws/{workspace}/lambdas/{queryLambda}/versions/{version}

Arguments

workspacerequiredstring(in path)
name of the workspace
queryLambdarequiredstring(in path)
name of the Query Lambda
versionrequiredstring(in path)
version

Example Request

Example Response

curl --request GET \
    --url https://api.rs2.usw2.rockset.com/v1/orgs/self/ws/commons/lambdas/queryLambda/versions/version \
    -H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'

List All Query Lambda Tags

List all distinct Query Lambda tags in an organization.

GET /v1/orgs/self/lambdas/tags

Arguments

No arguments.

Example Request

Example Response

curl --request GET \
    --url https://api.rs2.usw2.rockset.com/v1/orgs/self/lambdas/tags \
    -H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'

List Query Lambda Tag Versions

List all Query Lambda versions associated with a given tag.

GET /v1/orgs/self/lambdas/tags/{tag}

Arguments

tagrequiredstring(in path)
name of the tag

Example Request

Example Response

curl --request GET \
    --url https://api.rs2.usw2.rockset.com/v1/orgs/self/lambdas/tags/tag \
    -H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'

List Query Lambda Tags

List all tags associated with a Query Lambda

GET /v1/orgs/self/ws/{workspace}/lambdas/{queryLambda}/tags

Arguments

workspacerequiredstring(in path)
name of the workspace
queryLambdarequiredstring(in path)
name of the Query Lambda

Example Request

Example Response

curl --request GET \
    --url https://api.rs2.usw2.rockset.com/v1/orgs/self/ws/commons/lambdas/queryLambda/tags \
    -H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'

List Query Lambda Versions

List all versions of a Query Lambda.

GET /v1/orgs/self/ws/{workspace}/lambdas/{queryLambda}/versions

Arguments

workspacerequiredstring(in path)
name of the workspace
queryLambdarequiredstring(in path)
name of the Query Lambda

Example Request

Example Response

curl --request GET \
    --url https://api.rs2.usw2.rockset.com/v1/orgs/self/ws/commons/lambdas/queryLambda/versions \
    -H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'

List Query Lambdas

List all Query Lambdas in an organization.

GET /v1/orgs/self/lambdas

Arguments

No arguments.

Example Request

Example Response

curl --request GET \
    --url https://api.rs2.usw2.rockset.com/v1/orgs/self/lambdas \
    -H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'

List Query Lambdas in Workspace

List all Query Lambdas under given workspace.

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

Arguments

workspacerequiredstring(in path)
name of the workspace

Example Request

Example Response

curl --request GET \
    --url https://api.rs2.usw2.rockset.com/v1/orgs/self/ws/commons/lambdas \
    -H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'

Update Query Lambda

Create a new version of a Query Lambda in given workspace.

POST /v1/orgs/self/ws/{workspace}/lambdas/{queryLambda}/versions

Arguments

workspacerequiredstring(in path)
name of the workspace
queryLambdarequiredstring(in path)
name of the Query Lambda
descriptionoptionalstring
optional description
sqloptionalobject
Query Lambda SQL query
Show child attributes
createoptionalboolean

Example Request

Example Response

curl --request POST \
    --url https://api.rs2.usw2.rockset.com/v1/orgs/self/ws/commons/lambdas/queryLambda/versions \
    -H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT' \
  -H 'Content-Type: application/json' \
    -d '{
    "description": "production version foo",
    "sql": {
      "query": "SELECT '\''Foo'\''",
      "default_parameters": [
        {
          "name": "_id",
          "type": "string",
          "value": "85beb391"
        }
      ]
    }
  }'

Users

User Type

Attributes

created_atoptionalstring

ISO-8601 date

emailoptionalstring

user email

first_nameoptionalstring

user first name

last_nameoptionalstring

user last name

rolesoptionalarray

List of roles for a given user

stateoptionalstring

state of user - NEW / ACTIVE

orgoptionalstring

invite_stateoptionalstring

orgsoptionalarray

org_membershipsoptionalarray

Example object

{
  "created_at": "2001-08-28T00:23:41Z",
  "email": "hello@rockset.com",
  "first_name": "John",
  "last_name": "Doe",
  "roles": "[\"admin\", \"member\", \"read-only\"]",
  "state": "ACTIVE",
  "orgs": [
    {
      "id": "rockset",
      "created_at": "2001-08-28T00:23:41Z",
      "display_name": "Rockset, Inc",
      "company_name": "Rockset, Inc",
      "external_id": "<hash>",
      "state": "TRIAL",
      "clusters": [
        {
          "id": "asdf98-as9df8adf-adsf9asfd",
          "cluster_type": "PRIVATE",
          "aws_region": "us-west-2",
          "domain": "rockset",
          "top_level_domain": ".com",
          "apiserver_url": "api.rockset.us-west-2.rockset.com"
        }
      ]
    }
  ],
  "org_memberships": [
    {
      "organization": {
        "id": "rockset",
        "created_at": "2001-08-28T00:23:41Z",
        "display_name": "Rockset, Inc",
        "company_name": "Rockset, Inc",
        "external_id": "<hash>",
        "state": "TRIAL",
        "clusters": [
          {
            "id": "asdf98-as9df8adf-adsf9asfd",
            "cluster_type": "PRIVATE",
            "aws_region": "us-west-2",
            "domain": "rockset",
            "top_level_domain": ".com",
            "apiserver_url": "api.rockset.us-west-2.rockset.com"
          }
        ]
      },
      "roles": [
        null
      ],
      "expires_at": "2001-08-29T00:23:41Z",
      "created_at": "2001-08-28T00:23:41Z"
    }
  ]
}

Create User

Create a new user for an organization.

POST /v1/orgs/self/users

Arguments

emailrequiredstring
user email, must be unique
rolesrequiredarray
List of roles for a given user

Example Request

Example Response

curl --request POST \
    --url https://api.rs2.usw2.rockset.com/v1/orgs/self/users \
    -H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT' \
  -H 'Content-Type: application/json' \
    -d '{
    "email": "hello@rockset.com",
    "roles": "[\"admin\", \"member\", \"read-only\"]"
  }'

Delete User

Delete a user from an organization.

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

Arguments

userrequiredstring(in path)
user email

Example Request

Example Response

curl --request DELETE \
    --url https://api.rs2.usw2.rockset.com/v1/orgs/self/users/thebestuser \
    -H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'

Get Current User

Retrieve currently authenticated user.

GET /v1/orgs/self/users/self

Arguments

No arguments.

Example Request

Example Response

curl --request GET \
    --url https://api.rs2.usw2.rockset.com/v1/orgs/self/users/self \
    -H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'

List Users

Retrieve all users for an organization.

GET /v1/orgs/self/users

Arguments

No arguments.

Example Request

Example Response

curl --request GET \
    --url https://api.rs2.usw2.rockset.com/v1/orgs/self/users \
    -H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'

Virtual Instances

Get Virtual Instance

Get details about a virtual instance.

GET /v1/orgs/self/virtualinstances/{virtualInstanceId}

Arguments

virtualInstanceIdrequiredstring(in path)
uuid of the virtual instance

Example Request

Example Response

curl --request GET \
    --url https://api.rs2.usw2.rockset.com/v1/orgs/self/virtualinstances/virtualInstanceId \
    -H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'

List Virtual Instances

Retrieve all virtual instances in an organization.

GET /v1/orgs/self/virtualinstances

Arguments

No arguments.

Example Request

Example Response

curl --request GET \
    --url https://api.rs2.usw2.rockset.com/v1/orgs/self/virtualinstances \
    -H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'

Update Virtual Instance

Update the properties of a virtual instance.

POST /v1/orgs/self/virtualinstances/{virtualInstanceId}

Arguments

virtualInstanceIdrequiredstring(in path)
uuid of the virtual instance
new_sizeoptionalstring
requested virtual instance size
new_typeoptionalstring
monitoring_enabledoptionalboolean

Example Request

Example Response

curl --request POST \
    --url https://api.rs2.usw2.rockset.com/v1/orgs/self/virtualinstances/virtualInstanceId \
    -H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT' \
  -H 'Content-Type: application/json' \
    -d '{
    "new_size": "LARGE"
  }'

Workspaces

Workspace Type

Workspaces are organizational containers for collections.

Attributes

created_atoptionalstring

ISO-8601 date of when workspace was created

created_byoptionalstring

email of user who created the workspace

nameoptionalstring

descriptive label and unique identifier

descriptionoptionalstring

longer explanation for the workspace

collection_countoptionalinteger

number of collections that are immediate children of workspace

Example object

{
  "created_at": "2001-08-28T00:23:41Z",
  "created_by": "hello@rockset.com",
  "name": "event_logs",
  "description": "Datasets of system logs for the ops team.",
  "collection_count": 3
}

Create Workspace

Create a new workspace.

POST /v1/orgs/self/ws

Arguments

namerequiredstring
descriptive label and unique identifier
descriptionoptionalstring
longer explanation for the workspace

Example Request

Example Response

curl --request POST \
    --url https://api.rs2.usw2.rockset.com/v1/orgs/self/ws \
    -H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT' \
  -H 'Content-Type: application/json' \
    -d '{
    "name": "event_logs",
    "description": "Datasets of system logs for the ops team."
  }'

Delete Workspace

Remove a workspace.

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

Arguments

workspacerequiredstring(in path)
name of the workspace

Example Request

Example Response

curl --request DELETE \
    --url https://api.rs2.usw2.rockset.com/v1/orgs/self/ws/commons \
    -H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'

Get Workspace

Get information about a single workspace.

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

Arguments

workspacerequiredstring(in path)
name of the workspace

Example Request

Example Response

curl --request GET \
    --url https://api.rs2.usw2.rockset.com/v1/orgs/self/ws/commons \
    -H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'

List Workspaces

List all workspaces in an organization.

GET /v1/orgs/self/ws

Arguments

No arguments.

Example Request

Example Response

curl --request GET \
    --url https://api.rs2.usw2.rockset.com/v1/orgs/self/ws \
    -H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'

List Workspaces in Workspace

List workspaces under given workspace.

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

Arguments

workspacerequiredstring(in path)
name of the workspace

Example Request

Example Response

curl --request GET \
    --url https://api.rs2.usw2.rockset.com/v1/orgs/self/ws/commons/ws \
    -H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'

Rockset API Reference

Authentication

#Queries

#QueryResponse Type

Attributes

query_idoptionalstring

collectionsoptionalarray

resultsoptionalarray

statsoptional

warningsoptionalarray

query_errorsoptionalarray

column_fieldsoptionalarray

#Query

Arguments

sqloptionalobject

#Validate Query

Arguments

sqloptionalobject

parametersoptionalboolean

#Documents

#Add Documents

Arguments

workspacerequiredstring(in path)

collectionrequiredstring(in path)

datarequiredarray

#Delete Documents

Arguments

workspacerequiredstring(in path)

collectionrequiredstring(in path)

datarequiredarray

#Patch Documents

Arguments

workspacerequiredstring(in path)

collectionrequiredstring(in path)

datarequiredarray

#API Keys

#Create API Key

Arguments

namerequiredstring

#Create API Key (any user)

Arguments

namerequiredstring

userrequiredstring(in path)

#Delete API Key

Arguments

namerequiredstring(in path)

#Delete API Key (any user)

Arguments

namerequiredstring(in path)

userrequiredstring(in path)

#List API Keys

Arguments

#List API Keys (any user)

Arguments

userrequiredstring(in path)

#Aliases

#Create Alias

Arguments

workspacerequiredstring(in path)

namerequiredstring

descriptionoptionalstring

collectionsrequiredarray

#Delete Alias

Arguments

workspacerequiredstring(in path)

aliasrequiredstring(in path)

#Get Alias

Arguments

workspacerequiredstring(in path)

aliasrequiredstring(in path)

#Get Query Lambdas with Alias

Arguments

workspacerequiredstring(in path)

aliasrequiredstring(in path)

#List Aliases

Arguments

#List Aliases for Workspace

Arguments

workspacerequiredstring(in path)

#Update Alias

Queries

QueryResponse Type

Query

Validate Query

Documents

Add Documents

Delete Documents

Patch Documents

API Keys

Create API Key

Create API Key (any user)

Delete API Key

Delete API Key (any user)

List API Keys

List API Keys (any user)

Aliases

Create Alias

Delete Alias

Get Alias

Get Query Lambdas with Alias

List Aliases

List Aliases for Workspace

Update Alias

Collections

Collection Type

Create Collection

Delete Collection

Get Aliases for Collection

Get Collection

Get Query Lambdas for Collection

List Collections

List Collections for Workspace

IP Allowlist

Create IP Allowlist Network Policy

Delete IP Allowlist Network Policy

Get IP Allowlist Network Policy

List IP Allowlist Entries