🧩API

The agent's setup is adjustable using direct API invocations, facilitating interactive information retrieval and interaction.

Agent API can be reached at https://<<host_name>>:<<port_number>> host_name: Refers to the host where the agent is installed (or localhost if used locally). port_number: By default, the agent listens on port 8282, which can be updated as needed

Examples are demonstrated using localhost as the host name and the default port number 8282.

Certain operations necessitate a header token for transmission to the agent. This token aligns with the agent's license key and the platform it operates on.

// example
export TOKEN=<<datasentinel_token>> 
curl -k --header "api-token: $TOKEN" --request PUT   https://localhost:8282/api/agent/stop'

Management

Status

GET https://localhost:8282/api/agent/status

Show agent's status, version, and properties.

200: OK Status and attributes

Output example

{
    "version": "3.4.1",
    "server": "pg-sales-3127",
    "port": 8282,
    "last_upload": "",
    "collection-rate": "low",
    "remove_proxy_os_env": false,
    "tables-monitoring-limit": 1000,
    "query-monitoring-limit": 30000,
    "sql-max-size": 256000,
    "start_time": "2023-08-22 14:52:12",
    "proxy": {
        "host": "",
        "port": 0,
        "user": "",
        "password": ""
    },
    "upload_server": {
        "host": "51.15.237.231",
        "port": 443
    },
    "connections": {
        "connections": 1,
        "running": 1,
        "not running": 0
    }
}

500: Internal Server Error Internal error

400: Bad Request

Stop

PUT https://localhost:8282/api/agent/stop

Stop the agent.

Headers

Name	Type	Description
api-token*	String	Datasentinel license key

200: OK Status and attributes

{
"status": "Agent stopped"
}

500: Internal Server Error Internal error

401: Unauthorized

400: Bad Request

Port Number

PATCH https://localhost:8282/api/agent/port/{port}

Modify the port number that the agent listens on. The agent is stopped after the modification. Start it again to apply the new port configuration.

Path Parameters

Name	Type	Description
port*	Number	New port

Headers

Name	Type	Description
api-token*	String	Datasentinel license key

200: OK OK

{
"status": "Port changed successfully! The agent has been stopped. You need to restart it."
}

500: Internal Server Error Internal error

400: Bad Request

401: Unauthorized

Table Monitoring Limit

PATCH https://localhost:8282/api/agent/tables-monitoring-limit/{limit}

The agent monitors table and index activities when the connection's table count remains below the specified limit (default: 1000).

Refer to the Collection Level section for more details.

Path Parameters

Name	Type	Description
limit*	Number	Limit number

Headers

Name	Type	Description
api-token*	String	Datasentinel license key

200: OK OK

{
    "status": "Tables monitoring limit successfully changed."
}

500: Internal Server Error Internal error

400: Bad Request

401: Unauthorized

Query Monitoring Limit

PATCH https://localhost:8282/api/agent/query-monitoring-limit/{limit}

The agent monitors query activity by storing unique IDs in a daily cache. If the limit is exceeded, this automatically deactivates query monitoring (default: 30000).

Refer to the Collection Level section for more details.

Path Parameters

Name	Type	Description
limit*	Number	Limit number

Headers

Name	Type	Description
api-token*	String	Datasentinel license key

200: OK OK

{
    "status": "Query monitoring limit successfully changed."
}

500: Internal Server Error Internal error

400: Bad Request

401: Unauthorized

Upload Server

The Upload Server refers to the server name of the platform where metrics are transmitted.

Set attributes

PUT https://localhost:8282/api/server

This is the server where metrics are sent

Headers

Name	Type	Description
api-token*	String	Datasentinel license key

Request Body

Name	Type	Description
host*	String	Server Name of the hosting platform
port*	Number	Platform Listening Port. By default, the platform operates on port 443.

200: OK OK

{
    "status": "OK"
}

500: Internal Server Error Internal error

400: Bad Request

401: Unauthorized

