REST API

REST API
Aliases
API Keys
Collections
Custom Roles
Deployment Settings
- Retrieve Deployment Settingsget
- Update Deployment Settingsput
Documents
Integrations
Organizations
- Get Organizationget
Queries
Query Lambdas
Scheduled Lambdas
Shared Lambdas
- Execute a Public Query Lambdapost
Sources
Users
Views
Virtual Instances
Workspaces

SQL Commands

All Commands
DESCRIBE
SELECT
INSERT INTO collection
INSERT INTO s3
CREATE
DROP

SQL Functions

All Functions
Data Types
Type Functions
Conditional Expressions
Array Functions
Object Functions
Window Functions
- Over
- Window Functions
Mathematical Functions
Hash Functions
- Hash Functions
- HMAC Functions
Date And Time Functions
Aggregate Functions
String Functions
Text Search Functions
- Term Matcher Functions
Geographic Functions
User-Defined Functions
Vector Functions
Special Functions

REST API

REST API
Aliases
API Keys
Collections
Custom Roles
Deployment Settings
- Retrieve Deployment Settingsget
- Update Deployment Settingsput
Documents
Integrations
Organizations
- Get Organizationget
Queries
Query Lambdas
Scheduled Lambdas
Shared Lambdas
- Execute a Public Query Lambdapost
Sources
Users
Views
Virtual Instances
Workspaces

SQL Commands

All Commands
DESCRIBE
SELECT
INSERT INTO collection
INSERT INTO s3
CREATE
DROP

SQL Functions

All Functions
Data Types
Type Functions
Conditional Expressions
Array Functions
Object Functions
Window Functions
- Over
- Window Functions
Mathematical Functions
Hash Functions
- Hash Functions
- HMAC Functions
Date And Time Functions
Aggregate Functions
String Functions
Text Search Functions
- Term Matcher Functions
Geographic Functions
User-Defined Functions
Vector Functions
Special Functions

Update API Key State

post https://api.{region}.rockset.com/v1/orgs/self/users/{user}/apikeys/{name}

Update the state of an API key for any user in your organization.

URL Expired

The URL for this request expired after 30 days.

Path Params

name

string

required

Name of the API key.

user

string

required

Email of the API key owner. Use self to specify the currently authenticated user.

Body Params

JSON object

clear_expiry_time

boolean

If set to true, the expiration time for this key will be cleared.

expiry_time

string

If provided, the API key will automatically expire at this time (ISO-8601 format). Requires premium.

state

string

State that the api key should be set to.

Responses

Response body

object

data

object

The API key that was updated.

created_at

string

Date that API key was created (ISO-8601 format).

created_by

string

Email of API key owner.

created_by_apikey_name

string

Name of the API key that was used to create this object if one was used.

expiry_time

string

The expiration date of this API key.

key

string

required

This field will only be populated with the full key when creating an API key. Otherwise, it will be an API key identifier of 6 characters.

last_access_time

string

Date that API key was most recently used (ISO-8601 format).

name

string

required

Name of the API key.

role

string

Role specifying access control. If not specified, API key will have access to all of the associated user's roles.

state

string

Current state of this key.

ACTIVE SUSPENDED

Response body

object

column

int32

Column where the error happened (if applicable).

error_id

string

ID of the error.

line

int32

Line where the error happened (if applicable).

message

string

Descriptive message about the error.

query_id

string

ID of the query (if applicable).

trace_id

string

Internal trace ID to help with debugging.

type

string

Category of the error.

AUTHEXCEPTION VERSIONEXCEPTION INTERNALERROR INVALIDINPUT NOTIMPLEMENTEDYET RESOURCEEXCEEDED ALREADYEXISTS METHODNOTALLOWED NOTACCEPTABLE UNSUPPORTEDMEDIATYPE NOTFOUND DEPENDENTRESOURCES QUERY_ERROR NOT_READY FORBIDDEN QUERY_TIMEOUT CONNECTION_ERROR CONTENTTOOLARGE CREATING BADREQUEST SERVICEUNAVAILABLE CONFLICT RATELIMITEXCEEDED QUERY_CANCELLED CLIENT_CONNECTION_ERROR

