DeltaStream
Search
K

GraphQL API

DeltaStream GraphQL API

DeltaStream GraphQL API
API Endpoints
https://api.deltastream.io/query
Headers
Authorization: Bearer <YOUR_TOKEN_HERE>

Queries

apiTokens

Response
Returns [APIToken!]!
Arguments
Name
Description
organizationId
UUID!
Example
Query
query ApiTokens($organizationId: UUID!) {
apiTokens(organizationId: $organizationId) {
name
lastUsed
createdAt
}
}
Variables
{
"organizationId": "2c5d69e6-5348-4431-8496-252418e42515"
}
Response
{
"data": {
"apiTokens": [{"name": 4, "lastUsed": 1592577642, "createdAt": 1592577642}]
}
}

availabilityZones

Response
Example
Query
query AvailabilityZones {
availabilityZones {
name
longName
}
}
Response
{
"data": {
"availabilityZones": [
{
"name": "abc123",
"longName": "xyz789"
}
]
}
}

changelogs

Response
Returns [Relation!]!
Arguments
Name
Description
organizationId
UUID!
databaseName
ID!
schemaName
ID!
Example
Query
query Changelogs(
$organizationId: UUID!,
$databaseName: ID!,
$schemaName: ID!
) {
changelogs(
organizationId: $organizationId,
databaseName: $databaseName,
schemaName: $schemaName
) {
name
schema {
name
database {
...DatabaseFragment
}
relations {
...RelationFragment
}
relation {
...RelationFragment
}
createdAt
updatedAt
owner {
...RoleFragment
}
}
columns {
name
dataType
}
primaryKey
metadata {
value {
...MapEntryFragment
}
}
createdAt
updatedAt
owner {
organization {
...OrganizationFragment
}
name
enabled
inherit
createdAt
updatedAt
grantedRoles {
...RoleGrantFragment
}
grantedPrivileges {
...PrivilegeGrantFragment
}
}
}
}
Variables
{
"organizationId": "2c5d69e6-5348-4431-8496-252418e42515",
"databaseName": 4,
"schemaName": "4"
}
Response
{
"data": {
"changelogs": [
{
"name": "4",
"schema": Schema,
"columns": [Column],
"primaryKey": ["abc123"],
"metadata": Map,
"createdAt": 1592577642,
"updatedAt": 1592577642,
"owner": Role
}
]
}
}

connector

Response
Returns a Connector!
Arguments
Name
Description
name
String!
organizationId
UUID!
Example
Query
query Connector(
$name: String!,
$organizationId: UUID!
) {
connector(
name: $name,
organizationId: $organizationId
) {
name
type
sourceRelation {
name
schema {
...SchemaFragment
}
columns {
...ColumnFragment
}
primaryKey
metadata {
...MapFragment
}
createdAt
updatedAt
owner {
...RoleFragment
}
}
sinkStore {
name
type
uris
availabilityZone
organization {
...OrganizationFragment
}
metadata {
...MapFragment
}
additionalEgressURIs
enableSslEncryption
serverHostnameVerification
caCert
tlsProtocols
cipherSuites
topics {
...TopicFragment
}
topic {
...TopicFragment
}
schemaRegistry {
...SchemaRegistryFragment
}
createdAt
updatedAt
owner {
...RoleFragment
}
}
sender
destinations
template
createdAt
updatedAt
owner {
organization {
...OrganizationFragment
}
name
enabled
inherit
createdAt
updatedAt
grantedRoles {
...RoleGrantFragment
}
grantedPrivileges {
...PrivilegeGrantFragment
}
}
}
}
Variables
{
"name": "abc123",
"organizationId": "2c5d69e6-5348-4431-8496-252418e42515"
}
Response
{
"data": {
"connector": {
"name": "4",
"type": "Notification",
"sourceRelation": Relation,
"sinkStore": Store,
"sender": "xyz789",
"destinations": ["xyz789"],
"template": "xyz789",
"createdAt": 1592577642,
"updatedAt": 1592577642,
"owner": Role
}
}
}

connectors

