Connections

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"
  }
]

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"
}

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"
}

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"
}

Update

/api/v1/connections/{id}

Updates existing connection details

Request parameters

{
  "type": "example",
  "name": "example",
  "databaseUrl": "example",
  "databaseName": "example",
  "databaseUser": "example",
  "databasePassword": "example",
  "databasePort": 96,
  "maxThreads": 96,
  "maxTimeout": 96,
  "properties": "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"
}

Delete

/api/v1/connections/{id}

Deletes existing connection by id

Request parameters

Responses

Get statuses

/api/v1/connections/status

Get connection info with status details

Responses

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

File upload

/api/v1/connections/files

Uploads/overwrites a file in application file system

Request parameters

Responses

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

Example:

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

27 May 2025