virtual_instance_rrn

string

Virtual Instance RRN for the Virtual Instance that the query was run on (if applicable).

Response body

object

column

int32

Column where the error happened (if applicable).

error_id

string

ID of the error.

line

int32

Line where the error happened (if applicable).

message

string

Descriptive message about the error.

query_id

string

ID of the query (if applicable).

trace_id

string

Internal trace ID to help with debugging.

type

string

Category of the error.

virtual_instance_rrn

string

Virtual Instance RRN for the Virtual Instance that the query was run on (if applicable).

Response body

object

column

int32

Column where the error happened (if applicable).

error_id

string

ID of the error.

line

int32

Line where the error happened (if applicable).

message

string

Descriptive message about the error.

query_id

string

ID of the query (if applicable).

trace_id

string

Internal trace ID to help with debugging.

type

string

Category of the error.

virtual_instance_rrn

string

Virtual Instance RRN for the Virtual Instance that the query was run on (if applicable).

Response body

object

column

int32

Column where the error happened (if applicable).

error_id

string

ID of the error.

line

int32

Line where the error happened (if applicable).

message

string

Descriptive message about the error.

query_id

string

ID of the query (if applicable).

trace_id

string

Internal trace ID to help with debugging.

type

string

Category of the error.

virtual_instance_rrn

string

Virtual Instance RRN for the Virtual Instance that the query was run on (if applicable).

Response body

object

column

int32

Column where the error happened (if applicable).

error_id

string

ID of the error.

line

int32

Line where the error happened (if applicable).

message

string

Descriptive message about the error.

query_id

string

ID of the query (if applicable).

trace_id

string

Internal trace ID to help with debugging.

type

string

Category of the error.

virtual_instance_rrn

string

Virtual Instance RRN for the Virtual Instance that the query was run on (if applicable).

Response body

object

column

int32

Column where the error happened (if applicable).

error_id

string

ID of the error.

line

int32

Line where the error happened (if applicable).

message

string

Descriptive message about the error.

query_id

string

ID of the query (if applicable).

trace_id

string

Internal trace ID to help with debugging.

type

string

Category of the error.

virtual_instance_rrn

string

Virtual Instance RRN for the Virtual Instance that the query was run on (if applicable).

Response body

object

column

int32

Column where the error happened (if applicable).

error_id

string

ID of the error.

line

int32

Line where the error happened (if applicable).

message

string

Descriptive message about the error.

query_id

string

ID of the query (if applicable).

trace_id

string

Internal trace ID to help with debugging.

type

string

Category of the error.

virtual_instance_rrn

string

Virtual Instance RRN for the Virtual Instance that the query was run on (if applicable).

Response body

object

column

int32

Column where the error happened (if applicable).

error_id

string

ID of the error.

line

int32

Line where the error happened (if applicable).

message

string

Descriptive message about the error.

query_id

string

ID of the query (if applicable).

trace_id

string

Internal trace ID to help with debugging.

type

string

Category of the error.

virtual_instance_rrn

string

Virtual Instance RRN for the Virtual Instance that the query was run on (if applicable).

Response body

object

column

int32

Column where the error happened (if applicable).

error_id

string

ID of the error.

line

int32

Line where the error happened (if applicable).

message

string

Descriptive message about the error.

query_id

string

ID of the query (if applicable).

trace_id

string

Internal trace ID to help with debugging.

type

string

Category of the error.

virtual_instance_rrn

string

Virtual Instance RRN for the Virtual Instance that the query was run on (if applicable).

Response body

object

column

int32

Column where the error happened (if applicable).

error_id

string

ID of the error.

line

int32

