sql-sources

Embed

<a href="https://hermetica.15.204.158.166.sslip.io/docs/ref-sql-sources"><img src="https://hermetica.15.204.158.166.sslip.io/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/28ae220b-83eb-4203-a7b6-319c3c0326d4/social-card.svg?v=3e7ae33eec8b" alt="sql-sources" width="600" height="315"></a>

GEThttps://hermetica.15.204.158.166.sslip.io/v1/sql-sources

Parameters

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

Code samples

cURL

curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/sql-sources" \
  -H "Authorization: Bearer $SSLIP_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "kind": "postgres",
      "name": "string",
      "query": "string",
      "target": "profiles",
      "objectType": "string",
      "mapping": {
        "email": "string",
        "phone": "string",
        "externalId": "string",
        "firstName": "string",
        "lastName": "string",
        "columns": [
          "string"
        ],
        "eventName": "string",
        "eventNameFixed": "string",
        "occurredAt": "string",
        "dedupeKey": "string",
        "objectName": "string",
        "objectExternalId": "string"
      },
      "cursorColumn": "string",
      "cursorValue": "string",
      "everyMinutes": 0,
      "timeoutMs": 0,
      "maxRows": 0,
      "enabled": true,
      "lastRunAt": "2024-01-01T00:00:00Z",
      "lastRowCount": 0,
      "lastError": "string",
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

idstringrequired

kindstringrequired

postgres | mysql | databricks

namestringrequired

querystringrequired

targetstringrequired

profiles | events | objects

objectTypestringrequired

mappingobjectrequired

Show child parameters

emailstring

phonestring

externalIdstring

firstNamestring

lastNamestring

columnsstring[]

eventNamestring

eventNameFixedstring

occurredAtstring

dedupeKeystring

objectNamestring

objectExternalIdstring

cursorColumnstringrequired

cursorValuestringrequired

everyMinutesintegerrequired

timeoutMsintegerrequired

maxRowsintegerrequired

enabledbooleanrequired

lastRunAtstringrequired

lastRowCountintegerrequired

lastErrorstringrequired

createdAtstringrequired

nextCursorstringrequired

4XX Default Response

Example

{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}

Schema

errorobjectrequired

Show child parameters

codestringrequired

messagestringrequired

detailsobject

5XX Default Response

Same as 4XX · GET /v1/sql-sources

POSThttps://hermetica.15.204.158.166.sslip.io/v1/sql-sources

Add a scheduled SELECT; only SELECT statements are accepted

Request body

application/json

kindstringrequired

postgres | mysql | databricks

namestringrequired

credentialsobjectrequired

querystringrequired

targetstringrequired

profiles | events | objects

objectTypestring

mappingobjectrequired

Show child parameters

emailstring

phonestring

externalIdstring

firstNamestring

lastNamestring

columnsstring[]

eventNamestring

eventNameFixedstring

occurredAtstring

dedupeKeystring

objectNamestring

objectExternalIdstring

cursorColumnstring

everyMinutesinteger

timeoutMsinteger

maxRowsinteger

enabledboolean

{
  "kind": "postgres",
  "name": "string",
  "credentials": {},
  "query": "string",
  "target": "profiles",
  "objectType": "string",
  "mapping": {
    "email": "string",
    "phone": "string",
    "externalId": "string",
    "firstName": "string",
    "lastName": "string",
    "columns": [
      "string"
    ],
    "eventName": "string",
    "eventNameFixed": "string",
    "occurredAt": "string",
    "dedupeKey": "string",
    "objectName": "string",
    "objectExternalId": "string"
  },
  "cursorColumn": "string",
  "everyMinutes": 0,
  "timeoutMs": 0,
  "maxRows": 0,
  "enabled": true
}

Code samples

cURL

curl -X POST "https://hermetica.15.204.158.166.sslip.io/v1/sql-sources" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"kind":"postgres","name":"string","credentials":{},"query":"string","target":"profiles","objectType":"string","mapping":{"email":"string","phone":"string","externalId":"string","firstName":"string","lastName":"string","columns":["string"],"eventName":"string","eventNameFixed":"string","occurredAt":"string","dedupeKey":"string","objectName":"string","objectExternalId":"string"},"cursorColumn":"string","everyMinutes":0,"timeoutMs":0,"maxRows":0,"enabled":true}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "kind": "postgres",
  "name": "string",
  "query": "string",
  "target": "profiles",
  "objectType": "string",
  "mapping": {
    "email": "string",
    "phone": "string",
    "externalId": "string",
    "firstName": "string",
    "lastName": "string",
    "columns": [
      "string"
    ],
    "eventName": "string",
    "eventNameFixed": "string",
    "occurredAt": "string",
    "dedupeKey": "string",
    "objectName": "string",
    "objectExternalId": "string"
  },
  "cursorColumn": "string",
  "cursorValue": "string",
  "everyMinutes": 0,
  "timeoutMs": 0,
  "maxRows": 0,
  "enabled": true,
  "lastRunAt": "2024-01-01T00:00:00Z",
  "lastRowCount": 0,
  "lastError": "string",
  "createdAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

