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

Returns [AvailabilityZone!]!

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

Returns [DescriptorSource!]!

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

Returns [FunctionSource!]!

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 [Invitation!]!

Arguments

Name	Description
organizationId	UUID!
state	InvitationState!

Example

Query

query Invitations(
  $organizationId: UUID!,
  $state: InvitationState!
) {
  invitations(
    organizationId: $organizationId,
    state: $state
  ) {
    organization {
      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
      }
    }
    id
    invitedUserEmail
    invitedBy {
      organization {
        ...OrganizationFragment
      }
      name
      enabled
      inherit
      createdAt
      updatedAt
      grantedRoles {
        ...RoleGrantFragment
      }
      grantedPrivileges {
        ...PrivilegeGrantFragment
      }
    }
    userRole {
      organization {
        ...OrganizationFragment
      }
      name
      enabled
      inherit
      createdAt
      updatedAt
      grantedRoles {
        ...RoleGrantFragment
      }
      grantedPrivileges {
        ...PrivilegeGrantFragment
      }
    }
    defaultRole {
      organization {
        ...OrganizationFragment
      }
      name
      enabled
      inherit
      createdAt
      updatedAt
      grantedRoles {
        ...RoleGrantFragment
      }
      grantedPrivileges {
        ...PrivilegeGrantFragment
      }
    }
    additionalRoles {
      organization {
        ...OrganizationFragment
      }
      name
      enabled
      inherit
      createdAt
      updatedAt
      grantedRoles {
        ...RoleGrantFragment
      }
      grantedPrivileges {
        ...PrivilegeGrantFragment
      }
    }
    invitationState
  }
}

Variables

{
  "organizationId": "2c5d69e6-5348-4431-8496-252418e42515",
  "state": "PENDING"
}

Response

{
  "data": {
    "invitations": [
      {
        "organization": Organization,
        "id": "2c5d69e6-5348-4431-8496-252418e42515",
        "invitedUserEmail": "xyz789",
        "invitedBy": Role,
        "userRole": Role,
        "defaultRole": Role,
        "additionalRoles": [Role],
        "invitationState": "PENDING"
      }
    ]
  }
}

materializedViews

Response

Returns [Relation!]!

Arguments

Name	Description
organizationId	UUID!
databaseName	ID!
schemaName	ID!

Example

Query

query MaterializedViews(
  $organizationId: UUID!,
  $databaseName: ID!,
  $schemaName: ID!
) {
  materializedViews(
    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": {
    "materializedViews": [
      {
        "name": "4",
        "schema": Schema,
        "columns": [Column],
        "primaryKey": ["xyz789"],
        "metadata": Map,
        "createdAt": 1592577642,
        "updatedAt": 1592577642,
        "owner": Role
      }
    ]
  }
}

me

Example

Query

query Me {
  me {
    id
    givenName
    familyName
    email
    profileImage
    licenseAccepted
    licenseId
    locale
    defaultOrganization {
      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
      }
    }
    organizations {
      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
      }
    }
    createdAt
    updatedAt
  }
}

Response

{
  "data": {
    "me": {
      "id": "xyz789",
      "givenName": "xyz789",
      "familyName": "xyz789",
      "email": "xyz789",
      "profileImage": "xyz789",
      "licenseAccepted": true,
      "licenseId": "abc123",
      "locale": "xyz789",
      "defaultOrganization": Organization,
      "organizations": [Organization],
      "createdAt": 1592577642,
      "updatedAt": 1592577642
    }
  }
}

myInvitations

Response

Returns [UserInvitation!]!

Example

Query

query MyInvitations {
  myInvitations {
    organizationID
    organizationName
    id
    invitationState
  }
}

Response

{
  "data": {
    "myInvitations": [
      {
        "organizationID": "2c5d69e6-5348-4431-8496-252418e42515",
        "organizationName": "xyz789",
        "id": "2c5d69e6-5348-4431-8496-252418e42515",
        "invitationState": "PENDING"
      }
    ]
  }
}

organization

Response

Returns an Organization

Arguments

Name	Description
id	UUID!

Example

Query