Response
Returns [Connector!]!
Arguments
Name
Description
organizationId
UUID!
Example
Query
query Connectors($organizationId: UUID!) {
connectors(organizationId: $organizationId) {
name
type
sourceRelation {
name
schema {
...SchemaFragment
}
columns {
...ColumnFragment
}
primaryKey
metadata {
...MapFragment
}
createdAt
updatedAt
owner {
...RoleFragment
}
}
sinkStore {
name
type
uris
availabilityZone
organization {
...OrganizationFragment
}
metadata {
...MapFragment
}
additionalEgressURIs
enableSslEncryption
serverHostnameVerification
caCert
tlsProtocols
cipherSuites
topics {
...TopicFragment
}
topic {
...TopicFragment
}
schemaRegistry {
...SchemaRegistryFragment
}
createdAt
updatedAt
owner {
...RoleFragment
}
}
sender
destinations
template
createdAt
updatedAt
owner {
organization {
...OrganizationFragment
}
name
enabled
inherit
createdAt
updatedAt
grantedRoles {
...RoleGrantFragment
}
grantedPrivileges {
...PrivilegeGrantFragment
}
}
}
}
Variables
{
"organizationId": "2c5d69e6-5348-4431-8496-252418e42515"
}
Response
{
"data": {
"connectors": [
{
"name": 4,
"type": "Notification",
"sourceRelation": Relation,
"sinkStore": Store,
"sender": "abc123",
"destinations": ["abc123"],
"template": "xyz789",
"createdAt": 1592577642,
"updatedAt": 1592577642,
"owner": Role
}
]
}
}

descriptorSource

Response
Returns a DescriptorSource!
Arguments
Name
Description
name
String!
orgID
UUID!
Example
Query
query DescriptorSource(
$name: String!,
$orgID: UUID!
) {
descriptorSource(
name: $name,
orgID: $orgID
) {
name
tags
type
org {
connectors {
...ConnectorFragment
}
invitations {
...InvitationFragment
}
id
name
description
profileImage
createdAt
updatedAt
owner {
...RoleFragment
}
members {
...MemberFragment
}
member {
...MemberFragment
}
database {
...DatabaseFragment
}
databases {
...DatabaseFragment
}
defaultDatabase {
...DatabaseFragment
}
schemaRegistries {
...SchemaRegistryFragment
}
query {
...QueryFragment
}
queries {
...QueryFragment
}
topicDescriptor {
...TopicDescriptorFragment
}
topicDescriptors {
...TopicDescriptorFragment
}
sandbox {
...SandboxFragment
}
role {
...RoleFragment
}
roles {
...RoleFragment
}
defaultRole {
...RoleFragment
}
store {
...StoreFragment
}
stores {
...StoreFragment
}
defaultStore {
...StoreFragment
}
}
descriptors {
id
name
source {
...DescriptorSourceFragment
}
}
url
createdAt
updatedAt
owner {
organization {
...OrganizationFragment
}
name
enabled
inherit
createdAt
updatedAt
grantedRoles {
...RoleGrantFragment
}
grantedPrivileges {
...PrivilegeGrantFragment
}
}
}
}
Variables
{
"name": "abc123",
"orgID": "2c5d69e6-5348-4431-8496-252418e42515"
}
Response
{
"data": {
"descriptorSource": {
"name": "abc123",
"tags": ["abc123"],
"type": "PB_DESCRIPTOR",
"org": Organization,
"descriptors": [Descriptor],
"url": "abc123",
"createdAt": 1592577642,
"updatedAt": 1592577642,
"owner": Role
}
}
}

descriptorSources

Response
Arguments
Name
Description
orgID
UUID!
Example
Query
query DescriptorSources($orgID: UUID!) {
descriptorSources(orgID: $orgID) {
name
tags
type
org {
connectors {
...ConnectorFragment
}
invitations {
...InvitationFragment
}
id
name
description
profileImage
createdAt
updatedAt
owner {
...RoleFragment
}
members {
...MemberFragment
}
member {
...MemberFragment
}
database {
...DatabaseFragment
}
databases {
...DatabaseFragment
}
defaultDatabase {
...DatabaseFragment
}
schemaRegistries {
...SchemaRegistryFragment
}
query {
...QueryFragment
}
queries {
...QueryFragment
}
topicDescriptor {
...TopicDescriptorFragment
}
topicDescriptors {
...TopicDescriptorFragment
}
sandbox {
...SandboxFragment
}
role {
...RoleFragment
}
roles {
...RoleFragment
}
defaultRole {
...RoleFragment
}
store {
...StoreFragment
}
stores {
...StoreFragment
}
defaultStore {
...StoreFragment
}
}
descriptors {
id
name
source {
...DescriptorSourceFragment
}
}
url
createdAt
updatedAt
owner {
organization {
...OrganizationFragment
}
name
enabled
inherit
createdAt
updatedAt
grantedRoles {
...RoleGrantFragment
}
grantedPrivileges {
...PrivilegeGrantFragment
}
}
}
}
Variables
{
"orgID": "2c5d69e6-5348-4431-8496-252418e42515"
}
Response
{
"data": {
"descriptorSources": [
{
"name": "xyz789",
"tags": ["abc123"],
"type": "PB_DESCRIPTOR",
"org": Organization,
"descriptors": [Descriptor],
"url": "abc123",
"createdAt": 1592577642,
"updatedAt": 1592577642,
"owner": Role
}
]
}
}