Line where the error happened (if applicable).

message

string

Descriptive message about the error.

query_id

string

ID of the query (if applicable).

trace_id

string

Internal trace ID to help with debugging.

type

string

Category of the error.

virtual_instance_rrn

string

Virtual Instance RRN for the Virtual Instance that the query was run on (if applicable).

Response body

object

column

int32

Column where the error happened (if applicable).

error_id

string

ID of the error.

line

int32

Line where the error happened (if applicable).

message

string

Descriptive message about the error.

query_id

string

ID of the query (if applicable).

trace_id

string

Internal trace ID to help with debugging.

type

string

Category of the error.

virtual_instance_rrn

string

Virtual Instance RRN for the Virtual Instance that the query was run on (if applicable).

Response body

object

column

int32

Column where the error happened (if applicable).

error_id

string

ID of the error.

line

int32

Line where the error happened (if applicable).

message

string

Descriptive message about the error.

query_id

string

ID of the query (if applicable).

trace_id

string

Internal trace ID to help with debugging.

type

string

Category of the error.

virtual_instance_rrn

string

Virtual Instance RRN for the Virtual Instance that the query was run on (if applicable).

Response body

object

column

int32

Column where the error happened (if applicable).

error_id

string

ID of the error.

line

int32

Line where the error happened (if applicable).

message

string

Descriptive message about the error.

query_id

string

ID of the query (if applicable).

trace_id

string

Internal trace ID to help with debugging.

type

string

Category of the error.

virtual_instance_rrn

string

Virtual Instance RRN for the Virtual Instance that the query was run on (if applicable).

Response body

object

column

int32

Column where the error happened (if applicable).

error_id

string

ID of the error.

line

int32

Line where the error happened (if applicable).

message

string

Descriptive message about the error.

query_id

string

ID of the query (if applicable).

trace_id

string

Internal trace ID to help with debugging.

type

string

Category of the error.

virtual_instance_rrn

string

Virtual Instance RRN for the Virtual Instance that the query was run on (if applicable).

Updated 12 months ago

Retrieve API Key

Collections

Did this page help you?

Language

Credentials

Header

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.usw2a1.rockset.com/v1/orgs/self/users/user/apikeys/name \
3
     --header 'Authorization: ApiKey YOUR_ROCKSET_KEY' \
4
     --header 'accept: application/json' \
5
     --header 'content-type: application/json'


xxxxxxxxxx
13
 
1
{
2
  "data": {
3
    "created_at": "2001-08-28T00:23:41Z",
4
    "created_by": "test@rockset.com",
5
    "created_by_apikey_name": "string",
6
    "expiry_time": "2001-08-28T00:23:41Z",
7
    "key": "aB35kD",
8
    "last_access_time": "2001-08-28T00:23:41Z",
9
    "name": "my-key",
10
    "role": "read-only",
11
    "state": "ACTIVE"
12
  }
13
}

Updated 12 months ago

Retrieve API Key

Collections

Did this page help you?