query Organization($id: UUID!) {
  organization(id: $id) {
    connectors {
      name
      type
      sourceRelation {
        ...RelationFragment
      }
      sinkStore {
        ...StoreFragment
      }
      sender
      destinations
      template
      createdAt
      updatedAt
      owner {
        ...RoleFragment
      }
    }
    invitations {
      organization {
        ...OrganizationFragment
      }
      id
      invitedUserEmail
      invitedBy {
        ...RoleFragment
      }
      userRole {
        ...RoleFragment
      }
      defaultRole {
        ...RoleFragment
      }
      additionalRoles {
        ...RoleFragment
      }
      invitationState
    }
    id
    name
    description
    profileImage
    createdAt
    updatedAt
    owner {
      organization {
        ...OrganizationFragment
      }
      name
      enabled
      inherit
      createdAt
      updatedAt
      grantedRoles {
        ...RoleGrantFragment
      }
      grantedPrivileges {
        ...PrivilegeGrantFragment
      }
    }
    members {
      user {
        ...UserFragment
      }
      roles {
        ...RoleGrantFragment
      }
      defaultRole {
        ...RoleFragment
      }
      createdAt
      updatedAt
    }
    member {
      user {
        ...UserFragment
      }
      roles {
        ...RoleGrantFragment
      }
      defaultRole {
        ...RoleFragment
      }
      createdAt
      updatedAt
    }
    database {
      name
      org {
        ...OrganizationFragment
      }
      schema {
        ...SchemaFragment
      }
      schemas {
        ...SchemaFragment
      }
      defaultSchema {
        ...SchemaFragment
      }
      createdAt
      updatedAt
      owner {
        ...RoleFragment
      }
    }
    databases {
      name
      org {
        ...OrganizationFragment
      }
      schema {
        ...SchemaFragment
      }
      schemas {
        ...SchemaFragment
      }
      defaultSchema {
        ...SchemaFragment
      }
      createdAt
      updatedAt
      owner {
        ...RoleFragment
      }
    }
    defaultDatabase {
      name
      org {
        ...OrganizationFragment
      }
      schema {
        ...SchemaFragment
      }
      schemas {
        ...SchemaFragment
      }
      defaultSchema {
        ...SchemaFragment
      }
      createdAt
      updatedAt
      owner {
        ...RoleFragment
      }
    }
    schemaRegistries {
      name
      uris
      type
      createdAt
      updatedAt
      owner {
        ...RoleFragment
      }
    }
    query {
      id
      organization {
        ...OrganizationFragment
      }
      sources {
        ...RelationFragment
      }
      sinks {
        ...RelationFragment
      }
      dsql
      intendedState
      actualState
      errorMessages
      createdAt
      updatedAt
      owner {
        ...RoleFragment
      }
    }
    queries {
      id
      organization {
        ...OrganizationFragment
      }
      sources {
        ...RelationFragment
      }
      sinks {
        ...RelationFragment
      }
      dsql
      intendedState
      actualState
      errorMessages
      createdAt
      updatedAt
      owner {
        ...RoleFragment
      }
    }
    topicDescriptor {
      id
      keyDescriptor {
        ...DescriptorFragment
      }
      valueDescriptor {
        ...DescriptorFragment
      }
      topicName
      storeName
      org {
        ...OrganizationFragment
      }
    }
    topicDescriptors {
      id
      keyDescriptor {
        ...DescriptorFragment
      }
      valueDescriptor {
        ...DescriptorFragment
      }
      topicName
      storeName
      org {
        ...OrganizationFragment
      }
    }
    sandbox {
      id
      status
      functionSources {
        ...FunctionSourceFragment
      }
      errorMessages
      availabilityZone
      createdAt
      updatedAt
      owner {
        ...RoleFragment
      }
    }
    role {
      organization {
        ...OrganizationFragment
      }
      name
      enabled
      inherit
      createdAt
      updatedAt
      grantedRoles {
        ...RoleGrantFragment
      }
      grantedPrivileges {
        ...PrivilegeGrantFragment
      }
    }
    roles {
      organization {
        ...OrganizationFragment
      }
      name
      enabled
      inherit
      createdAt
      updatedAt
      grantedRoles {
        ...RoleGrantFragment
      }
      grantedPrivileges {
        ...PrivilegeGrantFragment
      }
    }
    defaultRole {
      organization {
        ...OrganizationFragment
      }
      name
      enabled
      inherit
      createdAt
      updatedAt
      grantedRoles {
        ...RoleGrantFragment
      }
      grantedPrivileges {
        ...PrivilegeGrantFragment
      }
    }
    store {
      name
      type
      uris
      availabilityZone
      organization {
        ...OrganizationFragment
      }
      metadata {
        ...MapFragment
      }
      additionalEgressURIs
      enableSslEncryption
      serverHostnameVerification
      caCert
      tlsProtocols
      cipherSuites
      topics {
        ...TopicFragment
      }
      topic {
        ...TopicFragment
      }
      schemaRegistry {
        ...SchemaRegistryFragment
      }
      createdAt
      updatedAt
      owner {
        ...RoleFragment
      }
    }
    stores {
      name
      type
      uris
      availabilityZone
      organization {
        ...OrganizationFragment
      }
      metadata {
        ...MapFragment
      }
      additionalEgressURIs
      enableSslEncryption
      serverHostnameVerification
      caCert
      tlsProtocols
      cipherSuites
      topics {
        ...TopicFragment
      }
      topic {
        ...TopicFragment
      }
      schemaRegistry {
        ...SchemaRegistryFragment
      }
      createdAt
      updatedAt
      owner {
        ...RoleFragment
      }
    }
    defaultStore {
      name
      type
      uris
      availabilityZone
      organization {
        ...OrganizationFragment
      }
      metadata {
        ...MapFragment
      }
      additionalEgressURIs
      enableSslEncryption
      serverHostnameVerification
      caCert
      tlsProtocols
      cipherSuites
      topics {
        ...TopicFragment
      }
      topic {
        ...TopicFragment
      }
      schemaRegistry {
        ...SchemaRegistryFragment
      }
      createdAt
      updatedAt
      owner {
        ...RoleFragment
      }
    }
  }
}

Variables

{
  "id": "2c5d69e6-5348-4431-8496-252418e42515"
}

Response

{
  "data": {
    "organization": {
      "connectors": [Connector],
      "invitations": [Invitation],
      "id": "2c5d69e6-5348-4431-8496-252418e42515",
      "name": "xyz789",
      "description": "abc123",
      "profileImage": "abc123",
      "createdAt": 1592577642,
      "updatedAt": 1592577642,
      "owner": Role,
      "members": [Member],
      "member": Member,
      "database": Database,
      "databases": [Database],
      "defaultDatabase": Database,
      "schemaRegistries": [SchemaRegistry],
      "query": Query,
      "queries": [Query],
      "topicDescriptor": TopicDescriptor,
      "topicDescriptors": [TopicDescriptor],
      "sandbox": Sandbox,
      "role": Role,
      "roles": [Role],
      "defaultRole": Role,
      "store": Store,
      "stores": [Store],
      "defaultStore": Store
    }
  }
}

organizationMember

Response

Returns a Member

Arguments

Name	Description
organizationId	UUID!

Example

Query

query OrganizationMember($organizationId: UUID!) {
  organizationMember(organizationId: $organizationId) {
    user {
      id
      givenName
      familyName
      email
      profileImage
      licenseAccepted
      licenseId
      locale
      defaultOrganization {
        ...OrganizationFragment
      }
      organizations {
        ...OrganizationFragment
      }
      createdAt
      updatedAt
    }
    roles {
      name
      isEnabled
      isInherited
      role {
        ...RoleFragment
      }
      createdAt
      updatedAt
    }
    defaultRole {
      organization {
        ...OrganizationFragment
      }
      name
      enabled
      inherit
      createdAt
      updatedAt
      grantedRoles {
        ...RoleGrantFragment
      }
      grantedPrivileges {
        ...PrivilegeGrantFragment
      }
    }
    createdAt
    updatedAt
  }
}

Variables

{
  "organizationId": "2c5d69e6-5348-4431-8496-252418e42515"
}

Response

{
  "data": {
    "organizationMember": {
      "user": User,
      "roles": [RoleGrant],
      "defaultRole": Role,
      "createdAt": 1592577642,
      "updatedAt": 1592577642
    }
  }
}

organizations

Response

Returns [Organization!]!

Example

Query

