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.rs2.usw2.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.
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.rs2.usw2.rockset.com/v1/orgs/self/queries/queryId \
-H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'
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.
collectionsoptionalarray
List of collections referenced in the query.
Show child attributes
resultsoptionalarray
Results from the query.
Show child attributes
statsoptionalobject
Meta information about the query including execution latencies.
Show child attributes
warningsoptionalarray
Warnings generated by the query. Only populated if
generate_warnings
is specified in the query request.Show child attributes
query_lambda_pathoptionalstring
The full path of the executed query lambda. Includes version information.
query_errorsoptionalarray
Errors encountered while executing the query.
Show child attributes
column_fieldsoptionalarray
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.rs2.usw2.rockset.com/v1/orgs/self/queries \
-H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT' \
-H 'Content-Type: application/json' \
-d '{
"sql": {
"query": "SELECT * FROM foo where _id = :_id",
"parameters": [
{
"name": "_id",
"type": "string",
"value": "85beb391"
}
]
},
"async_options": {}
}'
List Queries
Lists actively queued and running queries.
GET /v1/orgs/self/queries
Arguments
No arguments.
Response
dataoptionalarray
Show child attributes
curl --request GET \
--url https://api.rs2.usw2.rockset.com/v1/orgs/self/queries \
-H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'
Retrieve Query
Returns information about a query.
GET /v1/orgs/self/queries/{queryId}
Arguments
queryIdrequiredstring(in path)
Response
query_idoptionalstring
Unique ID for this query.
collectionsoptionalarray
List of collections referenced in the query.
Show child attributes
resultsoptionalarray
Results from the query.
Show child attributes
statsoptionalobject
Meta information about the query including execution latencies.
Show child attributes
warningsoptionalarray
Warnings generated by the query. Only populated if
generate_warnings
is specified in the query request.Show child attributes
query_lambda_pathoptionalstring
The full path of the executed query lambda. Includes version information.
query_errorsoptionalarray
Errors encountered while executing the query.
Show child attributes
column_fieldsoptionalarray
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 GET \
--url https://api.rs2.usw2.rockset.com/v1/orgs/self/queries/queryId \
-H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'
Retrieve Query Results Page
Returns a page of query results.
GET /v1/orgs/self/queries/{queryId}/pages
Arguments
queryIdrequiredstring(in path)
cursoroptionalstring
docsoptionalinteger
offsetoptionalinteger
Response
resultsoptionalarray
List of documents returned by the query
Show child attributes
results_total_doc_countoptionalinteger
Total documents returned by the query
paginationoptionalobject
Pagination metadata
Show child attributes
curl --request GET \
--url https://api.rs2.usw2.rockset.com/v1/orgs/self/queries/queryId/pages \
-H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'
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
collectionsrequiredarray
list of collections specified in query
Show child attributes
parametersrequiredarray
list of parameters specified in query
Show child attributes
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": {
"query": "SELECT * FROM foo where _id = :_id",
"parameters": [
{
"name": "_id",
"type": "string",
"value": "85beb391"
}
]
},
"async_options": {}
}'
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 documents to be added to the collection.
Show child attributes
Response
dataoptionalarray
information about the added documents
Show child attributes
curl --request POST \
--url https://api.rs2.usw2.rockset.com/v1/orgs/self/ws/commons/collections/customers/docs \
-H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT' \
-H 'Content-Type: application/json' \
-d '{
"data": [
{
"field": "value"
}
]
}'
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 IDs of documents to be deleted
Show child attributes
Response
dataoptionalarray
information about deleted documents
Show child attributes
curl --request DELETE \
--url https://api.rs2.usw2.rockset.com/v1/orgs/self/ws/commons/collections/customers/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 patches to be applied.
Show child attributes
Response
datarequiredarray
Show child attributes
curl --request PATCH \
--url https://api.rs2.usw2.rockset.com/v1/orgs/self/ws/commons/collections/customers/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": {
"type": "object",
"example": "baz",
"description": "Value used in the patch operation. Required for `ADD`, `REPLACE`, `TEST`, and `INCREMENT` operations."
}
}
]
}
]
}'
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
Response
dataoptionalobject
The API key that was created.
Show child attributes
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": "my-app"
}'
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.rs2.usw2.rockset.com/v1/orgs/self/users/admin@me.com/apikeys/name \
-H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'
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
dataoptionalarray
List of API key objects.
Show child attributes
curl --request GET \
--url https://api.rs2.usw2.rockset.com/v1/orgs/self/users/admin@me.com/apikeys \
-H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'
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
Reveal full key.
Response
dataoptionalobject
The requested API key object.
Show child attributes
curl --request GET \
--url https://api.rs2.usw2.rockset.com/v1/orgs/self/users/admin@me.com/apikeys/name \
-H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'
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.
Response
dataoptionalobject
The API key that was updated.
Show child attributes
curl --request POST \
--url https://api.rs2.usw2.rockset.com/v1/orgs/self/users/admin@me.com/apikeys/name \
-H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT' \
-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
descriptionoptionalstring
optional description
collectionsrequiredarray
list of fully qualified collection names referenced by alias
Show child attributes
Response
dataoptionalobject
alias that was created
Show child attributes
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": [
"commons.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
Response
dataoptionalobject
alias that was deleted
Show child attributes
curl --request DELETE \
--url https://api.rs2.usw2.rockset.com/v1/orgs/self/ws/commons/aliases/alias \
-H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'
List Aliases
Retrieve all aliases in an organization
GET /v1/orgs/self/aliases
Arguments
No arguments.
Response
dataoptionalarray
list of all aliases
Show child attributes
curl --request GET \
--url https://api.rs2.usw2.rockset.com/v1/orgs/self/aliases \
-H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'
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
dataoptionalarray
list of all aliases
Show child attributes
curl --request GET \
--url https://api.rs2.usw2.rockset.com/v1/orgs/self/ws/commons/aliases \
-H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'
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.rs2.usw2.rockset.com/v1/orgs/self/ws/commons/aliases/alias \
-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
Show child attributes
Response
dataoptionalobject
alias that was requested
Show child attributes
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": [
"commons.foo",
"prod.demo"
]
}'
Collections
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
insert_onlyoptionalboolean
If true disallows updates and deletes, but makes indexing more efficient
event_time_infooptionalobject
configuration for event data
Show child attributes
field_mappingsoptionalarray
list of mappings
Show child attributes
field_mapping_queryoptionalobject
Mapping of fields for a collection
Show child attributes
clustering_keyoptionalarray
list of clustering fields
Show child attributes
Response
dataoptionalobject
collection that was created
Show child attributes
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": {
"prefix": "prefix/to/keys",
"pattern": "prefix/to/**/keys/*.format",
"region": "us-west-2",
"bucket": "s3://customer-account-info"
},
"kinesis": {
"aws_region": "us-east-2",
"stream_name": "click_stream",
"dms_primary_key": [
null
],
"offset_reset_policy": "EARLIEST"
},
"gcs": {
"bucket": "server-logs",
"prefix": "prefix/to/keys",
"pattern": "prefix/to/**/keys/*.format"
},
"azure_blob_storage": {
"container": "server-logs",
"prefix": "prefix/to/blobs",
"pattern": "prefix/to/**/keys/*.format"
},
"azure_service_bus": {
"topic": "rockset-topic",
"subscription": "rockset-subscription"
},
"azure_event_hubs": {
"hub_id": "event-hub-1",
"offset_reset_policy": "EARLIEST"
},
"dynamodb": {
"aws_region": "us-east-2",
"table_name": "dynamodb_table_name",
"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",
"consumer_group_id": "org-collection"
},
"mongodb": {
"database_name": "my_database",
"collection_name": "my_collection"
},
"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"
},
"avro": {}
}
}
],
"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",
"is_drop": true,
"param": "zip"
}
],
"output_field": {
"field_name": "zip_hash",
"value": "SHA256(:zip)",
"on_error": "SKIP"
}
}
],
"field_mapping_query": {
"sql": "sql"
},
"clustering_key": [
{
"field_name": "address.city.zipcode",
"type": "AUTO",
"keys": [
"value1",
"value2"
]
}
]
}'
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.rs2.usw2.rockset.com/v1/orgs/self/ws/commons/collections/customers \
-H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'
List Collections
Retrieve all collections in an organization.
GET /v1/orgs/self/collections
Arguments
No arguments.
Response
dataoptionalarray
list of all collections
Show child attributes
curl --request GET \
--url https://api.rs2.usw2.rockset.com/v1/orgs/self/collections \
-H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'
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
dataoptionalarray
list of all collections
Show child attributes
curl --request GET \
--url https://api.rs2.usw2.rockset.com/v1/orgs/self/ws/commons/collections \
-H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'
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.rs2.usw2.rockset.com/v1/orgs/self/ws/commons/collections/customers \
-H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'
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.
privilegesoptionalarray
List of privileges that will be associated with the role.
Show child attributes
Response
dataoptionalobject
Show child attributes
curl --request POST \
--url https://api.rs2.usw2.rockset.com/v1/orgs/self/roles \
-H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT' \
-H 'Content-Type: application/json' \
-d '{
"role_name": "read_write",
"description": "Role with read and write privileges to all collections.",
"privileges": [
{
"action": "Create collection",
"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.rs2.usw2.rockset.com/v1/orgs/self/roles/roleName \
-H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'
List Roles
List all roles for your organization.
GET /v1/orgs/self/roles
Arguments
No arguments.
Response
dataoptionalarray
List of all roles.
Show child attributes
curl --request GET \
--url https://api.rs2.usw2.rockset.com/v1/orgs/self/roles \
-H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'
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.rs2.usw2.rockset.com/v1/orgs/self/roles/roleName \
-H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'
Update a Role
Update a role for your organization.
POST /v1/orgs/self/roles/{roleName}
Arguments
roleNamerequiredstring(in path)
descriptionoptionalstring
Description for the role.
privilegesoptionalarray
List of privileges that will be associated with the role.
Show child attributes
Response
dataoptionalobject
Show child attributes
curl --request POST \
--url https://api.rs2.usw2.rockset.com/v1/orgs/self/roles/roleName \
-H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT' \
-H 'Content-Type: application/json' \
-d '{
"description": "Role with read and write privileges to all collections.",
"privileges": [
{
"action": "Create collection",
"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_event_hubsoptionalobject
Show child attributes
segmentoptionalobject
Show child attributes
kafkaoptionalobject
Show child attributes
mongodboptionalobject
MongoDb details
Show child attributes
Response
dataoptionalobject
integration object that was created
Show child attributes
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"
}
},
"gcs": {
"gcp_service_account": {}
},
"azure_blob_storage": {},
"azure_event_hubs": {},
"segment": {},
"kafka": {
"kafka_topic_names": [
null
],
"kafka_data_format": "json",
"security_config": {},
"schema_registry_config": {}
},
"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
Response
dataoptionalobject
integration object that was deleted
Show child attributes
curl --request DELETE \
--url https://api.rs2.usw2.rockset.com/v1/orgs/self/integrations/my-aws-creds \
-H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'
List Integrations
List all integrations in an organization.
GET /v1/orgs/self/integrations
Arguments
No arguments.
Response
dataoptionalarray
list of integration objects
Show child attributes
curl --request GET \
--url https://api.rs2.usw2.rockset.com/v1/orgs/self/integrations \
-H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'
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.rs2.usw2.rockset.com/v1/orgs/self/integrations/my-aws-creds \
-H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'
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
descriptionoptionalstring
optional description
sqlrequiredobject
Query Lambda SQL query
Show child attributes
Response
dataoptionalobject
Query Lambda version details
Show child attributes
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
Response
dataoptionalobject
updated Query Lambda tag
Show child attributes
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
Response
dataoptionalobject
Query Lambda details
Show child attributes
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
Response
dataoptionalobject
updated Query Lambda tag
Show child attributes
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
Response
dataoptionalobject
Query Lambda version details
Show child attributes
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 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
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.
Response
query_idoptionalstring
Unique ID for this query.
collectionsoptionalarray
List of collections referenced in the query.
Show child attributes
resultsoptionalarray
Results from the query.
Show child attributes
statsoptionalobject
Meta information about the query including execution latencies.
Show child attributes
warningsoptionalarray
Warnings generated by the query. Only populated if
generate_warnings
is specified in the query request.Show child attributes
query_lambda_pathoptionalstring
The full path of the executed query lambda. Includes version information.
query_errorsoptionalarray
Errors encountered while executing the query.
Show child attributes
column_fieldsoptionalarray
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.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"
}
]
}'
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
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
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.
Response
query_idoptionalstring
Unique ID for this query.
collectionsoptionalarray
List of collections referenced in the query.
Show child attributes
resultsoptionalarray
Results from the query.
Show child attributes
statsoptionalobject
Meta information about the query including execution latencies.
Show child attributes
warningsoptionalarray
Warnings generated by the query. Only populated if
generate_warnings
is specified in the query request.Show child attributes
query_lambda_pathoptionalstring
The full path of the executed query lambda. Includes version information.
query_errorsoptionalarray
Errors encountered while executing the query.
Show child attributes
column_fieldsoptionalarray
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.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"
}
]
}'
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
dataoptionalarray
list of all tags associated with a Query Lambda
Show child attributes
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
Response
dataoptionalarray
list of all versions for a particular Query Lambda
Show child attributes
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.
Response
dataoptionalarray
list of all Query Lambdas
Show child attributes
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
Response
dataoptionalarray
list of all Query Lambdas
Show child attributes
curl --request GET \
--url https://api.rs2.usw2.rockset.com/v1/orgs/self/ws/commons/lambdas \
-H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'
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.rs2.usw2.rockset.com/v1/orgs/self/ws/commons/lambdas/queryLambda/tags/tag \
-H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'
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.rs2.usw2.rockset.com/v1/orgs/self/ws/commons/lambdas/queryLambda/versions/version \
-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
Response
dataoptionalobject
Query Lambda version details
Show child attributes
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
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
Show child attributes
Response
dataoptionalobject
user that was created
Show child attributes
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
Response
dataoptionalobject
user object that was deleted
Show child attributes
curl --request DELETE \
--url https://api.rs2.usw2.rockset.com/v1/orgs/self/users/admin@me.com \
-H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'
List Users
Retrieve all users for an organization.
GET /v1/orgs/self/users
Arguments
No arguments.
Response
dataoptionalarray
list of users
Show child attributes
curl --request GET \
--url https://api.rs2.usw2.rockset.com/v1/orgs/self/users \
-H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'
Retrieve Current User
Retrieve currently authenticated user.
GET /v1/orgs/self/users/self
Arguments
No arguments.
Response
created_atoptionalstring
ISO-8601 date
emailrequiredstring
user email
first_nameoptionalstring
user first name
last_nameoptionalstring
user last name
rolesoptionalarray
List of roles for a given user
Show child attributes
stateoptionalstring
state of user - NEW / ACTIVE
curl --request GET \
--url https://api.rs2.usw2.rockset.com/v1/orgs/self/users/self \
-H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'
Retrieve Notification Preferences
Get all notification preferences.
GET /v1/orgs/self/users/self/preferences
Arguments
No arguments.
Response
dataoptionalarray
List of notification preferences
Show child attributes
curl --request GET \
--url https://api.rs2.usw2.rockset.com/v1/orgs/self/users/self/preferences \
-H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'
Retrieve User
Retrieve user by email.
GET /v1/orgs/self/users/{user}
Arguments
userrequiredstring(in path)
user email
Response
created_atoptionalstring
ISO-8601 date
emailrequiredstring
user email
first_nameoptionalstring
user first name
last_nameoptionalstring
user last name
rolesoptionalarray
List of roles for a given user
Show child attributes
stateoptionalstring
state of user - NEW / ACTIVE
curl --request GET \
--url https://api.rs2.usw2.rockset.com/v1/orgs/self/users/admin@me.com \
-H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'
Update Notification Preferences
Update notification preference.
POST /v1/orgs/self/users/self/preferences
Arguments
dataoptionalarray
List of notification preferences
Show child attributes
Response
dataoptionalarray
List of notification preferences
Show child attributes
curl --request POST \
--url https://api.rs2.usw2.rockset.com/v1/orgs/self/users/self/preferences \
-H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT' \
-H 'Content-Type: application/json' \
-d '{
"data": [
{
"notificationType": "create_apikey"
}
]
}'
Views
Create View
Create a view
POST /v1/orgs/self/ws/{workspace}/views
Arguments
workspacerequiredstring(in path)
name of the workspace
namerequiredstring
View name
descriptionoptionalstring
optional description
queryrequiredstring
SQL for this view
Response
dataoptionalobject
view that was updated
Show child attributes
curl --request POST \
--url https://api.rs2.usw2.rockset.com/v1/orgs/self/ws/commons/views \
-H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT' \
-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.rs2.usw2.rockset.com/v1/orgs/self/ws/commons/views/view \
-H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'
List Views
Retrieve all views in an organization
GET /v1/orgs/self/views
Arguments
No arguments.
Response
dataoptionalarray
list of all views
Show child attributes
curl --request GET \
--url https://api.rs2.usw2.rockset.com/v1/orgs/self/views \
-H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'
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
dataoptionalarray
list of all views
Show child attributes
curl --request GET \
--url https://api.rs2.usw2.rockset.com/v1/orgs/self/ws/commons/views \
-H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'
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.rs2.usw2.rockset.com/v1/orgs/self/ws/commons/views/view \
-H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'
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
descriptionoptionalstring
optional description
queryrequiredstring
SQL for this view
Response
dataoptionalobject
view that was updated
Show child attributes
curl --request POST \
--url https://api.rs2.usw2.rockset.com/v1/orgs/self/ws/commons/views/view \
-H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT' \
-H 'Content-Type: application/json' \
-d '{
"description": "view of awesome collection",
"query": "SELECT * FROM foo"
}'
Virtual Instances
List Virtual Instances
Retrieve all virtual instances in an organization.
GET /v1/orgs/self/virtualinstances
Arguments
No arguments.
Response
dataoptionalarray
list of all virtual instances
Show child attributes
curl --request GET \
--url https://api.rs2.usw2.rockset.com/v1/orgs/self/virtualinstances \
-H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'
Retrieve Virtual Instance
Get details about a virtual instance.
GET /v1/orgs/self/virtualinstances/{virtualInstanceId}
Arguments
virtualInstanceIdrequiredstring(in path)
uuid of the virtual instance
Response
dataoptionalobject
virtual instance that was requested
Show child attributes
curl --request GET \
--url https://api.rs2.usw2.rockset.com/v1/orgs/self/virtualinstances/virtualInstanceId \
-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
Response
dataoptionalobject
virtual instance that was switched
Show child attributes
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
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.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
Response
dataoptionalobject
the workspace that was deleted
Show child attributes
curl --request DELETE \
--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.
Response
dataoptionalarray
list of workspaces
Show child attributes
curl --request GET \
--url https://api.rs2.usw2.rockset.com/v1/orgs/self/ws \
-H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'
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.rs2.usw2.rockset.com/v1/orgs/self/ws/commons \
-H 'Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT'