Database Connections

get

Authorizations

authenticationOIDC

sessionidstringRequired

Log in using the POST /api/v1/auth/ endpoint

Query parameters

connector_typestringOptional

Connector type parameter for functionalities

Responses

200Success

application/json

functionalitiesany ofOptionalDefault: []

or

nullOptional

503

Message: service unavailable

get

/api/v1/database_connections/functionalities/

HTTPcURLJavaScriptPython

GET /api/v1/database_connections/functionalities/ HTTP/1.1
Accept: */*

{
  "functionalities": [
    {
      "name": "HIGH_PERFORMANCE_WRITING",
      "description": "text",
      "kind": "ADDITIVE",
      "applicability": "FULL",
      "capabilities": [
        {
          "name": "IDENTITY_WRITING",
          "depends_on": [
            "text"
          ]
        }
      ]
    }
  ]
}

get

Authorizations

authenticationOIDC

sessionidstringRequired

Log in using the POST /api/v1/auth/ endpoint

Responses

200Success

application/json

connectorsany ofOptionalDefault: null

or

nullOptional

write_connectorsany ofOptionalDefault: null

or

nullOptional

hooksany ofOptionalDefault: null

or

nullOptional

503

Message: service unavailable

get

/api/v1/database_connections/supported_types/

HTTPcURLJavaScriptPython

GET /api/v1/database_connections/supported_types/ HTTP/1.1
Accept: */*

{
  "connectors": {
    "ANY_ADDITIONAL_PROPERTY": {
      "ANY_ADDITIONAL_PROPERTY": {
        "type": "text",
        "default": "text",
        "values": [
          "text"
        ]
      }
    }
  },
  "write_connectors": {
    "ANY_ADDITIONAL_PROPERTY": {
      "ANY_ADDITIONAL_PROPERTY": {
        "type": "text",
        "default": "text",
        "values": [
          "text"
        ]
      }
    }
  },
  "hooks": {
    "ANY_ADDITIONAL_PROPERTY": {
      "ANY_ADDITIONAL_PROPERTY": {
        "type": "text",
        "default": "text",
        "values": [
          "text"
        ]
      }
    }
  }
}

post

Authorizations

authenticationOIDC

sessionidstringRequired

Log in using the POST /api/v1/auth/ endpoint

Body

application/json

or

or

or

or

or

or

or

or

Responses

200Success

application/json

idany ofOptionalDefault: null

stringOptional

or

nullOptional

codestringRequired

titlestringRequired

bodystring[]Required

durabilityany ofOptionalDefault: temporary

string · enumOptionalPossible values:

or

nullOptional

durationany ofOptionalDefault: 5000

integerOptional

or

nullOptional

kindany ofOptionalDefault: info

string · enumOptionalPossible values:

or

nullOptional

detailsany ofOptionalDefault: null

or

nullOptional

payloadanyOptionalDefault: null

actionany ofOptionalDefault: null

objectOptional

or

nullOptional

displayany ofOptionalDefault: notification

string · enumOptionalPossible values:

or

nullOptional

created_atany ofOptionalDefault: null

stringOptional

or

nullOptional

503

Message: service unavailable

post

/api/v1/database_connections/test/

HTTPcURLJavaScriptPython

POST /api/v1/database_connections/test/ HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 537

{
  "hooks_params": {
    "SSHTunnel": {
      "host": "text",
      "port": 1,
      "username": "text",
      "local_port": 1,
      "local_host": "text",
      "password": "text",
      "pkey_password": "text",
      "pkey": "text"
    },
    "SSL": {
      "ca_filename": "text",
      "cert_filename": "text",
      "key_filename": "text",
      "ssl_mode": "text",
      "ca": "text",
      "cert": "text",
      "key": "text"
    },
    "Kerberos": {
      "principal": "text",
      "keytab_file": "text"
    }
  },
  "is_source": true,
  "connector_type": "text",
  "host": "text",
  "database": "text",
  "username": "text",
  "password": "text",
  "schema_name": "text",
  "port": 1433,
  "protocol": "mssql+pyodbc",
  "include_views": false
}

{
  "id": "text",
  "code": "text",
  "title": "text",
  "body": [
    "text"
  ],
  "durability": "temporary",
  "duration": 5000,
  "kind": "info",
  "details": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "payload": null,
  "action": {},
  "display": "notification",
  "created_at": "text"
}