query Organizations {
  organizations {
    connectors {
      name
      type
      sourceRelation {
        ...RelationFragment
      }
      sinkStore {
        ...StoreFragment
      }
      sender
      destinations
      template
      createdAt
      updatedAt
      owner {
        ...RoleFragment
      }
    }
    invitations {
      organization {
        ...OrganizationFragment
      }
      id
      invitedUserEmail
      invitedBy {
        ...RoleFragment
      }
      userRole {
        ...RoleFragment
      }
      defaultRole {
        ...RoleFragment
      }
      additionalRoles {
        ...RoleFragment
      }
      invitationState
    }
    id
    name
    description
    profileImage
    createdAt
    updatedAt
    owner {
      organization {
        ...OrganizationFragment
      }
      name
      enabled
      inherit
      createdAt
      updatedAt
      grantedRoles {
        ...RoleGrantFragment
      }
      grantedPrivileges {
        ...PrivilegeGrantFragment
      }
    }
    members {
      user {
        ...UserFragment
      }
      roles {
        ...RoleGrantFragment
      }
      defaultRole {
        ...RoleFragment
      }
      createdAt
      updatedAt
    }
    member {
      user {
        ...UserFragment
      }
      roles {
        ...RoleGrantFragment
      }
      defaultRole {
        ...RoleFragment
      }
      createdAt
      updatedAt
    }
    database {
      name
      org {
        ...OrganizationFragment
      }
      schema {
        ...SchemaFragment
      }
      schemas {
        ...SchemaFragment
      }
      defaultSchema {
        ...SchemaFragment
      }
      createdAt
      updatedAt
      owner {
        ...RoleFragment
      }
    }
    databases {
      name
      org {
        ...OrganizationFragment
      }
      schema {
        ...SchemaFragment
      }
      schemas {
        ...SchemaFragment
      }
      defaultSchema {
        ...SchemaFragment
      }
      createdAt
      updatedAt
      owner {
        ...RoleFragment
      }
    }
    defaultDatabase {
      name
      org {
        ...OrganizationFragment
      }
      schema {
        ...SchemaFragment
      }
      schemas {
        ...SchemaFragment
      }
      defaultSchema {
        ...SchemaFragment
      }
      createdAt
      updatedAt
      owner {
        ...RoleFragment
      }
    }
    schemaRegistries {
      name
      uris
      type
      createdAt
      updatedAt
      owner {
        ...RoleFragment
      }
    }
    query {
      id
      organization {
        ...OrganizationFragment
      }
      sources {
        ...RelationFragment
      }
      sinks {
        ...RelationFragment
      }
      dsql
      intendedState
      actualState
      errorMessages
      createdAt
      updatedAt
      owner {
        ...RoleFragment
      }
    }
    queries {
      id
      organization {
        ...OrganizationFragment
      }
      sources {
        ...RelationFragment
      }
      sinks {
        ...RelationFragment
      }
      dsql
      intendedState
      actualState
      errorMessages
      createdAt
      updatedAt
      owner {
        ...RoleFragment
      }
    }
    topicDescriptor {
      id
      keyDescriptor {
        ...DescriptorFragment
      }
      valueDescriptor {
        ...DescriptorFragment
      }
      topicName
      storeName
      org {
        ...OrganizationFragment
      }
    }
    topicDescriptors {
      id
      keyDescriptor {
        ...DescriptorFragment
      }
      valueDescriptor {
        ...DescriptorFragment
      }
      topicName
      storeName
      org {
        ...OrganizationFragment
      }
    }
    sandbox {
      id
      status
      functionSources {
        ...FunctionSourceFragment
      }
      errorMessages
      availabilityZone
      createdAt
      updatedAt
      owner {
        ...RoleFragment
      }
    }
    role {
      organization {
        ...OrganizationFragment
      }
      name
      enabled
      inherit
      createdAt
      updatedAt
      grantedRoles {
        ...RoleGrantFragment
      }
      grantedPrivileges {
        ...PrivilegeGrantFragment
      }
    }
    roles {
      organization {
        ...OrganizationFragment
      }
      name
      enabled
      inherit
      createdAt
      updatedAt
      grantedRoles {
        ...RoleGrantFragment
      }
      grantedPrivileges {
        ...PrivilegeGrantFragment
      }
    }
    defaultRole {
      organization {
        ...OrganizationFragment
      }
      name
      enabled
      inherit
      createdAt
      updatedAt
      grantedRoles {
        ...RoleGrantFragment
      }
      grantedPrivileges {
        ...PrivilegeGrantFragment
      }
    }
    store {
      name
      type
      uris
      availabilityZone
      organization {
        ...OrganizationFragment
      }
      metadata {
        ...MapFragment
      }
      additionalEgressURIs
      enableSslEncryption
      serverHostnameVerification
      caCert
      tlsProtocols
      cipherSuites
      topics {
        ...TopicFragment
      }
      topic {
        ...TopicFragment
      }
      schemaRegistry {
        ...SchemaRegistryFragment
      }
      createdAt
      updatedAt
      owner {
        ...RoleFragment
      }
    }
    stores {
      name
      type
      uris
      availabilityZone
      organization {
        ...OrganizationFragment
      }
      metadata {
        ...MapFragment
      }
      additionalEgressURIs
      enableSslEncryption
      serverHostnameVerification
      caCert
      tlsProtocols
      cipherSuites
      topics {
        ...TopicFragment
      }
      topic {
        ...TopicFragment
      }
      schemaRegistry {
        ...SchemaRegistryFragment
      }
      createdAt
      updatedAt
      owner {
        ...RoleFragment
      }
    }
    defaultStore {
      name
      type
      uris
      availabilityZone
      organization {
        ...OrganizationFragment
      }
      metadata {
        ...MapFragment
      }
      additionalEgressURIs
      enableSslEncryption
      serverHostnameVerification
      caCert
      tlsProtocols
      cipherSuites
      topics {
        ...TopicFragment
      }
      topic {
        ...TopicFragment
      }
      schemaRegistry {
        ...SchemaRegistryFragment
      }
      createdAt
      updatedAt
      owner {
        ...RoleFragment
      }
    }
  }
}

Response

{
  "data": {
    "organizations": [
      {
        "connectors": [Connector],
        "invitations": [Invitation],
        "id": "2c5d69e6-5348-4431-8496-252418e42515",
        "name": "xyz789",
        "description": "abc123",
        "profileImage": "abc123",
        "createdAt": 1592577642,
        "updatedAt": 1592577642,
        "owner": Role,
        "members": [Member],
        "member": Member,
        "database": Database,
        "databases": [Database],
        "defaultDatabase": Database,
        "schemaRegistries": [SchemaRegistry],
        "query": Query,
        "queries": [Query],
        "topicDescriptor": TopicDescriptor,
        "topicDescriptors": [TopicDescriptor],
        "sandbox": Sandbox,
        "role": Role,
        "roles": [Role],
        "defaultRole": Role,
        "store": Store,
        "stores": [Store],
        "defaultStore": Store
      }
    ]
  }
}

