sql databases

Run SQL against a SQL database

Changed on

Runs SQL against the database and returns the resulting rows — empty for statements that return none, such as DDL. Bind positional ? placeholders with params rather than interpolating values into the SQL string.

post/storage/sqldbs/{id}/actions/query

Request

  • Base URL
    https://api.telnyx.com/v2
  • URL
    https://api.telnyx.com/v2/storage/sqldbs/{id}/actions/query
  • Auth
    HTTP bearer

Path parameters

idstring uuid required

SQL database ID

Request body

sqlstring required

The SQL to run. Use positional ? placeholders and supply the values in params rather than interpolating them into this string.

Example request

{
  "sql": "SELECT * FROM users WHERE name = ?",
  "params": [
    "alice"
  ]
}

Response

The SQL result

Example response

{
  "data": {
    "success": true,
    "count": 1,
    "duration": 2.5,
    "meta": {
      "duration": 1.2,
      "rows_read": 3
    }
  }
}

Changes

  • 67df31283a8aRevision changes
    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • a72569d69430Revision changes
    • info

      endpoint added