REST API
REST API
Aliases
Update Aliaspost
Retrieve Aliasget
Delete Aliasdelete
Create Aliaspost
List Aliases in Workspaceget
List Aliasesget
API Keys
Update API Key Statepost
Retrieve API Keyget
Delete API Keydelete
List API Keysget
Create API Keypost
Collections
Set Collection Stateput
Get Collection Commitpost
Update Collectionput
Retrieve Collectionget
Delete Collectiondelete
Create Collectionpost
List Collections in Workspaceget
List Collectionsget
Custom Roles
Update a Rolepost
Retrieve roleget
Delete a Roledelete
Create a Rolepost
List Rolesget
Deployment Settings
Update Deployment Settingsput
Retrieve Deployment Settingsget
Documents
Add Documentspost
Patch Documentspatch
Delete Documentsdelete
Integrations
Update Integrationput
Retrieve Integrationget
Delete Integrationdelete
Create Integrationpost
List Integrationsget
Organizations
Get Organizationget
Queries
Retrieve Query Results Pageget
Retrieve Queryget
Cancel Querydelete
Validate Querypost
Execute SQL Querypost
List Queriesget
Query Lambdas
Execute Query Lambda By Versionpost
Retrieve Query Lambda Versionget
Update Query Lambdapost
List Query Lambda Versionsget
Delete Query Lambda Versiondelete
Execute Query Lambda By Tagpost
Retrieve Query Lambda Tagget
Delete Query Lambda Tag Versiondelete
Create Query Lambda Tagpost
List Query Lambda Tagsget
Delete Query Lambdadelete
Create Query Lambdapost
List Query Lambdas in Workspaceget
List Query Lambdasget
Scheduled Lambdas
Update a Scheduled Lambda mappingpost
Retrieve a Scheduled Lambda mappingget
Delete a Scheduled Lambda mappingdelete
Create a Scheduled Lambda mappingpost
List Scheduled Lambdasget
Shared Lambdas
Execute a Public Query Lambdapost
Sources
Suspend source ingestpost
Resume source ingestpost
Update a collection sourceput
Retrieve sourceget
Delete Collection sourcedelete
Create a sourcepost
List sources in collectionget
Users
Update Userpost
Retrieve Userget
Delete Userdelete
Update Notification Preferencespost
Retrieve Notification Preferencesget
Retrieve Current Userget
Create Userpost
List Usersget
Views
Update Viewpost
Retrieve Viewget
Delete Viewdelete
Create Viewpost
List Views in Workspaceget
List Viewsget
Virtual Instances
Suspend Virtual Instancepost
Resume Virtual Instancepost
Execute SQL Query on a specific Virtual Instancepost
List Queriesget
Get Collection Commitpost
Get Collection Mountget
Unmount Collectiondelete
Mount Collectionspost
List Collection Mountsget
Update Virtual Instancepost
Retrieve Virtual Instanceget
Delete Virtual Instancedelete
Create Virtual Instancepost
List Virtual Instancesget
Workspaces
Retrieve Workspaceget
Delete Workspacedelete
Create Workspacepost
List Workspacesget

SQL Commands
All Commands
DESCRIBE
SELECT
INSERT INTO collection
INSERT INTO s3
CREATE
DROP

SQL Functions
All Functions
Data Types
Type Functions
Conditional Expressions
Array Functions
Object Functions
Window Functions
Window Functions
Over
Mathematical Functions
Statistical Functions
Trigonometric Functions
Operators
Log and Exponential Functions
Bitwise Functions
Basic Functions
Hash Functions
HMAC Functions
Hash Functions
Date And Time Functions
Valid Datetime Format Strings
Timestamp Functions
Time Functions
Interval Durations
Interval Constructors
Datetime Functions
Date Functions
Date and Time Types
Aggregate Functions
Mathematical Aggregations
Logical Aggregations
Histogram Map Aggregations
General Aggregations
String Functions
Regular Expression Functions
Encoding Functions
Basic Functions
Text Search Functions
Term Matcher Functions
Geographic Functions
User-Defined Functions
Known Limitations
Security
Tabular JavaScript UDFs
Data Types
Syntax
Vector Functions
Ranking Functions
Vector Distance Functions
Vector Operations
Special Functions

