LogoLogo
Start Trial
  • Overview
    • What is DeltaStream?
    • Core Concepts
      • Access Control
      • Compute Pools
      • Data Store
      • Database
      • Function
      • Query
      • SQL
      • Visualizing Data Lineage
  • Getting Started
    • Free Trial Quick Start
    • Starting with the Web App
    • Starting with the CLI
  • How do I...?
    • Create and Manage Data Stores
      • Create Data Stores for Streaming Data
      • Explore Data Store and Topic Details
      • Use Multiple Data Stores in Queries
    • Manage Users and User Roles
      • Inviting Users to an Organization
      • Administering Users in your Organization
      • Using the CLI to Manage User Roles
      • Example: Setting Up Custom Roles for Production and Stage
    • Create DeltaStream Objects to Structure Raw Data
    • Use Namespacing for Organizing Data
    • Create and Query Materialized Views
    • Create a Compute Pool to Work with Iceberg
    • Create a Function
    • Secure my Connection to a Data Store
      • Introducing DeltaStream Private Links
      • Creating an AWS Private Link from DeltaStream to your Confluent Kafka Dedicated Cluster
      • Enabling Private Link Connectivity to Confluent Enterprise Cluster and Schema Registry
      • Creating a Private Link from DeltaStream to Amazon MSK
      • Creating a Private Link for RDS Databases
      • Deleting a Private Link
    • Serialize my Data
      • Working with ProtoBuf Serialized Data and DeltaStream Descriptors
      • Working with Avro Serialized Data and Schema Registries
      • Configuring Deserialization Error Handling
  • Integrations
    • Setting up Data Store Integrations
      • AWS S3
      • ClickHouse
      • Confluent Cloud
      • Databricks
      • Iceberg REST Catalog
      • PostgreSQL
      • Snowflake
      • WarpStream
  • Setting up Enterprise Security Integrations
    • Okta SAML Integration
    • Okta SCIM Integration
  • use cases
    • Using an AWS S3 Store as a Source to Feed an MSK Topic
  • Reference
    • Metrics
      • Prometheus Integration
      • Built-In Metrics
      • Custom Metrics in Functions
    • SQL Syntax
      • Data Formats (Serialization)
        • Serializing with JSON
        • Serializing with Primitive Data Types
        • Serializing with Protobuf
      • Data Types
      • Identifiers and Keywords
      • Command
        • ACCEPT INVITATION
        • CAN I
        • COPY DESCRIPTOR_SOURCE
        • COPY FUNCTION_SOURCE
        • DESCRIBE ENTITY
        • DESCRIBE QUERY
        • DESCRIBE QUERY METRICS
        • DESCRIBE QUERY EVENTS
        • DESCRIBE QUERY STATE
        • DESCRIBE RELATION
        • DESCRIBE RELATION COLUMNS
        • DESCRIBE ROLE
        • DESCRIBE SECURITY INTEGRATION
        • DESCRIBE <statement>
        • DESCRIBE STORE
        • DESCRIBE USER
        • GENERATE COLUMNS
        • GENERATE TEMPLATE
        • GRANT OWNERSHIP
        • GRANT PRIVILEGES
        • GRANT ROLE
        • INVITE USER
        • LIST API_TOKENS
        • LIST COMPUTE_POOLS
        • LIST DATABASES
        • LIST DESCRIPTORS
        • LIST DESCRIPTOR_SOURCES
        • LIST ENTITIES
        • LIST FUNCTIONS
        • LIST FUNCTION_SOURCES
        • LIST INVITATIONS
        • LIST METRICS INTEGRATIONS
        • LIST ORGANIZATIONS
        • LIST QUERIES
        • LIST RELATIONS
        • LIST ROLES
        • LIST SCHEMAS
        • LIST SCHEMA_REGISTRIES
        • LIST SECRETS
        • LIST SECURITY INTEGRATIONS
        • LIST STORES
        • LIST USERS
        • PRINT ENTITY
        • REJECT INVITATION
        • REVOKE INVITATION
        • REVOKE PRIVILEGES
        • REVOKE ROLE
        • SET DEFAULT
        • USE
        • START COMPUTE_POOL
        • STOP COMPUTE_POOL
      • DDL
        • ALTER API_TOKEN
        • ALTER SECURITY INTEGRATION
        • CREATE API_TOKEN
        • CREATE CHANGELOG
        • CREATE COMPUTE_POOL
        • CREATE DATABASE
        • CREATE DESCRIPTOR_SOURCE
        • CREATE ENTITY
        • CREATE FUNCTION_SOURCE
        • CREATE FUNCTION
        • CREATE INDEX
        • CREATE METRICS INTEGRATION
        • CREATE ORGANIZATION
        • CREATE ROLE
        • CREATE SCHEMA_REGISTRY
        • CREATE SCHEMA
        • CREATE SECRET
        • CREATE SECURITY INTEGRATION
        • CREATE STORE
        • CREATE STREAM
        • CREATE TABLE
        • DROP API_TOKEN
        • DROP CHANGELOG
        • DROP COMPUTE_POOL
        • DROP DATABASE
        • DROP DESCRIPTOR_SOURCE
        • DROP ENTITY
        • DROP FUNCTION_SOURCE
        • DROP FUNCTION
        • DROP METRICS INTEGRATION
        • DROP RELATION
        • DROP ROLE
        • DROP SCHEMA
        • DROP SCHEMA_REGISTRY
        • DROP SECRET
        • DROP SECURITY INTEGRATION
        • DROP STORE
        • DROP STREAM
        • DROP USER
        • START/STOP COMPUTE_POOL
        • UPDATE COMPUTE_POOL
        • UPDATE ENTITY
        • UPDATE SCHEMA_REGISTRY
        • UPDATE SECRET
        • UPDATE STORE
      • Query
        • APPLICATION
        • Change Data Capture (CDC)
        • CREATE CHANGELOG AS SELECT
        • CREATE STREAM AS SELECT
        • CREATE TABLE AS SELECT
        • Function
          • Built-in Functions
          • Row Metadata Functions
        • INSERT INTO
        • Materialized View
          • CREATE MATERIALIZED VIEW AS
          • SELECT (FROM MATERIALIZED VIEW)
        • Query Name and Version
        • Resume Query
        • RESTART QUERY
        • SELECT
          • FROM
          • JOIN
          • MATCH_RECOGNIZE
          • WITH (Common Table Expression)
        • TERMINATE QUERY
      • Sandbox
        • START SANDBOX
        • DESCRIBE SANDBOX
        • STOP SANDBOX
      • Row Key Definition
    • DeltaStream OpenAPI
      • Deltastream
      • Models