// Example
cat > body.json << EOF
{
  "host": "demo.datasentinel.io",
  "port": 443
}
EOF

export TOKEN=<<datasentinel_token>>
curl -k --header "api-token: $TOKEN" --header 'Content-Type: application/json' -X PUT https://localhost:8282/api/server -d @body.json

Show attributes

GET https://localhost:8282/api/server

Show server name and port details for the platform where metrics are sent.

200: OK Status and attributes

Output example

{
    "host": "demo.datasentinel.io",
    "port": 443
}

500: Internal Server Error Internal error

Test Upload

POST https://localhost:8282/api/server/test-upload

The agent conducts a test to confirm whether the upload server, configured with the specified port, is accessible.

500: Internal Server Error Internal error

201: Created In case of an error, the corresponding message will be shown in the response.

{
    "status": "OK"
}

Proxy

Under certain circumstances, an intermediary proxy server is required to establish a connection between the agent and the platform server.

Set attributes

POST https://localhost:8282/api/proxy

The following details pertain to the proxy server. Username and password are optional and can be excluded if not required.

Headers

Name	Type	Description
api-token*	String	Datasentinel license key

Request Body

Name	Type	Description
host*	String	Server Name of the hosting platform
port*	Number	Platform Listening Port. By default, the platform operates on port 443.
user	String	User name
password	String	Password

500: Internal Server Error Internal error

201: Created

{
"status": "Proxy set"
}

400: Bad Request

401: Unauthorized

// Example
cat > body.json << EOF
{
  "host": "proxy-server",
  "port": 12443,
  "user": "",
  "password": ""
}
EOF

export TOKEN=<<datasentinel_token>>
curl -k --header "api-token: $TOKEN" --header 'Content-Type: application/json' -X POST https://localhost:8282/api/proxy -d @body.json

Show attributes

GET https://localhost:8282/api/proxy

Proxy attributes

Headers

Name	Type	Description
api-token*	String	Datasentinel license key

200: OK Status and attributes

Output example

{
    "host": "proxy-server",
    "port": 45215,
    "user": "",
    "password": ""
}

500: Internal Server Error Internal error

400: Bad Request

401: Unauthorized

DELETE https://localhost:8282/api/proxy

Delete proxy

Headers

Name	Type	Description
api-token*	String	Datasentinel License Key

500: Internal Server Error Internal error

200: OK

{
    "status": "OK"
}

401: Unauthorized

400: Bad Request

Connections

Show Connections

GET https://localhost:8282/api/connections

Display declared connections and their attributes

Headers

Name	Type	Description
api-token*	String	Datasentinel license key

200: OK Status and attributes

Output example

[
    {
        "name": ":9342",
        "host": "pg-sales-3127",
        "port": 9342,
        "user": "datasentinel",
        "password": "sentinel",
        "tags": "application=sales,environment=production,provider=amazon,datacenter=paris",
        "enabled": true,
        "connected": true,
        "collection-rate": "low",
        "samples": false,
        "lock-monitoring": true,
        "lock-monitoring-delay": 30,
        "table-monitoring": true,
        "query-monitoring": true,
        "query-monitoring-optimize": false,
        "query-monitoring-min-calls": 2,
        "query-monitoring-min-time": 1
    }
]

500: Internal Server Error Internal error

400: Bad Request

401: Unauthorized

Enable All

PATCH https://localhost:8282/api/connections/enable

Enable all connections and initiate connection attempts for each of them only if they are not already established.

Headers

Name	Type	Description
api-token*	String	Datasentinel license key

200: OK Status and attributes

Output example

{
    "status": "OK"
}

500: Internal Server Error Internal error

400: Bad Request

401: Unauthorized

Disable All

PATCH https://localhost:8282/api/connections/disable

Deactivate all connections and disconnect them.

Headers

Name	Type	Description
api-token*	String	Datasentinel license key

200: OK Status and attributes

Output example

{
    "status": "OK"
}

500: Internal Server Error Internal error

400: Bad Request

401: Unauthorized

Connection

Add Connection

