Skip to main content

Connection & Status

Inspect a datasource's status and connection settings, test connectivity, and update the connection.

GET /api/datasources/{id}/status​

Get the driver-reported status (health/availability) of a datasource.

Path Parameters:

ParameterTypeDescription
idstringDatasource ID
Get datasource statusGET /api/datasources/admin:northwind/status
Driver-reported health/availability of the datasource.
Response · 200
{
  "_links": {
    "self": {
      "href": "https://informer.example.com/api/datasources/admin%3Anorthwind/status"
    }
  },
  "status": "online"
}
Captured from the API examples test suite; ids and timestamps are normalized.

GET /api/datasources/{id}/connection​

Get the driver-specific connection settings.

Response:

The connection config. The password is returned encrypted (encrypted:iv:...), never as plaintext.

Get the connection configGET /api/datasources/admin:northwind/connection
The driver-specific connection settings. The password is returned encrypted (encrypted:iv:...).
Response · 200
{
  "_links": {
    "self": {
      "href": "https://informer.example.com/api/datasources/admin%3Anorthwind/connection"
    }
  },
  "host": "localhost",
  "pool": {
    "max": 5,
    "min": 0,
    "idle": 10000,
    "acquire": 10000
  },
  "port": 5432,
  "user": "northwinduser",
  "database": "northwind",
  "password": "encrypted:iv:0000000000000000",
  "idleTimeoutMillis": 7
}
Captured from the API examples test suite; ids and timestamps are normalized.

POST /api/datasources/{id}/_ping​

Test connectivity using the stored connection.

Path Parameters:

ParameterTypeDescription
idstringDatasource ID

Request Body:

Optional. An options object to test alternative connection settings instead of the stored ones; send {} to test the stored connection.

Ping a datasourcePOST /api/datasources/admin:northwind/_ping
Tests connectivity using the stored connection. Accepts an optional options object to test alternative settings.
Request body
{}
Response · 200
true
Captured from the API examples test suite; ids and timestamps are normalized.

PUT /api/datasources/{id}/connection​

Replace the connection settings.

Permissions: datasource:write

Request Body:

The driver-specific connection object. The password is stored encrypted.

Update the connection configPUT /api/datasources/admin:northwind/connection
Replaces the connection settings. The password is stored encrypted. Shape is driver-specific.
Request body
{
  "host": "db.example.com",
  "port": 5432,
  "database": "northwind",
  "user": "reporting",
  "password": "secretPassword"
}
Response · 200
{
  "_links": {
    "self": {
      "href": "https://informer.example.com/api/datasources/admin%3Anorthwind/connection"
    }
  },
  "host": "db.example.com",
  "port": 5432,
  "database": "northwind",
  "user": "reporting",
  "password": "encrypted:iv:0000000000000000",
  "ssl": {
    "enabled": false,
    "rejectUnauthorized": false
  }
}
Captured from the API examples test suite; ids and timestamps are normalized.

POST /api/datasources/{id}/connection/_reset​

Purge the driver's pooled connections for this datasource. Only valid for drivers that pool connections (returns 400 otherwise). Responds 200 with no body on success.