Powered by GitBook
On this page
  1. Reference
  2. DeltaStream OpenAPI

Deltastream

PreviousDeltaStream OpenAPINextModels
get

Returns the server version

Authorizations
Responses
200
server version
application/json
403
Server cannot process the request due to invalid token.
application/json
500
Internal server error.
application/json
503
Service is temporarily unavailable
application/json
get
GET /v2/version HTTP/1.1
Host: api.deltastream.io
Authorization: Bearer JWT
Accept: */*
{
  "major": 1,
  "minor": 1,
  "patch": 1
}
get

Download a resource

Authorizations
Path parameters
resourceTypestring · enumRequiredPossible values:
organizationIDstring · uuidRequired
resourceNamestringRequired
Responses
200
Download file
application/octet-stream
Responsestring · bytes
400
Server cannot process the request due to a client error (malformed request syntax, invalid request message etc).
application/json
403
Server cannot process the request due to invalid token.
application/json
404
Requested REST endpoint is not valid.
application/json
408
Request execution was cancelled because it exceeded the timeout value
application/json
500
Internal server error.
application/json
503
Service is temporarily unavailable
application/json
get
GET /v2/download/{resourceType}/{organizationID}/{resourceName} HTTP/1.1
Host: api.deltastream.io
Authorization: Bearer JWT
Accept: */*
text
  • POST/statements
  • GET/statements/{statementID}
  • GET/version
  • GET/download/{resourceType}/{organizationID}/{resourceName}