POST https://localhost:8282/api/connections/{connection_name}

Create a new connection, establishing it, and Initiate monitoring

Path Parameters

Name	Type	Description
connection_name*	String	Connection Identifier

Headers

Name	Type	Description
api-token*	String	Datasentinel license key

Request Body

Name	Type	Description
host*	String	Hostname for connection
port*	Number	Indicate the port used for communication with the PostgreSQL cluster.
user*	String	PostgreSQL user used by Datasentinel for monitoring
password	String	User password
tags*	String	Tags linked with the instance. Tags should follow the format [key=value],.... Can be empty

500: Internal Server Error Internal error

201: Created

{
  "status": "Connection created and connected!"
}

400: Bad Request

401: Unauthorized

// Example
cat > body.json << EOF
{
    "host": "pg-sales-3127",
    "port": 9342,
    "user": "datasentinel",
    "password": "sentinel",
    "tags": "application=sales,environment=production,provider=amazon,datacenter=paris"
}
EOF

export TOKEN=<<datasentinel_token>>
curl -k --header "api-token: $TOKEN" --header 'Content-Type: application/json' --request POST 'https://localhost:8282/api/connections/sales_prod' -d @body.json

Show Connection

GET https://localhost:8282/api/connections/{connection_name}

Display Connection Attributes

Path Parameters

Name	Type	Description
connection_name*	String	Connection name

Headers

Name	Type	Description
api-token*	String	Datasentinel license key

200: OK Status and attributes

Output example

{
    "name": "sales-prod",
    "host": "pg-sales-3127",
    "port": 9342,
    "user": "datasentinel",
    "password": "sentinel",
    "tags": "application=sales,environment=production,provider=amazon,datacenter=paris",
    "enabled": true,
    "connected": true,
    "collection-rate": "low",
    "samples": false,
    "lock-monitoring": true,
    "lock-monitoring-delay": 30,
    "table-monitoring": true,
    "query-monitoring": true,
    "query-monitoring-optimize": false,
    "query-monitoring-min-calls": 2,
    "query-monitoring-min-time": 1
}

500: Internal Server Error Internal error

404: Not Found Connection name not found

401: Unauthorized

400: Bad Request

Update Connection

PUT https://localhost:8282/api/connections/{connection_name}

Update connection attributes

Path Parameters

Name	Type	Description
connection_name*	String	Connection Identifier

Headers

Name	Type	Description
api-token*	String	Datasentinel license key

Request Body

Name	Type	Description
host	String	Hostname for connection
port	Number	Indicate the port used for communication with the PostgreSQL cluster.
user	String	PostgreSQL user used by Datasentinel for monitoring
password	String	User password
tags	String	Tags linked with the instance. Tags should follow the format [key=value],.... Can be empty

500: Internal Server Error Internal error

400: Bad Request

401: Unauthorized

200: OK

{
  "status": "Connection updated!"
}

DELETE https://localhost:8282/api/connections/{connection_name}

Delete Connection

Path Parameters

Name	Type	Description
connection_name*	String	Connection name

Headers

Name	Type	Description
api-token*	String	Datasentinel license key

200: OK

{
  "status": "Connection deleted!"
}

500: Internal Server Error Internal error

404: Not Found Connection name not found

401: Unauthorized

400: Bad Request

Enable

PATCH https://localhost:8282/api/connections/{connection_name}/enable

Activate the connection and initiate connection attempts in order to start monitoring

Path Parameters

Name	Type	Description
connection_name*	String	Connection name

Headers

Name	Type	Description
api-token*	String	Datasentinel license key

200: OK Status and attributes

{
    "status": "Connection enabled!"
}

500: Internal Server Error Internal error

404: Not Found Connection name not found

401: Unauthorized

400: Bad Request

Disable

PATCH https://localhost:8282/api/connections/{connection_name}/disable

Disable the connection and perform a disconnection

Path Parameters

Name	Type	Description
connection_name*	String	Connection name

Headers