queries

Response

Returns [Query]!

Arguments

Name	Description
organizationId	UUID!

Example

Query

query Queries($organizationId: UUID!) {
  queries(organizationId: $organizationId) {
    id
    organization {
      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
      }
    }
    sources {
      name
      schema {
        ...SchemaFragment
      }
      columns {
        ...ColumnFragment
      }
      primaryKey
      metadata {
        ...MapFragment
      }
      createdAt
      updatedAt
      owner {
        ...RoleFragment
      }
    }
    sinks {
      name
      schema {
        ...SchemaFragment
      }
      columns {
        ...ColumnFragment
      }
      primaryKey
      metadata {
        ...MapFragment
      }
      createdAt
      updatedAt
      owner {
        ...RoleFragment
      }
    }
    dsql
    intendedState
    actualState
    errorMessages
    createdAt
    updatedAt
    owner {
      organization {
        ...OrganizationFragment
      }
      name
      enabled
      inherit
      createdAt
      updatedAt
      grantedRoles {
        ...RoleGrantFragment
      }
      grantedPrivileges {
        ...PrivilegeGrantFragment
      }
    }
  }
}

Variables

{
  "organizationId": "2c5d69e6-5348-4431-8496-252418e42515"
}

Response

{
  "data": {
    "queries": [
      {
        "id": "2c5d69e6-5348-4431-8496-252418e42515",
        "organization": Organization,
        "sources": [Relation],
        "sinks": [Relation],
        "dsql": "xyz789",
        "intendedState": "NEW",
        "actualState": "NEW",
        "errorMessages": ["xyz789"],
        "createdAt": 1592577642,
        "updatedAt": 1592577642,
        "owner": Role
      }
    ]
  }
}

query

Response

Returns a Query!

Arguments

Name	Description
id	UUID!
organizationId	UUID!

Example

Query

query Query(
  $id: UUID!,
  $organizationId: UUID!
) {
  query(
    id: $id,
    organizationId: $organizationId
  ) {
    id
    organization {
      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
      }
    }
    sources {
      name
      schema {
        ...SchemaFragment
      }
      columns {
        ...ColumnFragment
      }
      primaryKey
      metadata {
        ...MapFragment
      }
      createdAt
      updatedAt
      owner {
        ...RoleFragment
      }
    }
    sinks {
      name
      schema {
        ...SchemaFragment
      }
      columns {
        ...ColumnFragment
      }
      primaryKey
      metadata {
        ...MapFragment
      }
      createdAt
      updatedAt
      owner {
        ...RoleFragment
      }
    }
    dsql
    intendedState
    actualState
    errorMessages
    createdAt
    updatedAt
    owner {
      organization {
        ...OrganizationFragment
      }
      name
      enabled
      inherit
      createdAt
      updatedAt
      grantedRoles {
        ...RoleGrantFragment
      }
      grantedPrivileges {
        ...PrivilegeGrantFragment
      }
    }
  }
}

Variables

{
  "id": "2c5d69e6-5348-4431-8496-252418e42515",
  "organizationId": "2c5d69e6-5348-4431-8496-252418e42515"
}

Response

{
  "data": {
    "query": {
      "id": "2c5d69e6-5348-4431-8496-252418e42515",
      "organization": Organization,
      "sources": [Relation],
      "sinks": [Relation],
      "dsql": "abc123",
      "intendedState": "NEW",
      "actualState": "NEW",
      "errorMessages": ["xyz789"],
      "createdAt": 1592577642,
      "updatedAt": 1592577642,
      "owner": Role
    }
  }
}

relation

Response

Returns a Relation!

Arguments

Name	Description
name	ID!
organizationId	UUID!
databaseName	ID!
schemaName	ID!

Example

Query

