Connections API

All

/api/v1/connections

Get all existing connections with details

Responses

[
  {
    "id": 96,
    "type": "example",
    "name": "example",
    "databaseUrl": "example",
    "databaseName": "example",
    "databaseUser": "example",
    "databasePort": 96,
    "connected": true,
    "maxThreads": 96,
    "maxTimeout": 96,
    "jdbcUrl": "example",
    "properties": "example",
    "jdbcUrlOverride": "example"
  }
]

{
  "status": 96,
  "message": "example",
  "errors": [
    {
      "entityId": "example",
      "field": "example",
      "message": "example"
    }
  ]
}

{
  "status": 96,
  "message": "example",
  "errors": [
    {
      "entityId": "example",
      "field": "example",
      "message": "example"
    }
  ]
}

Get by id

/api/v1/connections/{id}

Get existing connection details by id

Request parameters

Responses

{
  "id": 96,
  "type": "example",
  "name": "example",
  "databaseUrl": "example",
  "databaseName": "example",
  "databaseUser": "example",
  "databasePort": 96,
  "connected": true,
  "maxThreads": 96,
  "maxTimeout": 96,
  "jdbcUrl": "example",
  "properties": "example",
  "jdbcUrlOverride": "example"
}

{
  "status": 96,
  "message": "example",
  "errors": [
    {
      "entityId": "example",
      "field": "example",
      "message": "example"
    }
  ]
}

{
  "status": 96,
  "message": "example",
  "errors": [
    {
      "entityId": "example",
      "field": "example",
      "message": "example"
    }
  ]
}

Add

/api/v1/connections

Creates new connection

Request parameters

{
  "type": "example",
  "name": "example",
  "databaseUrl": "example",
  "databaseName": "example",
  "databaseUser": "example",
  "databasePassword": "example",
  "databasePort": 96,
  "maxThreads": 96,
  "maxTimeout": 96,
  "properties": "example",
  "jdbcUrlOverride": "example"
}

Responses

{
  "id": 96,
  "type": "example",
  "name": "example",
  "databaseUrl": "example",
  "databaseName": "example",
  "databaseUser": "example",
  "databasePort": 96,
  "connected": true,
  "maxThreads": 96,
  "maxTimeout": 96,
  "jdbcUrl": "example",
  "properties": "example",
  "jdbcUrlOverride": "example"
}

{
  "status": 96,
  "message": "example",
  "errors": [
    {
      "entityId": "example",
      "field": "example",
      "message": "example"
    }
  ]
}

{
  "status": 96,
  "message": "example",
  "errors": [
    {
      "entityId": "example",
      "field": "example",
      "message": "example"
    }
  ]
}

Update

/api/v1/connections/{id}

Updates existing connection details. An omitted optional field keeps its stored value: databasePassword, maxThreads, maxTimeout, properties and jdbcUrlOverride. An empty string clears properties or jdbcUrlOverride. Connector-specific configuration set in the UI, such as the REST token or the Tableau, Power BI and SharePoint authentication, is not part of this request and is kept as stored. When any of the five identity fields changes (databaseUrl, databasePort, databaseName, databaseUser, jdbcUrlOverride), databasePassword must be sent again; a connector whose secret lives in its configuration refuses a databaseUrl change here, because that secret can only be re-entered in the UI.

Request parameters

{
  "type": "example",
  "name": "example",
  "databaseUrl": "example",
  "databaseName": "example",
  "databaseUser": "example",
  "databasePassword": "example",
  "databasePort": 96,
  "maxThreads": 96,
  "maxTimeout": 96,
  "properties": "example",
  "jdbcUrlOverride": "example"
}

Responses

{
  "id": 96,
  "type": "example",
  "name": "example",
  "databaseUrl": "example",
  "databaseName": "example",
  "databaseUser": "example",
  "databasePort": 96,
  "connected": true,
  "maxThreads": 96,
  "maxTimeout": 96,
  "jdbcUrl": "example",
  "properties": "example",
  "jdbcUrlOverride": "example"
}

{
  "status": 96,
  "message": "example",
  "errors": [
    {
      "entityId": "example",
      "field": "example",
      "message": "example"
    }
  ]
}

{
  "status": 96,
  "message": "example",
  "errors": [
    {
      "entityId": "example",
      "field": "example",
      "message": "example"
    }
  ]
}

Delete

/api/v1/connections/{id}

Deletes existing connection by id

Request parameters

Responses

{
  "status": 96,
  "message": "example",
  "errors": [
    {
      "entityId": "example",
      "field": "example",
      "message": "example"
    }
  ]
}

{
  "status": 96,
  "message": "example",
  "errors": [
    {
      "entityId": "example",
      "field": "example",
      "message": "example"
    }
  ]
}

Get statuses

/api/v1/connections/status

Get connection info with status details

Responses

[
  {
    "connectionName": "example",
    "connectionType": "example",
    "connected": true,
    "connectionUrl": "example"
  }
]

{
  "status": 96,
  "message": "example",
  "errors": [
    {
      "entityId": "example",
      "field": "example",
      "message": "example"
    }
  ]
}

{
  "status": 96,
  "message": "example",
  "errors": [
    {
      "entityId": "example",
      "field": "example",
      "message": "example"
    }
  ]
}

File upload

/api/v1/connections/files

Uploads/overwrites a file in application file system

Request parameters

Responses

{
  "status": 96,
  "message": "example",
  "errors": [
    {
      "entityId": "example",
      "field": "example",
      "message": "example"
    }
  ]
}

{
  "status": 96,
  "message": "example",
  "errors": [
    {
      "entityId": "example",
      "field": "example",
      "message": "example"
    }
  ]
}

Example:

curl \
-H "Authorization: Bearer $SELECTZERO_API_KEY" \
-F "file=@/path/to/your/file.csv" \
-F "path=/destination/directory" \
"https://selectzero_url/api/v1/connections/files"

File delete

/api/v1/connections/files

Deletes a file from application file system

Request parameters

Responses

{
  "status": 96,
  "message": "example",
  "errors": [
    {
      "entityId": "example",
      "field": "example",
      "message": "example"
    }
  ]
}

{
  "status": 96,
  "message": "example",
  "errors": [
    {
      "entityId": "example",
      "field": "example",
      "message": "example"
    }
  ]
}

Example:

curl \
-H "Authorization: Bearer $SELECTZERO_API_KEY" \
-F "path=/destination/directory/my-file.csv" \
"https://selectzero_url/api/v1/connections/files"

09 October 2026