Name	Type	Description
api-token*	String	Datasentinel license key

200: OK Status and attributes

{
    "status": "Connection disabled!"
}

500: Internal Server Error Internal error

404: Not Found Connection name not found

401: Unauthorized

400: Bad Request

Collection Level

The Agent version 3.2, which was released in February 2023, introduces the Collection Level feature allowing you to choose the metrics to monitor.

🗃️pageCollection Level

Collection Level settings are displayed within the connection properties.

Query samples

Enable

PATCH https://localhost:8282/api/connections/{connection_name}/enable-samples

Activate query sample collection. Refer to the Collection Level section specifically dedicated to query samples for detailed instructions.

Path Parameters

Name	Type	Description
connection_name*	String	Connection name

Headers

Name	Type	Description
api-token*	String	Datasentinel license key

200: OK Status and attributes

{
  "status": "Query samples enabled!"
}

500: Internal Server Error Internal error

404: Not Found Connection name not found

401: Unauthorized

400: Bad Request

Disable

PATCH https://localhost:8282/api/connections/{connection_name}/disable-samples

Deactivate query sample collection. Refer to the Collection Level section specifically dedicated to query samples for detailed instructions.

Path Parameters

Name	Type	Description
connection_name*	String	Connection name

Headers

Name	Type	Description
api-token*	String	Datasentinel license key

200: OK Status and attributes

{
  "status": "Query samples disabled!"
}

500: Internal Server Error Internal error

404: Not Found Connection name not found

401: Unauthorized

400: Bad Request

Lock Monitoring

Enable

PATCH https://localhost:8282/api/connections/{connection_name}/enable-lock-monitoring

Enable Lock Monitoring. Refer to the Collection Level section specifically dedicated to lock monitoring for detailed instructions.

Path Parameters

Name	Type	Description
connection_name*	String	Connection name

Headers

Name	Type	Description
api-token*	String	Datasentinel license key

200: OK Status and attributes

{
  "status": "Lock monitoring enabled!"
}

500: Internal Server Error Internal error

404: Not Found Connection name not found

401: Unauthorized

400: Bad Request

Disable

PATCH https://localhost:8282/api/connections/{connection_name}/disable-lock-monitoring

Disable Lock Monitoring Refer to the Collection Level section specifically dedicated to lock monitoring for detailed instructions.

Path Parameters

Name	Type	Description
connection_name*	String	Connection name

Headers

Name	Type	Description
api-token*	String	Datasentinel license key

200: OK Status and attributes

{
  "status": "Lock monitoring disabled!"
}

500: Internal Server Error Internal error

404: Not Found Connection name not found

401: Unauthorized

400: Bad Request

Delay

PATCH https://localhost:8282/api/connections/{connection_name}/lock-monitoring-delay/{seconds}

Change Lock Monitoring Delay. Refer to the Collection Level section specifically dedicated to lock monitoring for detailed instructions.

Path Parameters

Name	Type	Description
connection_name*	String	Connection name
seconds*	Number	Number of seconds

Headers

Name	Type	Description
api-token*	String	Datasentinel license key

200: OK Status and attributes

Output example

{
  "status": "Lock monitoring delay updated to value 90s"
}

500: Internal Server Error Internal error

404: Not Found Connection name not found

401: Unauthorized

400: Bad Request

Table Monitoring

Enable

PATCH https://localhost:8282/api/connections/{connection_name}/enable-table-monitoring

Activate Table Monitoring. Refer to the Collection Level section specifically dedicated to table monitoring for detailed instructions.

Path Parameters

Name	Type	Description
connection_name*	String	Connection name

Headers

Name	Type	Description
api-token*	String	Datasentinel license key

200: OK Status and attributes

{
    "status": "Table monitoring enabled!"
}

500: Internal Server Error Internal error

404: Not Found Connection name not found

401: Unauthorized

400: Bad Request

Disable

PATCH https://localhost:8282/api/connections/{connection_name}/disable-table-monitoring