query Relation(
  $name: ID!,
  $organizationId: UUID!,
  $databaseName: ID!,
  $schemaName: ID!
) {
  relation(
    name: $name,
    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

{
  "name": "4",
  "organizationId": "2c5d69e6-5348-4431-8496-252418e42515",
  "databaseName": "4",
  "schemaName": "4"
}

Response

{
  "data": {
    "relation": {
      "name": "4",
      "schema": Schema,
      "columns": [Column],
      "primaryKey": ["abc123"],
      "metadata": Map,
      "createdAt": 1592577642,
      "updatedAt": 1592577642,
      "owner": Role
    }
  }
}

relations

Response

Returns [Relation!]!

Arguments

Name	Description
organizationId	UUID!
databaseName	ID!
schemaName	ID!

Example

Query

query Relations(
  $organizationId: UUID!,
  $databaseName: ID!,
  $schemaName: ID!
) {
  relations(
    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": {
    "relations": [
      {
        "name": 4,
        "schema": Schema,
        "columns": [Column],
        "primaryKey": ["xyz789"],
        "metadata": Map,
        "createdAt": 1592577642,
        "updatedAt": 1592577642,
        "owner": Role
      }
    ]
  }
}

role

Arguments

Name	Description
organizationId	UUID!
name	String

Example

Query

query Role(
  $organizationId: UUID!,
  $name: String
) {
  role(
    organizationId: $organizationId,
    name: $name
  ) {
    organization {
      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
    enabled
    inherit
    createdAt
    updatedAt
    grantedRoles {
      name
      isEnabled
      isInherited
      role {
        ...RoleFragment
      }
      createdAt
      updatedAt
    }
    grantedPrivileges {
      privilegeTarget
      privilegeType
      targetID
    }
  }
}

Variables

{
  "organizationId": "2c5d69e6-5348-4431-8496-252418e42515",
  "name": "xyz789"
}

Response

{
  "data": {
    "role": {
      "organization": Organization,
      "name": "xyz789",
      "enabled": true,
      "inherit": false,
      "createdAt": 1592577642,
      "updatedAt": 1592577642,
      "grantedRoles": [RoleGrant],
      "grantedPrivileges": [PrivilegeGrant]
    }
  }
}

roles

Response

Returns [Role!]!

Arguments

Name	Description
organizationId	UUID!

Example

Query

query Roles($organizationId: UUID!) {
  roles(organizationId: $organizationId) {
    organization {
      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
    enabled
    inherit
    createdAt
    updatedAt
    grantedRoles {
      name
      isEnabled
      isInherited
      role {
        ...RoleFragment
      }
      createdAt
      updatedAt
    }
    grantedPrivileges {
      privilegeTarget
      privilegeType
      targetID
    }
  }
}

Variables

{
  "organizationId": "2c5d69e6-5348-4431-8496-252418e42515"
}

Response

{
  "data": {
    "roles": [
      {
        "organization": Organization,
        "name": "abc123",
        "enabled": false,
        "inherit": true,
        "createdAt": 1592577642,
        "updatedAt": 1592577642,
        "grantedRoles": [RoleGrant],
        "grantedPrivileges": [PrivilegeGrant]
      }
    ]
  }
}

schemaRegistries

Response

Returns [SchemaRegistry!]!

Arguments

Name	Description
organizationId	ID!

Example

Query

query SchemaRegistries($organizationId: ID!) {
  schemaRegistries(organizationId: $organizationId) {
    name
    uris
    type
    createdAt
    updatedAt
    owner {
      organization {
        ...OrganizationFragment
      }
      name
      enabled
      inherit
      createdAt
      updatedAt
      grantedRoles {
        ...RoleGrantFragment
      }
      grantedPrivileges {
        ...PrivilegeGrantFragment
      }
    }
  }
}

Variables

{"organizationId": 4}

Response

{
  "data": {
    "schemaRegistries": [
      {
        "name": "abc123",
        "uris": ["abc123"],
        "type": "ConfluentCloud",
        "createdAt": 1592577642,
        "updatedAt": 1592577642,
        "owner": Role
      }
    ]
  }
}

statement

Response

Returns a Statement!

Arguments

Name	Description
id	UUID!
organizationId	UUID!

Example

Query

query Statement(
  $id: UUID!,
  $organizationId: UUID!
) {
  statement(
    id: $id,
    organizationId: $organizationId
  ) {
    id
    organization {
      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
      }
    }
    dsql
    user {
      id
      givenName
      familyName
      email
      profileImage
      licenseAccepted
      licenseId
      locale
      defaultOrganization {
        ...OrganizationFragment
      }
      organizations {
        ...OrganizationFragment
      }
      createdAt
      updatedAt
    }
    errorMessage
    createdAt
    updatedAt
  }
}

Variables

{
  "id": "2c5d69e6-5348-4431-8496-252418e42515",
  "organizationId": "2c5d69e6-5348-4431-8496-252418e42515"
}

Response

{
  "data": {
    "statement": {
      "id": "2c5d69e6-5348-4431-8496-252418e42515",
      "organization": Organization,
      "dsql": "abc123",
      "user": User,
      "errorMessage": "xyz789",
      "createdAt": 1592577642,
      "updatedAt": 1592577642
    }
  }
}

statements

Response

Returns [Statement!]!

Arguments

Name	Description
organizationId	UUID!

Example

Query

query Statements($organizationId: UUID!) {
  statements(organizationId: $organizationId) {
    id
    organization {
      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
      }
    }
    dsql
    user {
      id
      givenName
      familyName
      email
      profileImage
      licenseAccepted
      licenseId
      locale
      defaultOrganization {
        ...OrganizationFragment
      }
      organizations {
        ...OrganizationFragment
      }
      createdAt
      updatedAt
    }
    errorMessage
    createdAt
    updatedAt
  }
}

Variables

{
  "organizationId": "2c5d69e6-5348-4431-8496-252418e42515"
}

Response

{
  "data": {
    "statements": [
      {
        "id": "2c5d69e6-5348-4431-8496-252418e42515",
        "organization": Organization,
        "dsql": "abc123",
        "user": User,
        "errorMessage": "xyz789",
        "createdAt": 1592577642,
        "updatedAt": 1592577642
      }
    ]
  }
}

store

Response

Returns a Store!

Arguments

Name	Description
name	String!
organizationId	UUID!

Example

Query

query Store(
  $name: String!,
  $organizationId: UUID!
) {
  store(
    name: $name,
    organizationId: $organizationId
  ) {
    name
    type
    uris
    availabilityZone
    organization {
      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
      }
    }
    metadata {
      value {
        ...MapEntryFragment
      }
    }
    additionalEgressURIs
    enableSslEncryption
    serverHostnameVerification
    caCert
    tlsProtocols
    cipherSuites
    topics {
      name
      store {
        ...StoreFragment
      }
    }
    topic {
      name
      store {
        ...StoreFragment
      }
    }
    schemaRegistry {
      name
      uris
      type
      createdAt
      updatedAt
      owner {
        ...RoleFragment
      }
    }
    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": {
    "store": {
      "name": "4",
      "type": "Kafka",
      "uris": ["xyz789"],
      "availabilityZone": "xyz789",
      "organization": Organization,
      "metadata": Map,
      "additionalEgressURIs": ["abc123"],
      "enableSslEncryption": true,
      "serverHostnameVerification": true,
      "caCert": "xyz789",
      "tlsProtocols": ["TLS1_2"],
      "cipherSuites": ["TLS_RSA_WITH_3DES_EDE_CBC_SHA"],
      "topics": [Topic],
      "topic": Topic,
      "schemaRegistry": SchemaRegistry,
      "createdAt": 1592577642,
      "updatedAt": 1592577642,
      "owner": Role
    }
  }
}

stores

Response

Returns [Store!]!

Arguments

Name	Description
organizationId	UUID!

Example

Query

query Stores($organizationId: UUID!) {
  stores(organizationId: $organizationId) {
    name
    type
    uris
    availabilityZone
    organization {
      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
      }
    }
    metadata {
      value {
        ...MapEntryFragment
      }
    }
    additionalEgressURIs
    enableSslEncryption
    serverHostnameVerification
    caCert
    tlsProtocols
    cipherSuites
    topics {
      name
      store {
        ...StoreFragment
      }
    }
    topic {
      name
      store {
        ...StoreFragment
      }
    }
    schemaRegistry {
      name
      uris
      type
      createdAt
      updatedAt
      owner {
        ...RoleFragment
      }
    }
    createdAt
    updatedAt
    owner {
      organization {
        ...OrganizationFragment
      }
      name
      enabled
      inherit
      createdAt
      updatedAt
      grantedRoles {
        ...RoleGrantFragment
      }
      grantedPrivileges {
        ...PrivilegeGrantFragment
      }
    }
  }
}

Variables

{
  "organizationId": "2c5d69e6-5348-4431-8496-252418e42515"
}

Response