REST API
REST API
Aliases
Update Aliaspost
Retrieve Aliasget
Delete Aliasdelete
Create Aliaspost
List Aliases in Workspaceget
List Aliasesget
API Keys
Update API Key Statepost
Retrieve API Keyget
Delete API Keydelete
List API Keysget
Create API Keypost
Collections
Set Collection Stateput
Get Collection Commitpost
Update Collectionput
Retrieve Collectionget
Delete Collectiondelete
Create Collectionpost
List Collections in Workspaceget
List Collectionsget
Custom Roles
Update a Rolepost
Retrieve roleget
Delete a Roledelete
Create a Rolepost
List Rolesget
Deployment Settings
Update Deployment Settingsput
Retrieve Deployment Settingsget
Documents
Add Documentspost
Patch Documentspatch
Delete Documentsdelete
Integrations
Update Integrationput
Retrieve Integrationget
Delete Integrationdelete
Create Integrationpost
List Integrationsget
Organizations
Get Organizationget
Queries
Retrieve Query Results Pageget
Retrieve Queryget
Cancel Querydelete
Validate Querypost
Execute SQL Querypost
List Queriesget
Query Lambdas
Execute Query Lambda By Versionpost
Retrieve Query Lambda Versionget
Update Query Lambdapost
List Query Lambda Versionsget
Delete Query Lambda Versiondelete
Execute Query Lambda By Tagpost
Retrieve Query Lambda Tagget
Delete Query Lambda Tag Versiondelete
Create Query Lambda Tagpost
List Query Lambda Tagsget
Delete Query Lambdadelete
Create Query Lambdapost
List Query Lambdas in Workspaceget
List Query Lambdasget
Scheduled Lambdas
Update a Scheduled Lambda mappingpost
Retrieve a Scheduled Lambda mappingget
Delete a Scheduled Lambda mappingdelete
Create a Scheduled Lambda mappingpost
List Scheduled Lambdasget
Shared Lambdas
Execute a Public Query Lambdapost
Sources
Suspend source ingestpost
Resume source ingestpost
Update a collection sourceput
Retrieve sourceget
Delete Collection sourcedelete
Create a sourcepost
List sources in collectionget
Users
Update Userpost
Retrieve Userget
Delete Userdelete
Update Notification Preferencespost
Retrieve Notification Preferencesget
Retrieve Current Userget
Create Userpost
List Usersget
Views
Update Viewpost
Retrieve Viewget
Delete Viewdelete
Create Viewpost
List Views in Workspaceget
List Viewsget
Virtual Instances
Suspend Virtual Instancepost
Resume Virtual Instancepost
Execute SQL Query on a specific Virtual Instancepost
List Queriesget
Get Collection Commitpost
Get Collection Mountget
Unmount Collectiondelete
Mount Collectionspost
List Collection Mountsget
Update Virtual Instancepost
Retrieve Virtual Instanceget
Delete Virtual Instancedelete
Create Virtual Instancepost
List Virtual Instancesget
Workspaces
Retrieve Workspaceget
Delete Workspacedelete
Create Workspacepost
List Workspacesget

SQL Commands
All Commands
DESCRIBE
SELECT
INSERT INTO collection
INSERT INTO s3
CREATE
DROP

SQL Functions
All Functions
Data Types
Type Functions
Conditional Expressions
Array Functions
Object Functions
Window Functions
Window Functions
Over
Mathematical Functions
Statistical Functions
Trigonometric Functions
Operators
Log and Exponential Functions
Bitwise Functions
Basic Functions
Hash Functions
HMAC Functions
Hash Functions
Date And Time Functions
Valid Datetime Format Strings
Timestamp Functions
Time Functions
Interval Durations
Interval Constructors
Datetime Functions
Date Functions
Date and Time Types
Aggregate Functions
Mathematical Aggregations
Logical Aggregations
Histogram Map Aggregations
General Aggregations
String Functions
Regular Expression Functions
Encoding Functions
Basic Functions
Text Search Functions
Term Matcher Functions
Geographic Functions
User-Defined Functions
Known Limitations
Security
Tabular JavaScript UDFs
Data Types
Syntax
Vector Functions
Ranking Functions
Vector Distance Functions
Vector Operations
Special Functions

200API key successfully updated

400bad request

401unauthorized

403forbidden

404not found

405not allowed

406not acceptable

408request timeout

409conflict

415not supported

429resource exceeded

500internal error

501not implemented

502bad gateway

503not ready