kindstringrequired

postgres | mysql | databricks

namestringrequired

querystringrequired

targetstringrequired

profiles | events | objects

objectTypestringrequired

mappingobjectrequired

Show child parameters

emailstring

phonestring

externalIdstring

firstNamestring

lastNamestring

columnsstring[]

eventNamestring

eventNameFixedstring

occurredAtstring

dedupeKeystring

objectNamestring

objectExternalIdstring

cursorColumnstringrequired

cursorValuestringrequired

everyMinutesintegerrequired

timeoutMsintegerrequired

maxRowsintegerrequired

enabledbooleanrequired

lastRunAtstringrequired

lastRowCountintegerrequired

lastErrorstringrequired

createdAtstringrequired

4XX Default Response

Same as 4XX · GET /v1/sql-sources

5XX Default Response

Same as 4XX · GET /v1/sql-sources

GEThttps://hermetica.15.204.158.166.sslip.io/v1/sql-sources/{id}

Parameters

idstringpathrequired

Code samples

cURL

curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/sql-sources/{id}" \
  -H "Authorization: Bearer $SSLIP_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/sql-sources

4XX Default Response

Same as 4XX · GET /v1/sql-sources

5XX Default Response

Same as 4XX · GET /v1/sql-sources

DELETEhttps://hermetica.15.204.158.166.sslip.io/v1/sql-sources/{id}

Parameters

idstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermetica.15.204.158.166.sslip.io/v1/sql-sources/{id}" \
  -H "Authorization: Bearer $SSLIP_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "ok": true
}

Schema

okbooleanrequired

true

4XX Default Response

Same as 4XX · GET /v1/sql-sources

5XX Default Response

Same as 4XX · GET /v1/sql-sources

PATCHhttps://hermetica.15.204.158.166.sslip.io/v1/sql-sources/{id}

Edit; a blank password or token keeps the stored one

Parameters

idstringpathrequired

Request body

application/json

namestring

credentialsobject

querystring

targetstring

profiles | events | objects

objectTypestring

mappingobject

Show child parameters

emailstring

phonestring

externalIdstring

firstNamestring

lastNamestring

columnsstring[]

eventNamestring

eventNameFixedstring

occurredAtstring

dedupeKeystring

objectNamestring

objectExternalIdstring

cursorColumnstring

everyMinutesinteger

timeoutMsinteger

maxRowsinteger

enabledboolean

resetCursorboolean

{
  "name": "string",
  "credentials": {},
  "query": "string",
  "target": "profiles",
  "objectType": "string",
  "mapping": {
    "email": "string",
    "phone": "string",
    "externalId": "string",
    "firstName": "string",
    "lastName": "string",
    "columns": [
      "string"
    ],
    "eventName": "string",
    "eventNameFixed": "string",
    "occurredAt": "string",
    "dedupeKey": "string",
    "objectName": "string",
    "objectExternalId": "string"
  },
  "cursorColumn": "string",
  "everyMinutes": 0,
  "timeoutMs": 0,
  "maxRows": 0,
  "enabled": true,
  "resetCursor": true
}

Code samples

cURL

curl -X PATCH "https://hermetica.15.204.158.166.sslip.io/v1/sql-sources/{id}" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","credentials":{},"query":"string","target":"profiles","objectType":"string","mapping":{"email":"string","phone":"string","externalId":"string","firstName":"string","lastName":"string","columns":["string"],"eventName":"string","eventNameFixed":"string","occurredAt":"string","dedupeKey":"string","objectName":"string","objectExternalId":"string"},"cursorColumn":"string","everyMinutes":0,"timeoutMs":0,"maxRows":0,"enabled":true,"resetCursor":true}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/sql-sources

4XX Default Response

Same as 4XX · GET /v1/sql-sources

5XX Default Response

Same as 4XX · GET /v1/sql-sources

POSThttps://hermetica.15.204.158.166.sslip.io/v1/sql-sources/{id}/preview

Test the connection and query: up to 20 rows, nothing imported

Parameters

idstringpathrequired

Code samples

cURL

curl -X POST "https://hermetica.15.204.158.166.sslip.io/v1/sql-sources/{id}/preview" \
  -H "Authorization: Bearer $SSLIP_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "columns": [
    "string"
  ],
  "rows": [
    {}
  ]
}

Schema

columnsstring[]required

rowsobject[]required

4XX Default Response

Same as 4XX · GET /v1/sql-sources

5XX Default Response

Same as 4XX · GET /v1/sql-sources

POSThttps://hermetica.15.204.158.166.sslip.io/v1/sql-sources/{id}/run

Run the pull now (in the background)

Parameters

idstringpathrequired

Code samples

cURL

curl -X POST "https://hermetica.15.204.158.166.sslip.io/v1/sql-sources/{id}/run" \
  -H "Authorization: Bearer $SSLIP_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

202 Default Response

Same as 200 · DELETE /v1/sql-sources/{id}

4XX Default Response

Same as 4XX · GET /v1/sql-sources

5XX Default Response

Same as 4XX · GET /v1/sql-sources

Updated Nov 3, 2026

Was this page helpful?