{
  "data": {
    "stores": [
      {
        "name": "4",
        "type": "Kafka",
        "uris": ["xyz789"],
        "availabilityZone": "abc123",
        "organization": Organization,
        "metadata": Map,
        "additionalEgressURIs": ["xyz789"],
        "enableSslEncryption": true,
        "serverHostnameVerification": false,
        "caCert": "abc123",
        "tlsProtocols": ["TLS1_2"],
        "cipherSuites": ["TLS_RSA_WITH_3DES_EDE_CBC_SHA"],
        "topics": [Topic],
        "topic": Topic,
        "schemaRegistry": SchemaRegistry,
        "createdAt": 1592577642,
        "updatedAt": 1592577642,
        "owner": Role
      }
    ]
  }
}

streams

Response

Returns [Relation!]!

Arguments

Name	Description
organizationId	UUID!
databaseName	ID!
schemaName	ID!

Example

Query

query Streams(
  $organizationId: UUID!,
  $databaseName: ID!,
  $schemaName: ID!
) {
  streams(
    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": {
    "streams": [
      {
        "name": 4,
        "schema": Schema,
        "columns": [Column],
        "primaryKey": ["abc123"],
        "metadata": Map,
        "createdAt": 1592577642,
        "updatedAt": 1592577642,
        "owner": Role
      }
    ]
  }
}

version

Response

Returns a Version!

Example

Query

query Version {
  version {
    major
    minor
    patch
  }
}

Response

{"data": {"version": {"major": 123, "minor": 987, "patch": 987}}}

Types

APIToken

Fields

Field Name	Description
name	ID!
lastUsed	Timestamp!
createdAt	Timestamp!

Example

{
  "name": "4",
  "lastUsed": 1592577642,
  "createdAt": 1592577642
}

AvailabilityZone

Fields

Field Name	Description
name	String!
longName	String!

Example

{
  "name": "abc123",
  "longName": "xyz789"
}

Boolean

Description

The Boolean scalar type represents true or false.

Changelog

Fields

Field Name	Description
name	ID!
schema	Schema!
topic	Topic
columns	[Column!]!
primaryKey	[String!]!
metadata	Map!
createdAt	Timestamp!
updatedAt	Timestamp!
owner	Role!

Example

{
  "name": "4",
  "schema": Schema,
  "topic": Topic,
  "columns": [Column],
  "primaryKey": ["xyz789"],
  "metadata": Map,
  "createdAt": 1592577642,
  "updatedAt": 1592577642,
  "owner": Role
}

CipherSuite

Values

Enum Value	Description
TLS_RSA_WITH_3DES_EDE_CBC_SHA
TLS_RSA_WITH_AES_128_CBC_SHA
TLS_RSA_WITH_AES_256_CBC_SHA
TLS_RSA_WITH_AES_128_GCM_SHA256
TLS_RSA_WITH_AES_256_GCM_SHA384
TLS_AES_128_GCM_SHA256
TLS_AES_256_GCM_SHA384
TLS_CHACHA20_POLY1305_SHA256
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256

Example

"TLS_RSA_WITH_3DES_EDE_CBC_SHA"

Column

Fields

Field Name	Description
name	ID!
dataType	String!

Example

{"name": 4, "dataType": "abc123"}

Connector

Fields

Field Name	Description
name	ID!
type	ConnectorType!
sourceRelation	Relation!
sinkStore	Store!
sender	String!
destinations	[String!]!
template	String!
createdAt	Timestamp!
updatedAt	Timestamp!
owner	Role!

Example

{
  "name": 4,
  "type": "Notification",
  "sourceRelation": Relation,
  "sinkStore": Store,
  "sender": "xyz789",
  "destinations": ["xyz789"],
  "template": "xyz789",
  "createdAt": 1592577642,
  "updatedAt": 1592577642,
  "owner": Role
}

ConnectorType

Values

Enum Value	Description
Notification

Database

Fields

Field Name	Description
name	String!
org	Organization!
schema	Schema!
schemas	[Schema!]!
defaultSchema	Schema!
createdAt	Timestamp!
updatedAt	Timestamp!
owner	Role!

Example

{
  "name": "abc123",
  "org": Organization,
  "schema": Schema,
  "schemas": [Schema],
  "defaultSchema": Schema,
  "createdAt": 1592577642,
  "updatedAt": 1592577642,
  "owner": Role
}

Descriptor

Fields

Field Name	Description
id	ID!
name	String!
source	DescriptorSource!

Example

{
  "id": 4,
  "name": "abc123",
  "source": DescriptorSource
}

DescriptorSource

Fields

Field Name	Description
name	String!
tags	[String!]
type	DescriptorSourceType!
org	Organization!
descriptors	[Descriptor!]!
url	String!
createdAt	Timestamp!
updatedAt	Timestamp!
owner	Role!

Example

{
  "name": "xyz789",
  "tags": ["xyz789"],
  "type": "PB_DESCRIPTOR",
  "org": Organization,
  "descriptors": [Descriptor],
  "url": "xyz789",
  "createdAt": 1592577642,
  "updatedAt": 1592577642,
  "owner": Role
}

DescriptorSourceType

Values

Enum Value	Description
PB_DESCRIPTOR

Function

Fields

Field Name	Description
org	Organization!
name	String!
type	FunctionType!
inputs	[Parameter!]!
outputType	String!
source	FunctionSource!
className	String!
signature	String!
createdAt	Timestamp!
updatedAt	Timestamp!
owner	Role!

Example

{
  "org": Organization,
  "name": "xyz789",
  "type": "UDF",
  "inputs": [Parameter],
  "outputType": "abc123",
  "source": FunctionSource,
  "className": "xyz789",
  "signature": "xyz789",
  "createdAt": 1592577642,
  "updatedAt": 1592577642,
  "owner": Role
}

FunctionSource

Fields

Field Name	Description
name	String!
description	String!
url	String!
createdAt	Timestamp!
updatedAt	Timestamp!
owner	Role!

Example

{
  "name": "abc123",
  "description": "xyz789",
  "url": "xyz789",
  "createdAt": 1592577642,
  "updatedAt": 1592577642,
  "owner": Role
}

FunctionType

Values

Enum Value	Description
UDF
UDAF
UDTF

ID

Description

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Int

Description

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Invitation

Fields

Field Name	Description
organization	Organization!
id	UUID!
invitedUserEmail	String!
invitedBy	Role
userRole	Role
defaultRole	Role
additionalRoles	[Role!]!
invitationState	InvitationState!