functionSource

Response
Returns a FunctionSource!
Arguments
Name
Description
name
String!
orgID
UUID!
Example
Query
query FunctionSource(
$name: String!,
$orgID: UUID!
) {
functionSource(
name: $name,
orgID: $orgID
) {
name
description
url
createdAt
updatedAt
owner {
organization {
...OrganizationFragment
}
name
enabled
inherit
createdAt
updatedAt
grantedRoles {
...RoleGrantFragment
}
grantedPrivileges {
...PrivilegeGrantFragment
}
}
}
}
Variables
{
"name": "xyz789",
"orgID": "2c5d69e6-5348-4431-8496-252418e42515"
}
Response
{
"data": {
"functionSource": {
"name": "xyz789",
"description": "xyz789",
"url": "abc123",
"createdAt": 1592577642,
"updatedAt": 1592577642,
"owner": Role
}
}
}

functionSources

Response
Arguments
Name
Description
orgID
UUID!
Example
Query
query FunctionSources($orgID: UUID!) {
functionSources(orgID: $orgID) {
name
description
url
createdAt
updatedAt
owner {
organization {
...OrganizationFragment
}
name
enabled
inherit
createdAt
updatedAt
grantedRoles {
...RoleGrantFragment
}
grantedPrivileges {
...PrivilegeGrantFragment
}
}
}
}
Variables
{
"orgID": "2c5d69e6-5348-4431-8496-252418e42515"
}
Response
{
"data": {
"functionSources": [
{
"name": "xyz789",
"description": "abc123",
"url": "xyz789",
"createdAt": 1592577642,
"updatedAt": 1592577642,
"owner": Role
}
]
}
}

functions

Response
Returns [Function!]!
Arguments
Name
Description
orgID
UUID!
Example
Query
query Functions($orgID: UUID!) {
functions(orgID: $orgID) {
org {
connectors {
...ConnectorFragment
}
invitations {
...InvitationFragment
}
id
name
description
profileImage
createdAt
updatedAt
owner {
...RoleFragment
}
members {
...MemberFragment
}
member {
...MemberFragment
}
database {
...DatabaseFragment
}
databases {
...DatabaseFragment
}
defaultDatabase {
...DatabaseFragment
}
schemaRegistries {
...SchemaRegistryFragment
}
query {
...QueryFragment
}
queries {
...QueryFragment
}
topicDescriptor {
...TopicDescriptorFragment
}
topicDescriptors {
...TopicDescriptorFragment
}
sandbox {
...SandboxFragment
}
role {
...RoleFragment
}
roles {
...RoleFragment
}
defaultRole {
...RoleFragment
}
store {
...StoreFragment
}
stores {
...StoreFragment
}
defaultStore {
...StoreFragment
}
}
name
type
inputs {
name
type
}
outputType
source {
name
description
url
createdAt
updatedAt
owner {
...RoleFragment
}
}
className
signature
createdAt
updatedAt
owner {
organization {
...OrganizationFragment
}
name
enabled
inherit
createdAt
updatedAt
grantedRoles {
...RoleGrantFragment
}
grantedPrivileges {
...PrivilegeGrantFragment
}
}
}
}
Variables
{
"orgID": "2c5d69e6-5348-4431-8496-252418e42515"
}
Response
{
"data": {
"functions": [
{
"org": Organization,
"name": "abc123",
"type": "UDF",
"inputs": [Parameter],
"outputType": "abc123",
"source": FunctionSource,
"className": "xyz789",
"signature": "xyz789",
"createdAt": 1592577642,
"updatedAt": 1592577642,
"owner": Role
}
]
}
}

invitations

Response
Returns