Create a data source

curl --request POST \
  --url https://reporter.sandbox.lerian.net/v1/data-sources \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "configName": "midaz_onboarding",
  "databaseName": "onboarding",
  "host": "db.internal",
  "password": "-",
  "port": 5432,
  "type": "postgresql",
  "username": "reporter_ro",
  "metadata": {},
  "options": "authSource=admin",
  "schemas": [
    "public"
  ],
  "sslCaBase64": "",
  "sslMode": "require"
}
'

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://reporter.sandbox.lerian.net/v1/data-sources"

	payload := strings.NewReader("{\n  \"configName\": \"midaz_onboarding\",\n  \"databaseName\": \"onboarding\",\n  \"host\": \"db.internal\",\n  \"password\": \"-\",\n  \"port\": 5432,\n  \"type\": \"postgresql\",\n  \"username\": \"reporter_ro\",\n  \"metadata\": {},\n  \"options\": \"authSource=admin\",\n  \"schemas\": [\n    \"public\"\n  ],\n  \"sslCaBase64\": \"\",\n  \"sslMode\": \"require\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    configName: 'midaz_onboarding',
    databaseName: 'onboarding',
    host: 'db.internal',
    password: '-',
    port: 5432,
    type: 'postgresql',
    username: 'reporter_ro',
    metadata: {},
    options: 'authSource=admin',
    schemas: ['public'],
    sslCaBase64: '',
    sslMode: 'require'
  })
};

fetch('https://reporter.sandbox.lerian.net/v1/data-sources', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://reporter.sandbox.lerian.net/v1/data-sources"

payload = {
    "configName": "midaz_onboarding",
    "databaseName": "onboarding",
    "host": "db.internal",
    "password": "-",
    "port": 5432,
    "type": "postgresql",
    "username": "reporter_ro",
    "metadata": {},
    "options": "authSource=admin",
    "schemas": ["public"],
    "sslCaBase64": "",
    "sslMode": "require"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "builtIn": false,
  "configName": "midaz_onboarding",
  "createdAt": "2026-01-01T00:00:00Z",
  "databaseName": "onboarding",
  "host": "db.internal",
  "id": "00000000-0000-0000-0000-000000000000",
  "lastConnection": {
    "checkedAt": "2026-01-01T00:00:00Z",
    "latencyMs": 42,
    "message": "connection successful",
    "status": "connected"
  },
  "metadata": {},
  "options": "authSource=admin",
  "port": 5432,
  "schemas": [
    "public"
  ],
  "sslCaBase64": "",
  "sslMode": "require",
  "type": "postgresql",
  "updatedAt": "2026-01-01T00:00:00Z",
  "username": "reporter_ro"
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

POST

data-sources

Create a data source

curl --request POST \
  --url https://reporter.sandbox.lerian.net/v1/data-sources \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "configName": "midaz_onboarding",
  "databaseName": "onboarding",
  "host": "db.internal",
  "password": "-",
  "port": 5432,
  "type": "postgresql",
  "username": "reporter_ro",
  "metadata": {},
  "options": "authSource=admin",
  "schemas": [
    "public"
  ],
  "sslCaBase64": "",
  "sslMode": "require"
}
'

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://reporter.sandbox.lerian.net/v1/data-sources"

	payload := strings.NewReader("{\n  \"configName\": \"midaz_onboarding\",\n  \"databaseName\": \"onboarding\",\n  \"host\": \"db.internal\",\n  \"password\": \"-\",\n  \"port\": 5432,\n  \"type\": \"postgresql\",\n  \"username\": \"reporter_ro\",\n  \"metadata\": {},\n  \"options\": \"authSource=admin\",\n  \"schemas\": [\n    \"public\"\n  ],\n  \"sslCaBase64\": \"\",\n  \"sslMode\": \"require\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    configName: 'midaz_onboarding',
    databaseName: 'onboarding',
    host: 'db.internal',
    password: '-',
    port: 5432,
    type: 'postgresql',
    username: 'reporter_ro',
    metadata: {},
    options: 'authSource=admin',
    schemas: ['public'],
    sslCaBase64: '',
    sslMode: 'require'
  })
};