Example

{
  "organization": Organization,
  "id": "2c5d69e6-5348-4431-8496-252418e42515",
  "invitedUserEmail": "abc123",
  "invitedBy": Role,
  "userRole": Role,
  "defaultRole": Role,
  "additionalRoles": [Role],
  "invitationState": "PENDING"
}

InvitationState

Values

Enum Value	Description
PENDING
ACCEPTED
REJECTED

KafkaTopic

Fields

Field Name	Description
name	ID!
store	Store!
numPartitions	Int!
numReplicas	Int!
keyDescriptor	Descriptor
valueDescriptor	Descriptor

Example

{
  "name": "4",
  "store": Store,
  "numPartitions": 123,
  "numReplicas": 123,
  "keyDescriptor": Descriptor,
  "valueDescriptor": Descriptor
}

KinesisTopic

Fields

Field Name	Description
name	ID!
store	Store!
shards	Int!
descriptor	Descriptor

Example

{
  "name": "4",
  "store": Store,
  "shards": 123,
  "descriptor": Descriptor
}

Map

Fields

Field Name	Description
value	[MapEntry!]!

Example

{"value": [MapEntry]}

MapEntry

Fields

Field Name	Description
key	String!
value	String!

Example

{
  "key": "abc123",
  "value": "xyz789"
}

MaterializedView

Fields

Field Name	Description
name	ID!
schema	Schema!
columns	[Column!]!
primaryKey	[String!]!
metadata	Map!
createdAt	Timestamp!
updatedAt	Timestamp!
owner	Role!

Example

{
  "name": "4",
  "schema": Schema,
  "columns": [Column],
  "primaryKey": ["xyz789"],
  "metadata": Map,
  "createdAt": 1592577642,
  "updatedAt": 1592577642,
  "owner": Role
}

Member

Fields

Field Name	Description
user	User!
roles	[RoleGrant!]!
defaultRole	Role!
createdAt	Timestamp!
updatedAt	Timestamp!

Example

{
  "user": User,
  "roles": [RoleGrant],
  "defaultRole": Role,
  "createdAt": 1592577642,
  "updatedAt": 1592577642
}

Organization

Fields

Field Name	Description
connectors	[Connector!]!
invitations	[Invitation!]!
id	UUID!
name	String!
description	String
profileImage	String
createdAt	Timestamp!
updatedAt	Timestamp!
owner	Role!
members	[Member!]!
member	Member!
database	Database!
databases	[Database!]!
defaultDatabase	Database
schemaRegistries	[SchemaRegistry!]!
query	Query!
queries	[Query]!
topicDescriptor	TopicDescriptor
topicDescriptors	[TopicDescriptor!]!
sandbox	Sandbox!
role	Role!
roles	[Role!]!
defaultRole	Role!
store	Store!
stores	[Store!]!
defaultStore	Store

Example

{
  "connectors": [Connector],
  "invitations": [Invitation],
  "id": "2c5d69e6-5348-4431-8496-252418e42515",
  "name": "xyz789",
  "description": "abc123",
  "profileImage": "xyz789",
  "createdAt": 1592577642,
  "updatedAt": 1592577642,
  "owner": Role,
  "members": [Member],
  "member": Member,
  "database": Database,
  "databases": [Database],
  "defaultDatabase": Database,
  "schemaRegistries": [SchemaRegistry],
  "query": Query,
  "queries": [Query],
  "topicDescriptor": TopicDescriptor,
  "topicDescriptors": [TopicDescriptor],
  "sandbox": Sandbox,
  "role": Role,
  "roles": [Role],
  "defaultRole": Role,
  "store": Store,
  "stores": [Store],
  "defaultStore": Store
}

Parameter

Fields

Field Name	Description
name	String!
type	String!

Example

{
  "name": "abc123",
  "type": "xyz789"
}

PrivilegeGrant

Fields

Field Name	Description
privilegeTarget	PrivilegeTarget!
privilegeType	PrivilegeType!
targetID	ID!

Example

{
  "privilegeTarget": "Organization",
  "privilegeType": "CreateRole",
  "targetID": 4
}

PrivilegeTarget

Values

Enum Value	Description
Organization
Database
Schema
Store
DescriptorSource
Query
Relation
FunctionSource
Function
SchemaRegistry

PrivilegeType

Values

Enum Value	Description
CreateRole
ManageGrants
CreateDatabase
CreateStore
CreateDescriptorSource
CreateQuery
CreateFunctionSource
CreateFunction
CreateSchemaRegistry
Owner
Usage
Create
Drop
Select
Insert

Query

Fields

Field Name	Description
id	UUID!
organization	Organization!
sources	[Relation!]!
sinks	[Relation!]!
dsql	String!
intendedState	QueryState!
actualState	QueryState!
errorMessages	[String!]!
createdAt	Timestamp!
updatedAt	Timestamp!
owner	Role!

Example

{
  "id": "2c5d69e6-5348-4431-8496-252418e42515",
  "organization": Organization,
  "sources": [Relation],
  "sinks": [Relation],
  "dsql": "xyz789",
  "intendedState": "NEW",
  "actualState": "NEW",
  "errorMessages": ["abc123"],
  "createdAt": 1592577642,
  "updatedAt": 1592577642,
  "owner": Role
}

QueryState

Values

Enum Value	Description
NEW
CREATED
RUNNING
PAUSED
STOPPED
STOPPING
ERRORED
STOPPED_WITH_ERROR

Relation

Fields

Field Name	Description
name	ID!
schema	Schema!
columns	[Column!]!
primaryKey	[String!]!
metadata	Map!
createdAt	Timestamp!
updatedAt	Timestamp!
owner	Role!

Possible Types

Relation Types
Changelog
MaterializedView
Stream

Example

{
  "name": "4",
  "schema": Schema,
  "columns": [Column],
  "primaryKey": ["xyz789"],
  "metadata": Map,
  "createdAt": 1592577642,
  "updatedAt": 1592577642,
  "owner": Role
}

Role

Fields

Field Name	Description
organization	Organization!
name	String!
enabled	Boolean!
inherit	Boolean!
createdAt	Timestamp!
updatedAt	Timestamp!
grantedRoles	[RoleGrant!]!
grantedPrivileges	[PrivilegeGrant!]!

Example

{
  "organization": Organization,
  "name": "xyz789",
  "enabled": true,
  "inherit": false,
  "createdAt": 1592577642,
  "updatedAt": 1592577642,
  "grantedRoles": [RoleGrant],
  "grantedPrivileges": [PrivilegeGrant]
}

