Database Operations in Apidog

Getting Started#

1

Add Database Processor

Navigate to the Pre Processors or Post Processors section of your request and select Database Operation.

Design-first Mode

Request-first Mode

2

Configure Operation

Name the operation and select a Database Connection.

3

Enter SQL Command

Input your SQL query. You can use variables like {{variable}} within the query.

4

Extract Results (Optional)

Enable Extract Result To Variable to save query results.

Variable Name: Name of the variable.

JSONPath Expression: Use $[0].uid to get the uid from the first row.

5

Execute

Click Send. Results are displayed in the Console.

Database Connections#

Supported Databases#

Setting Up a Connection#

1

Go to Settings > Database Connections.

2

Click + New at the top right.

3

Select the database type and enter connection details (Host, Port, Username, Password, Database Name).

4

(Optional) Configure SSH Tunnel for secure connections.

5

Click Save.

Multi-Environment Configuration#

Database Access in Scripts#

CLI Support#