Rockset API Reference
Introduction
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 servers are as follows. You can double check the region of your org by looking at the top-left region dropdown in the Rockset Console.
Region | Base URL |
---|---|
Oregon (us-west-2) | https://api.usw2a1.rockset.com |
N. Virginia (us-east-1) | https://api.use1a1.rockset.com |
Frankfurt (eu-central-1) | https://api.euc1a1.rockset.com |
All endpoints are accessible through 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. You can find the OpenAPI version of these endpoints here.
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
Cancel Query
Attempts to cancel an actively-running query.
DELETE /v1/orgs/self/queries/{queryId}
Arguments
queryIdrequiredstring(in path)
Response
dataoptionalobject
Show child attributes
curl --request DELETE \
--url https://api.usw2a1.rockset.com/v1/orgs/self/queries/queryId \
-H 'Authorization: ApiKey _insert_your_apikey_here_'
Execute SQL Query
Make a SQL query to Rockset.
POST /v1/orgs/self/queries
Arguments
sqlrequiredobject
Main query request body.
Show child attributes
async_optionsoptionalobject
Options for configuring Asynchronous Query Mode (beta).
Show child attributes
Response
query_idoptionalstring
Unique ID for this query.
collectionsoptionalstring array
List of collections referenced in the query.
resultsoptionalobject array
Results from the query.
statsoptionalobject
Meta information about the query including execution latencies.
Show child attributes
warningsoptionalstring array
Warnings generated by the query. Only populated if
generate_warnings
is specified in the query request.query_lambda_pathoptionalstring
The full path of the executed query lambda. Includes version information.
query_errorsoptionalobject array
Errors encountered while executing the query.
Show child attributes
column_fieldsoptionalobject array
Meta information about each column in the result set. Not populated in
SELECT *
queries.Show child attributes
results_total_doc_countoptionalinteger
Number of results generated by the query.
paginationoptionalobject
Pagination information. Only populated if
paginate
is specified in the query request.Show child attributes
last_offsetoptionalstring
If this was a write query, this is the log offset the query was written to.
curl --request POST \
--url https://api.usw2a1.rockset.com/v1/orgs/self/queries \
-H 'Authorization: ApiKey _insert_your_apikey_here_' \
-H 'Content-Type: application/json' \
-d '{
"sql": {
"query": "SELECT * FROM foo where _id = :_id",
"generate_warnings": "true",
"parameters": [
{
"name": "_id",
"type": "string",
"value": "85beb391"
}
],
"default_row_limit": "123",
"initial_paginate_response_doc_count": "123"
},
"async_options": {
"client_timeout_ms": "123",
"timeout_ms": "123",
"max_initial_results": "123"
}
}'
List Queries
Lists actively queued and running queries.
GET /v1/orgs/self/queries
Arguments
No arguments.
Response
dataoptionalobject array
Show child attributes
curl --request GET \
--url https://api.usw2a1.rockset.com/v1/orgs/self/queries \
-H 'Authorization: ApiKey _insert_your_apikey_here_'
Retrieve Query
Returns information about a query.
GET /v1/orgs/self/queries/{queryId}
Arguments
queryIdrequiredstring(in path)
Response
dataoptionalobject
Show child attributes
curl --request GET \
--url https://api.usw2a1.rockset.com/v1/orgs/self/queries/queryId \
-H 'Authorization: ApiKey _insert_your_apikey_here_'
Retrieve Query Results Page
Returns a page of query results.
GET /v1/orgs/self/queries/{queryId}/pages
Arguments
queryIdrequiredstring(in path)
cursoroptionalstring(query parameter)
Cursor to current page. If unset, will default to the first page.
docsoptionalinteger(query parameter)
Number of documents to fetch.
offsetoptionalinteger(query parameter)
Offset from the cursor of the first document to be returned
Response
resultsoptionalobject array
List of documents returned by the query.
results_total_doc_countoptionalinteger
Total documents returned by the query.
paginationoptionalobject
Pagination metadata.
Show child attributes
curl --request GET \
--url https://api.usw2a1.rockset.com/v1/orgs/self/queries/queryId/pages?cursor=deUIr8DsHgTw7c00&docs=100&offset=offset& \
-H 'Authorization: ApiKey _insert_your_apikey_here_'
Validate Query
Validate a SQL query with Rockset's parser and planner.
POST /v1/orgs/self/queries/validations
Arguments
sqlrequiredobject
Main query request body.
Show child attributes
async_optionsoptionalobject
Options for configuring Asynchronous Query Mode (beta).
Show child attributes
Response
collectionsrequiredstring array
List of collections specified in query.
parametersrequiredstring array
List of parameters specified in query.
curl --request POST \
--url https://api.usw2a1.rockset.com/v1/orgs/self/queries/validations \
-H 'Authorization: ApiKey _insert_your_apikey_here_' \
-H 'Content-Type: application/json' \
-d '{
"sql": {
"query": "SELECT * FROM foo where _id = :_id",
"generate_warnings": "true",
"parameters": [
{
"name": "_id",
"type": "string",
"value": "85beb391"
}
],
"default_row_limit": "123",
"initial_paginate_response_doc_count": "123"
},
"async_options": {
"client_timeout_ms": "123",
"timeout_ms": "123",
"max_initial_results": "123"
}
}'
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.
datarequiredobject array
Array of documents to be added to the collection.
Response
dataoptionalobject array
Information about the added documents.
Show child attributes
curl --request POST \
--url https://api.usw2a1.rockset.com/v1/orgs/self/ws/commons/collections/customers/docs \
-H 'Authorization: ApiKey _insert_your_apikey_here_' \
-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.
datarequiredobject array
Array of IDs of documents to be deleted.
Show child attributes
Response
dataoptionalobject array
Information about deleted documents.
Show child attributes
curl --request DELETE \
--url https://api.usw2a1.rockset.com/v1/orgs/self/ws/commons/collections/customers/docs \
-H 'Authorization: ApiKey _insert_your_apikey_here_' \
-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.
datarequiredobject array
List of patches to be applied.
Show child attributes
Response
datarequiredobject array
Show child attributes
curl --request PATCH \
--url https://api.usw2a1.rockset.com/v1/orgs/self/ws/commons/collections/customers/docs \
-H 'Authorization: ApiKey _insert_your_apikey_here_' \
-H 'Content-Type: application/json' \
-d '{
"data": [
{
"_id": "ca2d6832-1bfd-f88f-0620-d2aa27a5d86c",
"patch": [
{
"op": "ADD",
"path": "/foo/bar",
"value": {},
"from": "foo"
}
]
}
]
}'
API Keys
Create API Key
Create a new API key for the authenticated user.
POST /v1/orgs/self/users/self/apikeys
Arguments
namerequiredstring
Name for this API key.
roleoptionalstring
created_byoptionalstring
Response
dataoptionalobject
The API key that was created.
Show child attributes
curl --request POST \
--url https://api.usw2a1.rockset.com/v1/orgs/self/users/self/apikeys \
-H 'Authorization: ApiKey _insert_your_apikey_here_' \
-H 'Content-Type: application/json' \
-d '{
"name": "my-app",
"role": "foo",
"created_by": "foo"
}'
Delete API Key
Delete an API key for any user in your organization.
DELETE /v1/orgs/self/users/{user}/apikeys/{name}
Arguments
namerequiredstring(in path)
Name of the API key.
userrequiredstring(in path)
Email of the API key owner. Use
self
to specify the currently authenticated user.
Response
dataoptionalobject
The API key that was deleted.
Show child attributes
curl --request DELETE \
--url https://api.usw2a1.rockset.com/v1/orgs/self/users/admin@me.com/apikeys/name \
-H 'Authorization: ApiKey _insert_your_apikey_here_'
List API Keys
List API key metadata for any user in your organization.
GET /v1/orgs/self/users/{user}/apikeys
Arguments
userrequiredstring(in path)
Email of the API key owner. Use
self
to specify the currently authenticated user.
Response
dataoptionalobject array
List of API key objects.
Show child attributes
curl --request GET \
--url https://api.usw2a1.rockset.com/v1/orgs/self/users/admin@me.com/apikeys \
-H 'Authorization: ApiKey _insert_your_apikey_here_'
Retrieve API Key
Retrieve a particular API key for any user in your organization.
GET /v1/orgs/self/users/{user}/apikeys/{name}
Arguments
userrequiredstring(in path)
Email of the API key owner. Use
self
to specify the currently authenticated user.namerequiredstring(in path)
Name of the API key.
revealoptionalboolean(query parameter)
Reveal full key.
Response
dataoptionalobject
The requested API key object.
Show child attributes
curl --request GET \
--url https://api.usw2a1.rockset.com/v1/orgs/self/users/admin@me.com/apikeys/name?reveal=reveal& \
-H 'Authorization: ApiKey _insert_your_apikey_here_'
Update API Key State
Update the state of an API key for any user in your organization.
POST /v1/orgs/self/users/{user}/apikeys/{name}
Arguments
namerequiredstring(in path)
Name of the API key.
userrequiredstring(in path)
Email of the API key owner. Use
self
to specify the currently authenticated user.stateoptionalstring
State that the api key should be set to. Possible values:
ACTIVE
,SUSPENDED
.
Response
dataoptionalobject
The API key that was updated.
Show child attributes
curl --request POST \
--url https://api.usw2a1.rockset.com/v1/orgs/self/users/admin@me.com/apikeys/name \
-H 'Authorization: ApiKey _insert_your_apikey_here_' \
-H 'Content-Type: application/json' \
-d '{
"state": "ACTIVE"
}'
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.
collectionsrequiredstring array
List of fully qualified collection names referenced by alias.
descriptionoptionalstring
Optional description.
Response
dataoptionalobject
Alias that was created.
Show child attributes
curl --request POST \
--url https://api.usw2a1.rockset.com/v1/orgs/self/ws/commons/aliases \
-H 'Authorization: ApiKey _insert_your_apikey_here_' \
-H 'Content-Type: application/json' \
-d '{
"name": "aliasName",
"description": "version alias",
"collections": [
"foo"
]
}'
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
Response
dataoptionalobject
Alias that was deleted.
Show child attributes
curl --request DELETE \
--url https://api.usw2a1.rockset.com/v1/orgs/self/ws/commons/aliases/alias \
-H 'Authorization: ApiKey _insert_your_apikey_here_'
List Aliases
Retrieve all aliases in an organization
GET /v1/orgs/self/aliases
Arguments
No arguments.
Response
dataoptionalobject array
List of all aliases.
Show child attributes
curl --request GET \
--url https://api.usw2a1.rockset.com/v1/orgs/self/aliases \
-H 'Authorization: ApiKey _insert_your_apikey_here_'
List Aliases in Workspace
Retrieve all aliases in a workspace.
GET /v1/orgs/self/ws/{workspace}/aliases
Arguments
workspacerequiredstring(in path)
name of the workspace
Response
dataoptionalobject array
List of all aliases.
Show child attributes
curl --request GET \
--url https://api.usw2a1.rockset.com/v1/orgs/self/ws/commons/aliases \
-H 'Authorization: ApiKey _insert_your_apikey_here_'
Retrieve Alias
Get details about an alias
GET /v1/orgs/self/ws/{workspace}/aliases/{alias}
Arguments
workspacerequiredstring(in path)
name of the workspace
aliasrequiredstring(in path)
name of the alias
Response
dataoptionalobject
Alias that was requested.
Show child attributes
curl --request GET \
--url https://api.usw2a1.rockset.com/v1/orgs/self/ws/commons/aliases/alias \
-H 'Authorization: ApiKey _insert_your_apikey_here_'
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
collectionsrequiredstring array
List of fully qualified collection names referenced by alias.
descriptionoptionalstring
Optional description.
Response
dataoptionalobject
Alias that was requested.
Show child attributes
curl --request POST \
--url https://api.usw2a1.rockset.com/v1/orgs/self/ws/commons/aliases/alias \
-H 'Authorization: ApiKey _insert_your_apikey_here_' \
-H 'Content-Type: application/json' \
-d '{
"description": "version alias",
"collections": [
"foo"
]
}'
Collections
Create Collection
Create new collection in a workspace.
POST /v1/orgs/self/ws/{workspace}/collections
Arguments
workspacerequiredstring(in path)
name of the workspace
nameoptionalstring
Unique identifier for collection, can contain alphanumeric or dash characters.
descriptionoptionalstring
Text describing the collection.
sourcesoptionalobject array
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.
field_mapping_queryoptionalobject
Mapping of fields for a collection.
Show child attributes
storage_compression_typeoptionalstring
RocksDB storage compression type. Possible values:
LZ4
,ZSTD
.event_time_infooptionalobject
Deprecated. Configuration for event data. Use an _event_time mapping in
field_mapping_query
instead.Show child attributes
field_mappingsoptionalobject array
Deprecated. List of mappings. Use field_mapping_query instead.
Show child attributes
clustering_keyoptionalobject array
Deprecated. List of clustering fields. Use CLUSTER BY clause in
field_mapping_query
instead.Show child attributes
Response
dataoptionalobject
Collection that was created.
Show child attributes
curl --request POST \
--url https://api.usw2a1.rockset.com/v1/orgs/self/ws/commons/collections \
-H 'Authorization: ApiKey _insert_your_apikey_here_' \
-H 'Content-Type: application/json' \
-d '{
"name": "global-transactions",
"description": "transactions from stores worldwide",
"sources": [
{
"integration_name": "aws-integration",
"s3": {
"prefix": "prefix/to/keys",
"pattern": "prefix/to/**/keys/*.format",
"region": "us-west-2",
"bucket": "s3://customer-account-info"
}
}
],
"retention_secs": 1000000,
"field_mapping_query": {
"sql": "sql"
},
"storage_compression_type": "foo"
}'
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
Response
dataoptionalobject
Collection that was deleted.
Show child attributes
curl --request DELETE \
--url https://api.usw2a1.rockset.com/v1/orgs/self/ws/commons/collections/customers \
-H 'Authorization: ApiKey _insert_your_apikey_here_'
List Collections
Retrieve all collections in an organization.
GET /v1/orgs/self/collections
Arguments
No arguments.
Response
dataoptionalobject array
List of all collections.
Show child attributes
curl --request GET \
--url https://api.usw2a1.rockset.com/v1/orgs/self/collections \
-H 'Authorization: ApiKey _insert_your_apikey_here_'
List Collections in Workspace
Retrieve all collections in a workspace.
GET /v1/orgs/self/ws/{workspace}/collections
Arguments
workspacerequiredstring(in path)
name of the workspace
Response
dataoptionalobject array
List of all collections.
Show child attributes
curl --request GET \
--url https://api.usw2a1.rockset.com/v1/orgs/self/ws/commons/collections \
-H 'Authorization: ApiKey _insert_your_apikey_here_'
Retrieve 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
Response
dataoptionalobject
Collection that was requested.
Show child attributes
curl --request GET \
--url https://api.usw2a1.rockset.com/v1/orgs/self/ws/commons/collections/customers \
-H 'Authorization: ApiKey _insert_your_apikey_here_'
Custom Roles
Create a Role
Create a role for your organization.
POST /v1/orgs/self/roles
Arguments
role_nameoptionalstring
Unique identifier for the role.
descriptionoptionalstring
Description for the role.
privilegesoptionalobject array
List of privileges that will be associated with the role.
Show child attributes
Response
dataoptionalobject
Show child attributes
curl --request POST \
--url https://api.usw2a1.rockset.com/v1/orgs/self/roles \
-H 'Authorization: ApiKey _insert_your_apikey_here_' \
-H 'Content-Type: application/json' \
-d '{
"role_name": "read_write",
"description": "Role with read and write privileges to all collections.",
"privileges": [
{
"action": "CREATE_COLLECTION_WS",
"resource_name": "commons",
"cluster": "*ALL*"
}
]
}'
Delete a Role
Delete a role for your organization.
DELETE /v1/orgs/self/roles/{roleName}
Arguments
roleNamerequiredstring(in path)
Response
dataoptionalobject
Show child attributes
curl --request DELETE \
--url https://api.usw2a1.rockset.com/v1/orgs/self/roles/roleName \
-H 'Authorization: ApiKey _insert_your_apikey_here_'
List Roles
List all roles for your organization.
GET /v1/orgs/self/roles
Arguments
No arguments.
Response
dataoptionalobject array
List of all roles.
Show child attributes
curl --request GET \
--url https://api.usw2a1.rockset.com/v1/orgs/self/roles \
-H 'Authorization: ApiKey _insert_your_apikey_here_'
Retrieve role
Retrieve a role by name for your organization.
GET /v1/orgs/self/roles/{roleName}
Arguments
roleNamerequiredstring(in path)
Response
dataoptionalobject
Show child attributes
curl --request GET \
--url https://api.usw2a1.rockset.com/v1/orgs/self/roles/roleName \
-H 'Authorization: ApiKey _insert_your_apikey_here_'
Update a Role
Update a role for your organization.
POST /v1/orgs/self/roles/{roleName}
Arguments
roleNamerequiredstring(in path)
descriptionoptionalstring
Description for the role.
privilegesoptionalobject array
List of privileges that will be associated with the role.
Show child attributes
Response
dataoptionalobject
Show child attributes
curl --request POST \
--url https://api.usw2a1.rockset.com/v1/orgs/self/roles/roleName \
-H 'Authorization: ApiKey _insert_your_apikey_here_' \
-H 'Content-Type: application/json' \
-d '{
"description": "Role with read and write privileges to all collections.",
"privileges": [
{
"action": "CREATE_COLLECTION_WS",
"resource_name": "commons",
"cluster": "*ALL*"
}
]
}'
Integrations
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
gcsoptionalobject
GCS details.
Show child attributes
azure_blob_storageoptionalobject
Azure Blob Storage details.
Show child attributes
azure_service_busoptionalobject
Azure Service Bus details.
Show child attributes
azure_event_hubsoptionalobject
Azure Event Hubs details.
Show child attributes
kafkaoptionalobject
Show child attributes
mongodboptionalobject
MongoDb details.
Show child attributes
snowflakeoptionalobject
Show child attributes
Response
dataoptionalobject
Integration object that was created.
Show child attributes
curl --request POST \
--url https://api.usw2a1.rockset.com/v1/orgs/self/integrations \
-H 'Authorization: ApiKey _insert_your_apikey_here_' \
-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",
"aws_external_id": "external id of aws"
}
},
"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",
"aws_external_id": "external id of aws"
}
},
"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",
"aws_external_id": "external id of aws"
},
"s3_export_bucket_name": "foo"
},
"gcs": {
"gcp_service_account": {
"service_account_key_file_json": "foo"
}
},
"azure_blob_storage": {
"connection_string": "BlobEndpoint=https://<NamespaceName>.blob.core.windows.net;\nSharedAccessSignature=<KeyValue>"
},
"azure_service_bus": {
"connection_string": "Endpoint=sb://<NamespaceName>.servicebus.windows.net/;SharedAccessKeyName=<KeyName>;SharedAccessKey=<KeyValue>"
},
"azure_event_hubs": {
"connection_string": "Endpoint=sb://<NamespaceName>.servicebus.windows.net/;SharedAccessKeyName=<KeyName>;SharedAccessKey=<KeyValue>"
},
"kafka": {
"kafka_topic_names": [
"foo"
],
"kafka_data_format": "JSON",
"connection_string": "foo",
"aws_role": {
"aws_role_arn": "arn:aws:iam::2378964092:role/rockset-role",
"aws_external_id": "external id of aws"
},
"use_v3": "true",
"bootstrap_servers": "localhost:9092",
"security_config": {
"api_key": "foo",
"secret": "foo"
},
"schema_registry_config": {
"url": "foo",
"key": "foo",
"secret": "foo"
}
},
"mongodb": {
"connection_uri": "mongodb+srv://<username>:<password>@server.example.com/"
},
"snowflake": {
"snowflake_url": "acme-marketing-test-account.snowflakecomputing.com",
"username": "foo",
"password": "foo",
"user_role": "foo",
"aws_role": {
"aws_role_arn": "arn:aws:iam::2378964092:role/rockset-role",
"aws_external_id": "external id of aws"
},
"aws_access_key": {
"aws_access_key_id": "AKIAIOSFODNN7EXAMPLE",
"aws_secret_access_key": "wJal...."
},
"default_warehouse": "foo",
"s3_export_path": "s3://bucket/prefix"
}
}'
Delete Integration
Remove an integration.
DELETE /v1/orgs/self/integrations/{integration}
Arguments
integrationrequiredstring(in path)
name of the integration
Response
dataoptionalobject
Integration object that was deleted.
Show child attributes
curl --request DELETE \
--url https://api.usw2a1.rockset.com/v1/orgs/self/integrations/my-aws-creds \
-H 'Authorization: ApiKey _insert_your_apikey_here_'
List Integrations
List all integrations in an organization.
GET /v1/orgs/self/integrations
Arguments
No arguments.
Response
dataoptionalobject array
List of integration objects.
Show child attributes
curl --request GET \
--url https://api.usw2a1.rockset.com/v1/orgs/self/integrations \
-H 'Authorization: ApiKey _insert_your_apikey_here_'
Retrieve Integration
Retrieve information about a single integration.
GET /v1/orgs/self/integrations/{integration}
Arguments
integrationrequiredstring(in path)
name of the integration
Response
dataoptionalobject
Integration object.
Show child attributes
curl --request GET \
--url https://api.usw2a1.rockset.com/v1/orgs/self/integrations/my-aws-creds \
-H 'Authorization: ApiKey _insert_your_apikey_here_'
Query Lambdas
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.
sqlrequiredobject
Query Lambda SQL query.
Show child attributes
descriptionoptionalstring
Optional description.
is_publicoptionalboolean
Response
dataoptionalobject
Query Lambda version details.
Show child attributes
curl --request POST \
--url https://api.usw2a1.rockset.com/v1/orgs/self/ws/commons/lambdas \
-H 'Authorization: ApiKey _insert_your_apikey_here_' \
-H 'Content-Type: application/json' \
-d '{
"name": "myQueryLambda",
"description": "production version foo",
"sql": {
"query": "SELECT '\''Foo'\''",
"default_parameters": [
{
"name": "_id",
"type": "string",
"value": "85beb391"
}
]
},
"is_public": "true"
}'
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.
Response
dataoptionalobject
Updated Query Lambda tag.
Show child attributes
curl --request POST \
--url https://api.usw2a1.rockset.com/v1/orgs/self/ws/commons/lambdas/queryLambda/tags \
-H 'Authorization: ApiKey _insert_your_apikey_here_' \
-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
Response
dataoptionalobject
Query Lambda details.
Show child attributes
curl --request DELETE \
--url https://api.usw2a1.rockset.com/v1/orgs/self/ws/commons/lambdas/queryLambda \
-H 'Authorization: ApiKey _insert_your_apikey_here_'
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
Response
dataoptionalobject
Updated Query Lambda tag.
Show child attributes
curl --request DELETE \
--url https://api.usw2a1.rockset.com/v1/orgs/self/ws/commons/lambdas/queryLambda/tags/tag \
-H 'Authorization: ApiKey _insert_your_apikey_here_'
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
Response
dataoptionalobject
Query Lambda version details.
Show child attributes
curl --request DELETE \
--url https://api.usw2a1.rockset.com/v1/orgs/self/ws/commons/lambdas/queryLambda/version/version \
-H 'Authorization: ApiKey _insert_your_apikey_here_'
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
parametersoptionalobject array
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.
paginateoptionalboolean
Flag to paginate and store the results of this query for later / sequential retrieval.
initial_paginate_response_doc_countoptionalinteger
Number of documents to return in addition to paginating for this query call. Only relevant if
paginate
flag is also set.async_optionsoptionalobject
Options for configuring Asynchronous Query Mode (beta).
Show child attributes
virtual_instance_idoptionalstring
Virtual instance on which to run the query.
Response
query_idoptionalstring
Unique ID for this query.
collectionsoptionalstring array
List of collections referenced in the query.
resultsoptionalobject array
Results from the query.
statsoptionalobject
Meta information about the query including execution latencies.
Show child attributes
warningsoptionalstring array
Warnings generated by the query. Only populated if
generate_warnings
is specified in the query request.query_lambda_pathoptionalstring
The full path of the executed query lambda. Includes version information.
query_errorsoptionalobject array
Errors encountered while executing the query.
Show child attributes
column_fieldsoptionalobject array
Meta information about each column in the result set. Not populated in
SELECT *
queries.Show child attributes
results_total_doc_countoptionalinteger
Number of results generated by the query.
paginationoptionalobject
Pagination information. Only populated if
paginate
is specified in the query request.Show child attributes
last_offsetoptionalstring
If this was a write query, this is the log offset the query was written to.
curl --request POST \
--url https://api.usw2a1.rockset.com/v1/orgs/self/ws/commons/lambdas/queryLambda/tags/tag \
-H 'Authorization: ApiKey _insert_your_apikey_here_' \
-H 'Content-Type: application/json' \
-d '{
"parameters": [
{
"name": "_id",
"type": "string",
"value": "85beb391"
}
],
"default_row_limit": "123",
"generate_warnings": "true",
"paginate": "true",
"initial_paginate_response_doc_count": "123",
"async_options": {
"client_timeout_ms": "123",
"timeout_ms": "123",
"max_initial_results": "123"
},
"virtual_instance_id": "foo"
}'
Execute Query Lambda By Version
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
parametersoptionalobject array
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.
paginateoptionalboolean
Flag to paginate and store the results of this query for later / sequential retrieval.
initial_paginate_response_doc_countoptionalinteger
Number of documents to return in addition to paginating for this query call. Only relevant if
paginate
flag is also set.async_optionsoptionalobject
Options for configuring Asynchronous Query Mode (beta).
Show child attributes
virtual_instance_idoptionalstring
Virtual instance on which to run the query.
Response
query_idoptionalstring
Unique ID for this query.
collectionsoptionalstring array
List of collections referenced in the query.
resultsoptionalobject array
Results from the query.
statsoptionalobject
Meta information about the query including execution latencies.
Show child attributes
warningsoptionalstring array
Warnings generated by the query. Only populated if
generate_warnings
is specified in the query request.query_lambda_pathoptionalstring
The full path of the executed query lambda. Includes version information.
query_errorsoptionalobject array
Errors encountered while executing the query.
Show child attributes
column_fieldsoptionalobject array
Meta information about each column in the result set. Not populated in
SELECT *
queries.Show child attributes
results_total_doc_countoptionalinteger
Number of results generated by the query.
paginationoptionalobject
Pagination information. Only populated if
paginate
is specified in the query request.Show child attributes
last_offsetoptionalstring
If this was a write query, this is the log offset the query was written to.
curl --request POST \
--url https://api.usw2a1.rockset.com/v1/orgs/self/ws/commons/lambdas/queryLambda/versions/version \
-H 'Authorization: ApiKey _insert_your_apikey_here_' \
-H 'Content-Type: application/json' \
-d '{
"parameters": [
{
"name": "_id",
"type": "string",
"value": "85beb391"
}
],
"default_row_limit": "123",
"generate_warnings": "true",
"paginate": "true",
"initial_paginate_response_doc_count": "123",
"async_options": {
"client_timeout_ms": "123",
"timeout_ms": "123",
"max_initial_results": "123"
},
"virtual_instance_id": "foo"
}'
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
Response
dataoptionalobject array
List of all tags associated with a Query Lambda.
Show child attributes
curl --request GET \
--url https://api.usw2a1.rockset.com/v1/orgs/self/ws/commons/lambdas/queryLambda/tags \
-H 'Authorization: ApiKey _insert_your_apikey_here_'
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
Response
dataoptionalobject array
List of all versions for a particular Query Lambda.
Show child attributes
curl --request GET \
--url https://api.usw2a1.rockset.com/v1/orgs/self/ws/commons/lambdas/queryLambda/versions \
-H 'Authorization: ApiKey _insert_your_apikey_here_'
List Query Lambdas
List all Query Lambdas in an organization.
GET /v1/orgs/self/lambdas
Arguments
No arguments.
Response
dataoptionalobject array
List of all Query Lambdas.
Show child attributes
curl --request GET \
--url https://api.usw2a1.rockset.com/v1/orgs/self/lambdas \
-H 'Authorization: ApiKey _insert_your_apikey_here_'
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
Response
dataoptionalobject array
List of all Query Lambdas.
Show child attributes
curl --request GET \
--url https://api.usw2a1.rockset.com/v1/orgs/self/ws/commons/lambdas \
-H 'Authorization: ApiKey _insert_your_apikey_here_'
Retrieve Query Lambda Tag
Retrieve 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
Response
dataoptionalobject
Updated Query Lambda tag.
Show child attributes
curl --request GET \
--url https://api.usw2a1.rockset.com/v1/orgs/self/ws/commons/lambdas/queryLambda/tags/tag \
-H 'Authorization: ApiKey _insert_your_apikey_here_'
Retrieve Query Lambda Version
Retrieve 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
Response
dataoptionalobject
Query Lambda version details.
Show child attributes
curl --request GET \
--url https://api.usw2a1.rockset.com/v1/orgs/self/ws/commons/lambdas/queryLambda/versions/version \
-H 'Authorization: ApiKey _insert_your_apikey_here_'
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
createoptionalboolean(query parameter)
Create a new Query Lambda if one does not exist already.
descriptionoptionalstring
Optional description.
sqloptionalobject
Query Lambda SQL query.
Show child attributes
is_publicoptionalboolean
Response
dataoptionalobject
Query Lambda version details.
Show child attributes
curl --request POST \
--url https://api.usw2a1.rockset.com/v1/orgs/self/ws/commons/lambdas/queryLambda/versions?create=create& \
-H 'Authorization: ApiKey _insert_your_apikey_here_' \
-H 'Content-Type: application/json' \
-d '{
"description": "production version foo",
"sql": {
"query": "SELECT '\''Foo'\''",
"default_parameters": [
{
"name": "_id",
"type": "string",
"value": "85beb391"
}
]
},
"is_public": "true"
}'
Shared Lambdas
Execute a Public Query Lambda
Execute a public query lambda (full version).
POST /v1/public/shared_lambdas/{public_access_id}
Arguments
public_access_idrequiredstring(in path)
public access ID of the query lambda
parametersoptionalobject array
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.
Response
query_idoptionalstring
Unique ID for this query.
collectionsoptionalstring array
List of collections referenced in the query.
resultsoptionalobject array
Results from the query.
statsoptionalobject
Meta information about the query including execution latencies.
Show child attributes
warningsoptionalstring array
Warnings generated by the query. Only populated if
generate_warnings
is specified in the query request.query_lambda_pathoptionalstring
The full path of the executed query lambda. Includes version information.
query_errorsoptionalobject array
Errors encountered while executing the query.
Show child attributes
column_fieldsoptionalobject array
Meta information about each column in the result set. Not populated in
SELECT *
queries.Show child attributes
results_total_doc_countoptionalinteger
Number of results generated by the query.
paginationoptionalobject
Pagination information. Only populated if
paginate
is specified in the query request.Show child attributes
last_offsetoptionalstring
If this was a write query, this is the log offset the query was written to.
curl --request POST \
--url https://api.usw2a1.rockset.com/v1/public/shared_lambdas/public_access_id \
-H 'Authorization: ApiKey _insert_your_apikey_here_' \
-H 'Content-Type: application/json' \
-d '{
"parameters": [
{
"name": "_id",
"type": "string",
"value": "85beb391"
}
],
"default_row_limit": "123",
"generate_warnings": "true"
}'
Users
Create User
Create a new user for an organization.
POST /v1/orgs/self/users
Arguments
emailrequiredstring
User email, must be unique.
rolesrequiredstring array
List of roles for a given user.
first_nameoptionalstring
User first name.
last_nameoptionalstring
User last name.
Response
dataoptionalobject
User that was created.
Show child attributes
curl --request POST \
--url https://api.usw2a1.rockset.com/v1/orgs/self/users \
-H 'Authorization: ApiKey _insert_your_apikey_here_' \
-H 'Content-Type: application/json' \
-d '{
"email": "hello@rockset.com",
"roles": [
"foo"
],
"first_name": "John",
"last_name": "Doe"
}'
Delete User
Delete a user from an organization.
DELETE /v1/orgs/self/users/{user}
Arguments
userrequiredstring(in path)
user email
Response
dataoptionalobject
User object that was deleted.
Show child attributes
curl --request DELETE \
--url https://api.usw2a1.rockset.com/v1/orgs/self/users/admin@me.com \
-H 'Authorization: ApiKey _insert_your_apikey_here_'
List Users
Retrieve all users for an organization.
GET /v1/orgs/self/users
Arguments
No arguments.
Response
dataoptionalobject array
List of users.
Show child attributes
curl --request GET \
--url https://api.usw2a1.rockset.com/v1/orgs/self/users \
-H 'Authorization: ApiKey _insert_your_apikey_here_'
Retrieve Current User
Retrieve currently authenticated user.
GET /v1/orgs/self/users/self
Arguments
No arguments.
Response
emailrequiredstring
User email.
created_atoptionalstring
ISO-8601 date.
first_nameoptionalstring
User first name.
last_nameoptionalstring
User last name.
rolesoptionalstring array
List of roles for a given user.
stateoptionalstring
State of user - NEW / ACTIVE.
curl --request GET \
--url https://api.usw2a1.rockset.com/v1/orgs/self/users/self \
-H 'Authorization: ApiKey _insert_your_apikey_here_'
Retrieve Notification Preferences
Get all notification preferences.
GET /v1/orgs/self/users/self/preferences
Arguments
No arguments.
Response
dataoptionalobject array
List of notification preferences.
Show child attributes
curl --request GET \
--url https://api.usw2a1.rockset.com/v1/orgs/self/users/self/preferences \
-H 'Authorization: ApiKey _insert_your_apikey_here_'
Retrieve User
Retrieve user by email.
GET /v1/orgs/self/users/{user}
Arguments
userrequiredstring(in path)
user email
Response
emailrequiredstring
User email.
created_atoptionalstring
ISO-8601 date.
first_nameoptionalstring
User first name.
last_nameoptionalstring
User last name.
rolesoptionalstring array
List of roles for a given user.
stateoptionalstring
State of user - NEW / ACTIVE.
curl --request GET \
--url https://api.usw2a1.rockset.com/v1/orgs/self/users/admin@me.com \
-H 'Authorization: ApiKey _insert_your_apikey_here_'
Update Notification Preferences
Update notification preference.
POST /v1/orgs/self/users/self/preferences
Arguments
dataoptionalobject array
List of notification preferences.
Show child attributes
Response
dataoptionalobject array
List of notification preferences.
Show child attributes
curl --request POST \
--url https://api.usw2a1.rockset.com/v1/orgs/self/users/self/preferences \
-H 'Authorization: ApiKey _insert_your_apikey_here_' \
-H 'Content-Type: application/json' \
-d '{
"data": [
{
"notificationType": "create_apikey"
}
]
}'
Update User
Update a user in an organization.
POST /v1/orgs/self/users/{user}
Arguments
userrequiredstring(in path)
email of the user to update
first_nameoptionalstring
User first name.
last_nameoptionalstring
User last name.
rolesoptionalstring array
New list of roles for a given user.
Response
emailrequiredstring
User email.
created_atoptionalstring
ISO-8601 date.
first_nameoptionalstring
User first name.
last_nameoptionalstring
User last name.
rolesoptionalstring array
List of roles for a given user.
stateoptionalstring
State of user - NEW / ACTIVE.
curl --request POST \
--url https://api.usw2a1.rockset.com/v1/orgs/self/users/admin@me.com \
-H 'Authorization: ApiKey _insert_your_apikey_here_' \
-H 'Content-Type: application/json' \
-d '{
"first_name": "John",
"last_name": "Doe",
"roles": [
"foo"
]
}'
Views
Create View
Create a view
POST /v1/orgs/self/ws/{workspace}/views
Arguments
workspacerequiredstring(in path)
name of the workspace
namerequiredstring
View name.
queryrequiredstring
SQL for this view.
descriptionoptionalstring
Optional description.
Response
dataoptionalobject
View that was updated.
Show child attributes
curl --request POST \
--url https://api.usw2a1.rockset.com/v1/orgs/self/ws/commons/views \
-H 'Authorization: ApiKey _insert_your_apikey_here_' \
-H 'Content-Type: application/json' \
-d '{
"name": "myAwesomeView",
"description": "view of awesome collection",
"query": "SELECT * FROM foo"
}'
Delete View
Delete a view
DELETE /v1/orgs/self/ws/{workspace}/views/{view}
Arguments
workspacerequiredstring(in path)
name of the workspace
viewrequiredstring(in path)
name of the view
Response
dataoptionalobject
View that was deleted.
Show child attributes
curl --request DELETE \
--url https://api.usw2a1.rockset.com/v1/orgs/self/ws/commons/views/view \
-H 'Authorization: ApiKey _insert_your_apikey_here_'
List Views
Retrieve all views in an organization
GET /v1/orgs/self/views
Arguments
No arguments.
Response
dataoptionalobject array
List of all views.
Show child attributes
curl --request GET \
--url https://api.usw2a1.rockset.com/v1/orgs/self/views \
-H 'Authorization: ApiKey _insert_your_apikey_here_'
List Views in Workspace
Retrieve all views in a workspace.
GET /v1/orgs/self/ws/{workspace}/views
Arguments
workspacerequiredstring(in path)
name of the workspace
Response
dataoptionalobject array
List of all views.
Show child attributes
curl --request GET \
--url https://api.usw2a1.rockset.com/v1/orgs/self/ws/commons/views \
-H 'Authorization: ApiKey _insert_your_apikey_here_'
Retrieve View
Get details about a view
GET /v1/orgs/self/ws/{workspace}/views/{view}
Arguments
workspacerequiredstring(in path)
name of the workspace
viewrequiredstring(in path)
name of the view
Response
dataoptionalobject
View that was requested.
Show child attributes
curl --request GET \
--url https://api.usw2a1.rockset.com/v1/orgs/self/ws/commons/views/view \
-H 'Authorization: ApiKey _insert_your_apikey_here_'
Update View
Update a view
POST /v1/orgs/self/ws/{workspace}/views/{view}
Arguments
workspacerequiredstring(in path)
name of the workspace
viewrequiredstring(in path)
name of the view
queryrequiredstring
SQL for this view.
descriptionoptionalstring
Optional description.
Response
dataoptionalobject
View that was updated.
Show child attributes
curl --request POST \
--url https://api.usw2a1.rockset.com/v1/orgs/self/ws/commons/views/view \
-H 'Authorization: ApiKey _insert_your_apikey_here_' \
-H 'Content-Type: application/json' \
-d '{
"description": "view of awesome collection",
"query": "SELECT * FROM foo"
}'
Virtual Instances
Create Virtual Instance
[beta] Create virtual instance
POST /v1/orgs/self/virtualinstances
Arguments
namerequiredstring
Unique identifier for virtual instance, can contain alphanumeric or dash characters.
typeoptionalstring
Requested virtual instance type. Possible values:
FREE
,NANO
,SHARED
,MILLI
,SMALL
,MEDIUM
,LARGE
,XLARGE
,XLARGE2
,XLARGE4
,XLARGE8
,XLARGE16
.descriptionoptionalstring
Description of requested virtual instance.
auto_suspend_secondsoptionalinteger
Number of seconds without queries after which the VI is suspended
mount_refresh_interval_secondsoptionalinteger
Number of seconds between data refreshes for mounts on this Virtual Instance
Response
dataoptionalobject
Virtual instance object.
Show child attributes
curl --request POST \
--url https://api.usw2a1.rockset.com/v1/orgs/self/virtualinstances \
-H 'Authorization: ApiKey _insert_your_apikey_here_' \
-H 'Content-Type: application/json' \
-d '{
"type": "LARGE",
"name": "prod_vi",
"description": "VI serving prod traffic",
"auto_suspend_seconds": 3600,
"mount_refresh_interval_seconds": 3600
}'
Delete Virtual Instance
[beta] Delete a virtual instance.
DELETE /v1/orgs/self/virtualinstances/{virtualInstanceId}
Arguments
virtualInstanceIdrequiredstring(in path)
Virtual Instance RRN
Response
dataoptionalobject
Virtual instance that was deleted.
Show child attributes
curl --request DELETE \
--url https://api.usw2a1.rockset.com/v1/orgs/self/virtualinstances/virtualInstanceId \
-H 'Authorization: ApiKey _insert_your_apikey_here_'
Execute SQL Query
[beta] Make a SQL query to Rockset.
POST /v1/orgs/self/virtualinstances/{virtualInstanceId}/queries
Arguments
virtualInstanceIdrequiredstring(in path)
Virtual Instance RRN
sqlrequiredobject
Main query request body.
Show child attributes
async_optionsoptionalobject
Options for configuring Asynchronous Query Mode (beta).
Show child attributes
Response
query_idoptionalstring
Unique ID for this query.
collectionsoptionalstring array
List of collections referenced in the query.
resultsoptionalobject array
Results from the query.
statsoptionalobject
Meta information about the query including execution latencies.
Show child attributes
warningsoptionalstring array
Warnings generated by the query. Only populated if
generate_warnings
is specified in the query request.query_lambda_pathoptionalstring
The full path of the executed query lambda. Includes version information.
query_errorsoptionalobject array
Errors encountered while executing the query.
Show child attributes
column_fieldsoptionalobject array
Meta information about each column in the result set. Not populated in
SELECT *
queries.Show child attributes
results_total_doc_countoptionalinteger
Number of results generated by the query.
paginationoptionalobject
Pagination information. Only populated if
paginate
is specified in the query request.Show child attributes
last_offsetoptionalstring
If this was a write query, this is the log offset the query was written to.
curl --request POST \
--url https://api.usw2a1.rockset.com/v1/orgs/self/virtualinstances/virtualInstanceId/queries \
-H 'Authorization: ApiKey _insert_your_apikey_here_' \
-H 'Content-Type: application/json' \
-d '{
"sql": {
"query": "SELECT * FROM foo where _id = :_id",
"generate_warnings": "true",
"parameters": [
{
"name": "_id",
"type": "string",
"value": "85beb391"
}
],
"default_row_limit": "123",
"initial_paginate_response_doc_count": "123"
},
"async_options": {
"client_timeout_ms": "123",
"timeout_ms": "123",
"max_initial_results": "123"
}
}'
Get Collection Mount
[beta] Get a mount on this virtual instance.
GET /v1/orgs/self/virtualinstances/{virtualInstanceId}/mounts/{collectionPath}
Arguments
virtualInstanceIdrequiredstring(in path)
Virtual Instance RRN
collectionPathrequiredstring(in path)
Response
dataoptionalobject
Resource mount object.
Show child attributes
curl --request GET \
--url https://api.usw2a1.rockset.com/v1/orgs/self/virtualinstances/virtualInstanceId/mounts/collectionPath \
-H 'Authorization: ApiKey _insert_your_apikey_here_'
List Collection Mounts
[beta] List collection mounts for a particular VI.
GET /v1/orgs/self/virtualinstances/{virtualInstanceId}/mounts
Arguments
virtualInstanceIdrequiredstring(in path)
Virtual Instance RRN
Response
dataoptionalobject array
List of all collection mounts.
Show child attributes
curl --request GET \
--url https://api.usw2a1.rockset.com/v1/orgs/self/virtualinstances/virtualInstanceId/mounts \
-H 'Authorization: ApiKey _insert_your_apikey_here_'
List Queries
[beta] Lists actively queued and running queries for a particular Virtual Instance.
GET /v1/orgs/self/virtualinstances/{virtualInstanceId}/queries
Arguments
virtualInstanceIdrequiredstring(in path)
Virtual Instance RRN
Response
dataoptionalobject array
Show child attributes
curl --request GET \
--url https://api.usw2a1.rockset.com/v1/orgs/self/virtualinstances/virtualInstanceId/queries \
-H 'Authorization: ApiKey _insert_your_apikey_here_'
List Virtual Instances
Retrieve all virtual instances in an organization.
GET /v1/orgs/self/virtualinstances
Arguments
No arguments.
Response
dataoptionalobject array
List of all virtual instances.
Show child attributes
curl --request GET \
--url https://api.usw2a1.rockset.com/v1/orgs/self/virtualinstances \
-H 'Authorization: ApiKey _insert_your_apikey_here_'
Mount Collection
[beta] Mount a collection to this virtual instance.
POST /v1/orgs/self/virtualinstances/{virtualInstanceId}/mounts
Arguments
virtualInstanceIdrequiredstring(in path)
Virtual Instance RRN
typeoptionalstring
Mount type. Possible values:
STATIC
,LIVE
.collection_pathsoptionalstring array
Collections to mount.
Response
dataoptionalobject array
Mounts created.
Show child attributes
curl --request POST \
--url https://api.usw2a1.rockset.com/v1/orgs/self/virtualinstances/virtualInstanceId/mounts \
-H 'Authorization: ApiKey _insert_your_apikey_here_' \
-H 'Content-Type: application/json' \
-d '{
"type": "STATIC",
"collection_paths": [
"foo"
]
}'
Resume Virtual Instance
[beta] Resume a virtual instance.
POST /v1/orgs/self/virtualinstances/{virtualInstanceId}/resume
Arguments
virtualInstanceIdrequiredstring(in path)
Virtual Instance RRN
Response
dataoptionalobject
Virtual instance that was resumed.
Show child attributes
curl --request POST \
--url https://api.usw2a1.rockset.com/v1/orgs/self/virtualinstances/virtualInstanceId/resume \
-H 'Authorization: ApiKey _insert_your_apikey_here_'
Retrieve Virtual Instance
Get details about a virtual instance.
GET /v1/orgs/self/virtualinstances/{virtualInstanceId}
Arguments
virtualInstanceIdrequiredstring(in path)
Virtual Instance RRN
Response
dataoptionalobject
Virtual instance that was requested.
Show child attributes
curl --request GET \
--url https://api.usw2a1.rockset.com/v1/orgs/self/virtualinstances/virtualInstanceId \
-H 'Authorization: ApiKey _insert_your_apikey_here_'
Suspend Virtual Instance
[beta] Suspend a virtual instance.
POST /v1/orgs/self/virtualinstances/{virtualInstanceId}/suspend
Arguments
virtualInstanceIdrequiredstring(in path)
Virtual Instance RRN
Response
dataoptionalobject
Virtual instance that was suspended.
Show child attributes
curl --request POST \
--url https://api.usw2a1.rockset.com/v1/orgs/self/virtualinstances/virtualInstanceId/suspend \
-H 'Authorization: ApiKey _insert_your_apikey_here_'
Unmount Collection
[beta] Unmount a collection from this virtual instance.
DELETE /v1/orgs/self/virtualinstances/{virtualInstanceId}/mounts/{collectionPath}
Arguments
virtualInstanceIdrequiredstring(in path)
Virtual Instance RRN
collectionPathrequiredstring(in path)
Response
dataoptionalobject
Resource mount object.
Show child attributes
curl --request DELETE \
--url https://api.usw2a1.rockset.com/v1/orgs/self/virtualinstances/virtualInstanceId/mounts/collectionPath \
-H 'Authorization: ApiKey _insert_your_apikey_here_'
Update Virtual Instance
Update the properties of a virtual instance.
POST /v1/orgs/self/virtualinstances/{virtualInstanceId}
Arguments
virtualInstanceIdrequiredstring(in path)
Virtual Instance RRN
new_sizeoptionalstring
Requested virtual instance size. Possible values:
FREE
,NANO
,SHARED
,MILLI
,SMALL
,MEDIUM
,LARGE
,XLARGE
,XLARGE2
,XLARGE4
,XLARGE8
,XLARGE16
.monitoring_enabledoptionalboolean
nameoptionalstring
New virtual instance name.
descriptionoptionalstring
New virtual instance description.
auto_suspend_enabledoptionalboolean
Whether auto-suspend should be enabled for this Virtual Instance.
auto_suspend_secondsoptionalinteger
Number of seconds without queries after which the VI is suspended
mount_refresh_interval_secondsoptionalinteger
Number of seconds between data refreshes for mounts on this Virtual Instance
Response
dataoptionalobject
Virtual instance that was switched.
Show child attributes
curl --request POST \
--url https://api.usw2a1.rockset.com/v1/orgs/self/virtualinstances/virtualInstanceId \
-H 'Authorization: ApiKey _insert_your_apikey_here_' \
-H 'Content-Type: application/json' \
-d '{
"new_size": "LARGE",
"monitoring_enabled": "true",
"name": "prod_vi",
"description": "VI for prod traffic",
"auto_suspend_enabled": true,
"auto_suspend_seconds": 3600,
"mount_refresh_interval_seconds": 3600
}'
Workspaces
Create Workspace
Create a new workspace.
POST /v1/orgs/self/ws
Arguments
namerequiredstring
Descriptive label and unique identifier.
descriptionoptionalstring
Longer explanation for the workspace.
Response
dataoptionalobject
The workspace that was created.
Show child attributes
curl --request POST \
--url https://api.usw2a1.rockset.com/v1/orgs/self/ws \
-H 'Authorization: ApiKey _insert_your_apikey_here_' \
-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
Response
dataoptionalobject
The workspace that was deleted.
Show child attributes
curl --request DELETE \
--url https://api.usw2a1.rockset.com/v1/orgs/self/ws/commons \
-H 'Authorization: ApiKey _insert_your_apikey_here_'
List Workspaces
List all workspaces in an organization.
GET /v1/orgs/self/ws
Arguments
No arguments.
Response
dataoptionalobject array
List of workspaces.
Show child attributes
curl --request GET \
--url https://api.usw2a1.rockset.com/v1/orgs/self/ws \
-H 'Authorization: ApiKey _insert_your_apikey_here_'
Retrieve Workspace
Get information about a single workspace.
GET /v1/orgs/self/ws/{workspace}
Arguments
workspacerequiredstring(in path)
name of the workspace
Response
dataoptionalobject
The workspace that was requested.
Show child attributes
curl --request GET \
--url https://api.usw2a1.rockset.com/v1/orgs/self/ws/commons \
-H 'Authorization: ApiKey _insert_your_apikey_here_'