RoleGrant

Fields

Field Name	Description
name	String!
isEnabled	Boolean!
isInherited	Boolean!
role	Role!
createdAt	Timestamp!
updatedAt	Timestamp!

Example

{
  "name": "abc123",
  "isEnabled": false,
  "isInherited": false,
  "role": Role,
  "createdAt": 1592577642,
  "updatedAt": 1592577642
}

Sandbox

Fields

Field Name	Description
id	UUID!
status	SandboxStatus!
functionSources	[FunctionSource!]!
errorMessages	[String!]!
availabilityZone	String!
createdAt	Timestamp!
updatedAt	Timestamp!
owner	Role!

Example

{
  "id": "2c5d69e6-5348-4431-8496-252418e42515",
  "status": "STOPPING",
  "functionSources": [FunctionSource],
  "errorMessages": ["xyz789"],
  "availabilityZone": "abc123",
  "createdAt": 1592577642,
  "updatedAt": 1592577642,
  "owner": Role
}

SandboxStatus

Values

Enum Value	Description
STOPPING
STOPPED
STARTING
RUNNING
ERRORED

Schema

Fields

Field Name	Description
name	String!
database	Database!
relations	[Relation!]!
relation	Relation!
createdAt	Timestamp!
updatedAt	Timestamp!
owner	Role!

Example

{
  "name": "abc123",
  "database": Database,
  "relations": [Relation],
  "relation": Relation,
  "createdAt": 1592577642,
  "updatedAt": 1592577642,
  "owner": Role
}

SchemaRegistry

Fields

Field Name	Description
name	String!
uris	[String!]!
type	SchemaRegistryType!
createdAt	Timestamp!
updatedAt	Timestamp!
owner	Role!

Example

{
  "name": "xyz789",
  "uris": ["abc123"],
  "type": "ConfluentCloud",
  "createdAt": 1592577642,
  "updatedAt": 1592577642,
  "owner": Role
}

SchemaRegistryType

Values

Enum Value	Description
ConfluentCloud
Confluent

Statement

Fields

Field Name	Description
id	UUID!
organization	Organization!
dsql	String!
user	User
errorMessage	String
createdAt	Timestamp!
updatedAt	Timestamp!

Example

{
  "id": "2c5d69e6-5348-4431-8496-252418e42515",
  "organization": Organization,
  "dsql": "abc123",
  "user": User,
  "errorMessage": "abc123",
  "createdAt": 1592577642,
  "updatedAt": 1592577642
}

Store

Fields

Field Name	Description
name	ID!
type	StoreType!
uris	[String!]!
availabilityZone	String!
organization	Organization!
metadata	Map!
additionalEgressURIs	[String!]!
enableSslEncryption	Boolean!
serverHostnameVerification	Boolean!
caCert	String
tlsProtocols	[TLSProtocol!]
cipherSuites	[CipherSuite!]
topics	[Topic!]!
topic	Topic!
schemaRegistry	SchemaRegistry
createdAt	Timestamp!
updatedAt	Timestamp!
owner	Role!

Example

{
  "name": "4",
  "type": "Kafka",
  "uris": ["abc123"],
  "availabilityZone": "abc123",
  "organization": Organization,
  "metadata": Map,
  "additionalEgressURIs": ["abc123"],
  "enableSslEncryption": false,
  "serverHostnameVerification": true,
  "caCert": "xyz789",
  "tlsProtocols": ["TLS1_2"],
  "cipherSuites": ["TLS_RSA_WITH_3DES_EDE_CBC_SHA"],
  "topics": [Topic],
  "topic": Topic,
  "schemaRegistry": SchemaRegistry,
  "createdAt": 1592577642,
  "updatedAt": 1592577642,
  "owner": Role
}

StoreType

Values

Enum Value	Description
Kafka
Kinesis
Slack

Stream

Fields

Field Name	Description
name	ID!
schema	Schema!
topic	Topic
columns	[Column!]!
primaryKey	[String!]!
metadata	Map!
createdAt	Timestamp!
updatedAt	Timestamp!
owner	Role!

Example

{
  "name": 4,
  "schema": Schema,
  "topic": Topic,
  "columns": [Column],
  "primaryKey": ["abc123"],
  "metadata": Map,
  "createdAt": 1592577642,
  "updatedAt": 1592577642,
  "owner": Role
}

String

Description

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

TLSProtocol

Values

Enum Value	Description
TLS1_2
TLS1_3

Timestamp

Topic

Fields

Field Name	Description
name	ID!
store	Store!

Possible Types

Topic Types
KafkaTopic
KinesisTopic

Example

{
  "name": "4",
  "store": Store
}

TopicDescriptor

Fields

Field Name	Description
id	ID!
keyDescriptor	Descriptor
valueDescriptor	Descriptor
topicName	String!
storeName	String!
org	Organization!

Example

{
  "id": 4,
  "keyDescriptor": Descriptor,
  "valueDescriptor": Descriptor,
  "topicName": "abc123",
  "storeName": "xyz789",
  "org": Organization
}

UUID

Example

"2c5d69e6-5348-4431-8496-252418e42515"

User

Fields

Field Name	Description
id	String!
givenName	String!
familyName	String!
email	String!
profileImage	String
licenseAccepted	Boolean!
licenseId	String
locale	String
defaultOrganization	Organization
organizations	[Organization!]!
createdAt	Timestamp!
updatedAt	Timestamp!

Example

{
  "id": "xyz789",
  "givenName": "xyz789",
  "familyName": "xyz789",
  "email": "xyz789",
  "profileImage": "abc123",
  "licenseAccepted": true,
  "licenseId": "abc123",
  "locale": "abc123",
  "defaultOrganization": Organization,
  "organizations": [Organization],
  "createdAt": 1592577642,
  "updatedAt": 1592577642
}

UserInvitation

Fields

Field Name	Description
organizationID	UUID!
organizationName	String!
id	UUID!
invitationState	InvitationState!

Example

{
  "organizationID": "2c5d69e6-5348-4431-8496-252418e42515",
  "organizationName": "xyz789",
  "id": "2c5d69e6-5348-4431-8496-252418e42515",
  "invitationState": "PENDING"
}

Version

Fields

Field Name	Description
major	Int!
minor	Int!
patch	Int!

Example

{"major": 987, "minor": 987, "patch": 987}