Deactivate Table Monitoring. Refer to the Collection Level section specifically dedicated to table monitoring for detailed instructions.

Path Parameters

Name	Type	Description
connection_name*	String	Connection name

Headers

Name	Type	Description
api-token*	String	Datasentinel license key

200: OK Status and attributes

{
    "status": "Table monitoring disabled!"
}

500: Internal Server Error Internal error

404: Not Found Connection name not found

401: Unauthorized

400: Bad Request

Query Monitoring

Enable

PATCH https://localhost:8282/api/connections/{connection_name}/enable-query-monitoring

Activate Query Monitoring. Refer to the Collection Level section specifically dedicated to query monitoring for detailed instructions.

Path Parameters

Name	Type	Description
connection_name*	String	Connection name

Headers

Name	Type	Description
api-token*	String	Datasentinel license key

200: OK Status and attributes

{
    "status": "Query monitoring enabled!"
}

500: Internal Server Error Internal error

404: Not Found Connection name not found

401: Unauthorized

400: Bad Request

Disable

PATCH https://localhost:8282/api/connections/{connection_name}/disable-query-monitoring

Deactivate Query Monitoring. Refer to the Collection Level section specifically dedicated to query monitoring for detailed instructions.

Path Parameters

Name	Type	Description
connection_name*	String	Connection name

Headers

Name	Type	Description
api-token*	String	Datasentinel license key

200: OK Status and attributes

{
    "status": "Query monitoring disabled!"
}

500: Internal Server Error Internal error

404: Not Found Connection name not found

401: Unauthorized

400: Bad Request

Query Filters

Min Calls

PATCH https://localhost:8282/api/connections/{connection_name}/query-monitoring-min-calls/{min-calls}

Change the value of Min Calls Refer to the Collection Level section specifically dedicated to query monitoring filters for detailed instructions.

Path Parameters

Name	Type	Description
connection_name*	String	Connection name
min-calls	Number	Min calls

Headers

Name	Type	Description
api-token*	String	Datasentinel license key

200: OK Status and attributes

Example output

{
  "status": "Query monitoring min calls updated to value 50"
}

500: Internal Server Error Internal error

404: Not Found Connection name not found

401: Unauthorized

400: Bad Request

Min Time

PATCH https://localhost:8282/api/connections/{connection_name}/query-monitoring-min-time/{seconds}

Change the value of Min Time. Refer to the Collection Level section specifically dedicated to query monitoring filters for detailed instructions.

Path Parameters

Name	Type	Description
connection_name*	String	Connection name
seconds	Number	Min time

Headers

Name	Type	Description
api-token*	String	Datasentinel license key

200: OK Status and attributes

Example output

{
  "status": "Query monitoring min time updated to value 10s"
}

500: Internal Server Error Internal error

404: Not Found Connection name not found

401: Unauthorized

400: Bad Request

Query Optimize

Enable

PATCH https://localhost:8282/api/connections/{connection_name}/enable-query-monitoring-optimize

Activate Query Monitoring Optimization. Refer to the Collection Level section specifically dedicated to query monitoring optimization for detailed instructions.

Path Parameters

Name	Type	Description
connection_name*	String	Connection name

Headers

Name	Type	Description
api-token*	String	Datasentinel license key

200: OK Status and attributes

{
    "status": "Query monitoring optimize enabled!"
}

500: Internal Server Error Internal error

404: Not Found Connection name not found

401: Unauthorized

400: Bad Request

Disable

PATCH https://localhost:8282/api/connections/{connection_name}/disable-query-monitoring-optimize

Deactivate Query Monitoring Optimization. Refer to the Collection Level section specifically dedicated to query monitoring optimization for detailed instructions.

Path Parameters

Name	Type	Description
connection_name*	String	Connection name

Headers

Name	Type	Description
api-token*	String	Datasentinel license key

200: OK Status and attributes

{
    "status": "Query monitoring optimize disabled!"
}

500: Internal Server Error Internal error

404: Not Found Connection name not found

401: Unauthorized

400: Bad Request