get

Lookup the status of a statement.

Authorizations
Path parameters
statementIDstring · uuidRequired
Query parameters
sessionIDstringOptional
partitionIDinteger · int32Optional
timezonestringOptionalExample: America/New_York
Responses
200
Statement successfully executed.
application/json
202
Statement execution is in progress. Use GET /statements/{statementID} to poll for status.
application/json
400
Server cannot process the request due to a client error (malformed request syntax, invalid request message etc).
application/json
403
Server cannot process the request due to invalid token.
application/json
404
Requested REST endpoint is not valid.
application/json
408
Request execution was cancelled because it exceeded the timeout value
application/json
500
Internal server error.
application/json
503
Service is temporarily unavailable
application/json
get
GET /v2/statements/{statementID} HTTP/1.1
Host: api.deltastream.io
Authorization: Bearer JWT
Accept: */*
{
  "sqlState": "text",
  "message": "text",
  "statementID": "123e4567-e89b-12d3-a456-426614174000",
  "statementIDs": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "createdOn": 1,
  "metadata": {
    "encoding": "json",
    "partitionInfo": [
      {
        "rowCount": 1
      }
    ],
    "columns": [
      {
        "name": "text",
        "type": "text",
        "nullable": true,
        "display_hint": "text"
      }
    ],
    "dataplaneRequest": {
      "token": "text",
      "uri": "text",
      "statementID": "text",
      "queryID": "text",
      "requestType": "result-set"
    },
    "context": {
      "organizationID": "123e4567-e89b-12d3-a456-426614174000",
      "roleName": "text",
      "databaseName": "text",
      "schemaName": "text",
      "storeName": "text",
      "computePoolName": "text"
    }
  },
  "data": [
    [
      "text"
    ]
  ]
}
post

Submit one statement for execution.

Authorizations
Body
attachmentsstring · binary[]Optional
Responses
200
Statement successfully executed.
application/json
202
Statement execution is in progress. Use GET /statements/{statementID} to poll for status.
application/json
400
Server cannot process the request due to a client error (malformed request syntax, invalid request message etc).
application/json
403
Server cannot process the request due to invalid token.
application/json
404
Requested REST endpoint is not valid.
application/json
408
Request execution was cancelled because it exceeded the timeout value
application/json
500
Internal server error.
application/json
503
Service is temporarily unavailable
application/json
post
POST /v2/statements HTTP/1.1
Host: api.deltastream.io
Authorization: Bearer JWT
Content-Type: multipart/form-data
Accept: */*
Content-Length: 227

{
  "request": {
    "statement": "text",
    "organization": "text",
    "role": "text",
    "database": "text",
    "schema": "text",
    "store": "text",
    "computePool": "text",
    "parameters": {
      "timezone": "America/New_York",
      "sessionID": "text"
    }
  },
  "attachments": [
    "binary"
  ]
}
{
  "sqlState": "text",
  "message": "text",
  "statementID": "123e4567-e89b-12d3-a456-426614174000",
  "statementIDs": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "createdOn": 1,
  "metadata": {
    "encoding": "json",
    "partitionInfo": [
      {
        "rowCount": 1
      }
    ],
    "columns": [
      {
        "name": "text",
        "type": "text",
        "nullable": true,
        "display_hint": "text"
      }
    ],
    "dataplaneRequest": {
      "token": "text",
      "uri": "text",
      "statementID": "text",
      "queryID": "text",
      "requestType": "result-set"
    },
    "context": {
      "organizationID": "123e4567-e89b-12d3-a456-426614174000",
      "roleName": "text",
      "databaseName": "text",
      "schemaName": "text",
      "storeName": "text",
      "computePoolName": "text"
    }
  },
  "data": [
    [
      "text"
    ]
  ]
}