fetch('https://reporter.sandbox.lerian.net/v1/data-sources', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://reporter.sandbox.lerian.net/v1/data-sources"

payload = {
    "configName": "midaz_onboarding",
    "databaseName": "onboarding",
    "host": "db.internal",
    "password": "-",
    "port": 5432,
    "type": "postgresql",
    "username": "reporter_ro",
    "metadata": {},
    "options": "authSource=admin",
    "schemas": ["public"],
    "sslCaBase64": "",
    "sslMode": "require"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "builtIn": false,
  "configName": "midaz_onboarding",
  "createdAt": "2026-01-01T00:00:00Z",
  "databaseName": "onboarding",
  "host": "db.internal",
  "id": "00000000-0000-0000-0000-000000000000",
  "lastConnection": {
    "checkedAt": "2026-01-01T00:00:00Z",
    "latencyMs": 42,
    "message": "connection successful",
    "status": "connected"
  },
  "metadata": {},
  "options": "authSource=admin",
  "port": 5432,
  "schemas": [
    "public"
  ],
  "sslCaBase64": "",
  "sslMode": "require",
  "type": "postgresql",
  "updatedAt": "2026-01-01T00:00:00Z",
  "username": "reporter_ro"
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Authorizations

Authorization

string

header

required

JWT bearer token issued by the identity provider.

Body

application/json

JSON request payload.

configName

string

required

Stable business key referenced by templates; unique among live data sources.

Example:

"midaz_onboarding"

databaseName

string

required

Database name.

Example:

"onboarding"

host

string

required

Database host.

Example:

"db.internal"

password

string

required

Write-only credential: encrypted at rest, never returned by any operation.

Example:

"-"

port

integer<int64>

required

Database port.

Example:

5432

type

string

required

Data source engine type: postgresql or mongodb.

Example:

"postgresql"

username

string

required

Database username.

Example:

"reporter_ro"

metadata

object

Free-form metadata.

Show child attributes

options

string

MongoDB URI options string (e.g. authSource=admin). Not applicable to postgresql.

Example:

"authSource=admin"

schemas

string[] | null

PostgreSQL schemas to expose; defaults to [public]. Not applicable to mongodb.

Example:

["public"]

sslCaBase64

string

MongoDB or PostgreSQL: standard Base64 of a PEM CA bundle. Mutually exclusive with an existing CA file; requires verified TLS (postgresql requires sslMode verify-ca or verify-full).

Example:

""

sslMode

string

TLS mode: disable, require, verify-ca, or verify-full. Defaults to verify-full for PostgreSQL with sslCaBase64; otherwise defaults to require when omitted.

Example:

"require"

Response

Created

builtIn

boolean

True for a data source the platform provides from the tenant's Lerian module databases; read-only, never registered

Example:

false

configName

string

Stable business key referenced by templates

Example:

"midaz_onboarding"

createdAt

string<date-time>

Creation timestamp in UTC

Example:

"2026-01-01T00:00:00Z"

databaseName

string

Database name

Example:

"onboarding"

host

string

Database host

Example:

"db.internal"

string

Unique data source identifier

Example:

"00000000-0000-0000-0000-000000000000"

lastConnection

object

Outcome of the most recent connectivity probe; absent means never probed, which is not the same as failed

Show child attributes

metadata

object

Free-form metadata

Show child attributes

options

string

MongoDB URI options string (e.g. authSource=admin); mongodb only

Example:

"authSource=admin"

port

integer<int64>

Database port

Example:

5432

schemas

string[] | null

PostgreSQL schemas to expose

Example:

["public"]

sslCaBase64

string

Base64-encoded PEM CA bundle for MongoDB or PostgreSQL; never a private key. PostgreSQL requires sslMode verify-ca or verify-full.

Example:

""

sslMode

string

TLS mode: disable, require, verify-ca, or verify-full. The two engines read require differently: MongoDB's driver verifies the server certificate under require (verify-full in effect), PostgreSQL's encrypts without verifying it; verify-full means the same on both.

Example:

"require"

type

string

Data source engine type

Example:

"postgresql"

updatedAt

string<date-time>

Most recent update timestamp in UTC

Example:

"2026-01-01T00:00:00Z"

username

string

Database username

Example:

"reporter_ro"

Getting started

Templates API

Template Builder API

Reports API

Deadlines API

Data Sources API

Institutions API

Regulatory Catalog API

Regulatory Subscriptions API

Regulatory Bindings API

Regulatory Reports API

Metrics API

Streaming API

Error handling

Events

Create a data source

Authorizations

Body

Response